[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],[],[[["\u003cp\u003eThis documentation provides comprehensive guidance on configuring and deploying APIs using Cloud Endpoints, including preparing OpenAPI documents and deploying both the configuration and backend code.\u003c/p\u003e\n"],["\u003cp\u003eThe content covers deploying APIs on various platforms such as Kubernetes, local machines, and other cloud providers, along with instructions on comparing configuration files and obtaining service details.\u003c/p\u003e\n"],["\u003cp\u003eExtensive troubleshooting and monitoring sections are included, addressing issues with configuration deployment, response errors, and deployments on different environments, in addition to guiding how to use logs and metrics for API health.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation also details how to manage domain names, configure DNS, enable SSL, and set up authentication using methods like Firebase, Auth0, Google ID tokens, and custom providers, as well as using and managing API keys.\u003c/p\u003e\n"],["\u003cp\u003eFinally, it provides key information regarding API access management, API lifecycle management, request limiting through quotas, customizing the Extensible Service Proxy (ESP), and migrating to ESPv2, in addition to providing additional guides for other use cases such as using gRPC and the App Engine standard environment.\u003c/p\u003e\n"]]],[],null,["# How-to guides\n\nConfiguring and deploying an API\n--------------------------------\n\n- [### Configuring Cloud Endpoints\n Explains how to prepare your OpenAPI document for deployment to Endpoints.](/endpoints/docs/openapi/configure-endpoints)\n- [### Deploying the Endpoints configuration\n Describes how to deploy an OpenAPI document to Endpoints.](/endpoints/docs/openapi/deploy-endpoints-config)\n- [### Deploying the API backend\n Explains how to deploy your API's backend code and the Extensible Service Proxy\n (ESP).](/endpoints/docs/openapi/deploy-api-backend)\n- [### Deploying on Kubernetes\n Shows how to configure and deploy Endpoints on Kubernetes.](/endpoints/docs/openapi/kubernetes-concept)\n- [### Running ESP locally or on another platform\n Shows how to configure an instance of the ESP on a\n local machine or on another cloud provider.](/endpoints/docs/openapi/running-esp-localdev)\n- [### Comparing configuration files\n Describes the **Deployment history** tab on the\n **Endpoints** \\\u003e **Services** page\n in the Google Cloud console, and how to compare a deployed service configuration\n with the previous version.](/endpoints/docs/openapi/config-file-compare)\n- [### Getting the service name and configuration ID\nDescribes how to get the name and configuration ID of a managed service.](/endpoints/docs/openapi/get-service-name-config-id) \n\nTroubleshooting and monitoring\n------------------------------\n\n- [### Troubleshooting overview\n Provides general troubleshooting information and provides links to other\n pages for additional information.](/endpoints/docs/openapi/troubleshoot)\n- [### Troubleshooting Endpoints configuration deployment\n Describes some errors that you might encounter when you deploy your\n Endpoints configuration and how to troubleshoot them.](/endpoints/docs/openapi/troubleshoot-config-deployment)\n- [### Troubleshooting response errors\n Describes how to troubleshoot errors that you receive in a response from a\n request to your API.](/endpoints/docs/openapi/troubleshoot-response-errors)\n- [### Troubleshooting App Engine flexible environment deployment\n Provides troubleshooting techniques for Endpoints deployments\n in the App Engine flexible environment.](/endpoints/docs/openapi/troubleshoot-aeflex-deployment)\n- [### Troubleshooting Compute Engine deployment\n Provides troubleshooting techniques for Endpoints\n deployments on Compute Engine.](/endpoints/docs/openapi/troubleshoot-gce-deployment)\n- [### Troubleshooting GKE deployment\n Provides troubleshooting techniques for Endpoints deployments\n on GKE.](/endpoints/docs/openapi/troubleshoot-gke-deployment)\n- [### Troubleshooting JWT validation\n Provides troubleshooting information if JWT validation fails and an\n error is returned in the response to the client.](/endpoints/docs/openapi/troubleshoot-jwt)\n- [### Monitoring your API\n Describes how to monitor the health of APIs using the logs and metrics\n Endpoints maintains for you automatically.](/endpoints/docs/openapi/monitoring-your-api)\n- [### Tracing your API\n Explains the trace sampling rate, how to estimate your cost for\n Cloud Trace, how to view the traces in the Google Cloud console, and\nhow to disable trace sampling.](/endpoints/docs/openapi/tracing) \n\nDNS and SSL\n-----------\n\n- [### Verifying a domain name\n Shows how to verify ownership of a domain name serving an\n Endpoints API.](/endpoints/docs/openapi/verify-domain-name)\n- [### Serving an API from your domain name\n Shows how to set up your project to serve API requests.](/endpoints/docs/openapi/serving-apis-from-domains)\n- [### Configuring DNS on the cloud.goog domain\n Shows how to configure DNS for Endpoints services that use the\n cloud.goog domain, which Google owns and manages.](/endpoints/docs/openapi/cloud-goog-dns-configure)\n- [### Serving multiple APIs from a domain\n Shows how to run multiple independent APIs on your own domain.](/endpoints/docs/openapi/deploying-apis-subdomains)\n- [### Enabling SSL with ESP\n Shows how to enable an SSL port for your deployed Endpoints\n service using ESP.](/endpoints/docs/openapi/enabling-ssl)\n- [### Enabling SSL with ESPv2\n Shows how to enable an SSL port for your deployed Endpoints\nservice using ESPv2.](/endpoints/docs/openapi/enabling-ssl-espv2) \n\nAuthentication and API keys\n---------------------------\n\n- [### Choosing an authentication method\n Provides an overview and sample use cases for each supported authentication\n method.](/endpoints/docs/openapi/authentication-method)\n- [### Why and when to use API keys\n Provides background information on API keys and when to use them.](/endpoints/docs/openapi/when-why-api-key)\n- [### Using Firebase to authenticate users\n Shows how to configure your OpenAPI document so that ESP\n validates incoming requests from clients using Firebase to\n authenticate users.](/endpoints/docs/openapi/authenticating-users-firebase)\n- [### Using Auth0 to authenticate users\n Shows how to configure your OpenAPI document so that ESP\n validates incoming requests from clients using Auth0 to authenticate users.](/endpoints/docs/openapi/authenticating-users-auth0)\n- [### Using Google ID tokens to authenticate users\n Shows how to configure your OpenAPI document so that ESP\n validates incoming requests from clients using Google ID tokens to\n authenticate users.](/endpoints/docs/openapi/authenticating-users-google-id)\n- [### Using a custom method to authenticate users\n Shows how to configure your OpenAPI document so that ESP\n validates incoming requests from clients using a custom provider to\n authenticate users.](/endpoints/docs/openapi/authenticating-users-custom)\n- [### Authentication between services\n Shows how to authenticate service-to-service calls.](/endpoints/docs/openapi/service-account-authentication)\n- [### Restricting access with API keys\n Shows how to prevent unauthorized client applications and services from\naccessing your API.](/endpoints/docs/openapi/restricting-api-access-with-api-keys) \n\nManaging API access\n-------------------\n\n- [### Overview of API access\n Describes the API access control options available to you in\n Endpoints.](/endpoints/docs/openapi/api-access-overview)\n- [### Controlling who can enable your API\n Shows how to control who can enable your API in their own Google Cloud\n projects.](/endpoints/docs/openapi/control-api-callers)\n- [### Enabling an API in your Google Cloud project\n Shows how to enable an API in a Google Cloud project.](/endpoints/docs/openapi/enable-api)\n- [### Granting and revoking access to the API\n Shows how grant different levels of access so other team members can help\nmanage the API.](/endpoints/docs/openapi/control-api-access) \n\nAPI lifecycle management\n------------------------\n\n- [### API lifecycle management overview\n Describes the Endpoints API versioning features and provides\n best practices for versioning and staging your Endpoints API.](/endpoints/docs/openapi/lifecycle-management)\n- [### Deleting an API and instances\n Shows how to delete an API and shutdown instances running the API to avoid\n unnecessary costs.](/endpoints/docs/openapi/deleting-an-api-and-instances)\n- [### Restoring a managed service\nShows how to restore a managed service in case of accidental deletion.](/endpoints/docs/openapi/restore-managed-service) \n\nLimiting API requests (beta)\n----------------------------\n\n- [### About quotas\n Provides an overview of the key functionality provided by quotas.](/endpoints/docs/openapi/quotas-overview)\n- [### Configuring quotas\n Describes how to configure quotas for your API.](/endpoints/docs/openapi/quotas-configure)\n- [### Overriding the default quota limit\nDescribes how to set a different quota limit for a specific consumer project.](/endpoints/docs/openapi/quotas-override) \n\nCustomizing ESP\n---------------\n\n- [### Using a custom `nginx.conf` on Google Kubernetes Engine\n Describes how to create a custom `nginx.conf` file for deploying\n ESP to GKE.](/endpoints/docs/openapi/custom-nginx)\n- [### Creating a custom `nginx.conf` to support CORS\n Shows examples of how the ESP CORS options are written to\n `nginx.conf` as a starting point in case you need to customize\n the CORS support in ESP.](/endpoints/docs/openapi/custom-cors-nginx)\n\nOther Endpoints how-to guides\n-----------------------------\n\n- [Migrate to ESPv2](/endpoints/docs/openapi/migrate-to-esp-v2)\n\n- [Cloud Endpoints Frameworks for the App Engine standard environment how-to guides](/endpoints/docs/frameworks/how-to)\n\n- [Cloud Endpoints for gRPC how-to guides](/endpoints/docs/grpc/how-to)"]]
