Configuring and deploying an API
Configuring Cloud Endpoints
Describes the configuration files needed to create a gRPC service that is managed by Endpoints.
Deploying the Endpoints configuration
Shows how to deploy a service configuration to Endpoints.
Deploying the API backend
Explains how to deploy your API's backend code and the Google Cloud Enterprise Search Platform(Enterprise Search Platform).
Running Enterprise Search Platform locally or on another platform
Explains how to configure and run the Enterprise Search Platform on a local machine or on another cloud provider.
Transcoding HTTP/JSON to gRPC
Shows how to map HTTP/JSON requests and their parameters to gRPC methods and their parameters and return types.
Comparing configuration files
Describes the Deployment history tab on the Endpoints Services page in the Google Cloud console, and how to compare a deployed service configuration with the previous version.
Getting the service name and configuration ID
Describes how to get the name and configuration ID of a managed service.
Provides general troubleshooting information and provides links to other pages for additional information.
Troubleshooting Endpoints configuration deployment
Describes some errors that you might encounter when you deploy your Endpoints configuration and how to troubleshoot them.
Troubleshooting response errors
Describes how to troubleshoot errors that you receive in a response from a request to your API.
Troubleshooting Endpoints on Compute Engine
Provides troubleshooting techniques for Endpoints deployments on Compute Engine.
Troubleshooting GKE deployment
Provides troubleshooting techniques for Endpoints deployments on GKE.
Troubleshooting JWT validation
Provides troubleshooting information if the JWT validation fails and an error is returned in the response to the client.
Monitoring your API
Shows how to view API metrics and API logs in the Google Cloud console.
Tracing your API
Explains the trace sampling rate, how to estimate your cost for Cloud Trace, how to view the traces in the Google Cloud console, and how to disable trace sampling.
Cloud Endpoints Portal
Endpoints Portal overview
Provides an overview of the Endpoints Portal, and includes a link to the Endpoints Portal demo website.
Getting started using the Endpoints Portal
Describes how to create a Endpoints Portal and introduces you to the Endpoints Portal user interface.
Describes the SmartDocs API reference documentation, how SmartDocs uses the parts of your
.protoand service configuration files to generate API documentation, and how to regenerate SmartDocs.
Trying out the API
Describes how to configure your portal so that users can try out your API.
Syncing custom documentation through an API
Describes how to use an API to sync custom documentation to your portal.
Setting up a custom domain
Describes how to setup the Endpoints Portal to use a custom domain.
DNS and SSL
Verifying a domain name
Shows how to verify ownership of a domain name serving a Endpoints API.
Serving an API from your domain name
Shows how to set up your project to serve API requests.
Configuring DNS on the cloud.goog domain
Shows how to configure DNS for Endpoints services that use the cloud.goog domain, which Google owns and manages.
Serving multiple APIs from a domain
Shows how to run multiple independent APIs on your own domain.
Enabling SSL with Enterprise Search Platform
Shows how to enable an SSL port for your deployed Endpoints service using Enterprise Search Platform.
Enabling SSL with ESPv2
Shows how to enable an SSL port for your deployed Endpoints service using ESPv2.
Authentication and API keys
Choosing an authentication method
Provides an overview and sample use cases for each supported authentication method.
Why and when to use API keys
Provides background information on API keys and authentication, and the scenarios where you should consider using API keys.
Shows how to configure authentication for a gRPC API.
Authentication between services
Shows how to use service-to-service authentication in a gRPC service.
Restricting API access with API keys
Shows how to restrict API access to those clients that have an API key.
Managing API access
Overview of API access
Describes the API access control options available to you in Endpoints.
Controlling who can enable your API
Shows how to control who can enable your API in their own Google Cloud projects.
Enabling an API in your Google Cloud project
Shows how to enable an API in a Google Cloud project.
Granting and revoking access to the API
Shows how grant different levels of access so other team members can help manage the API.
API lifecycle management
Planning your Google Cloud projects
Provides recommendations for naming conventions of the Google Cloud projects that you may need to create in addition to the Google Cloud project for your production backend.
Deleting an API and instances
Shows how to delete an API and shutdown instances running the API to avoid unnecessary costs.
Restoring a managed service
Shows how to restore a managed service in case of accidental deletion.
Limiting API requests (beta)
Customizing Enterprise Search Platform
Using a custom
nginx.confon Google Kubernetes Engine
Describes how to create a custom
nginx.conffile for deploying Enterprise Search Platform to GKE.
Creating a custom
nginx.confto support CORS
Shows examples of how the Enterprise Search Platform CORS options are written to
nginx.confas a starting point in case you need to customize the CORS support in Enterprise Search Platform.