This page provides general troubleshooting information and provides links to other pages for additional information.
Errors when deploying the Cloud Endpoints configuration
If you got an error message from the
gcloud endpoints services deploy
Troubleshooting Endpoints configuration deployment
for information on troubleshooting the error.
Errors when deploying your API backend
The deployment of your API and the Extensible Service Proxy (ESP) to a Google Cloud Platform (GCP) backend is platform dependent. See the following troubleshooting guides for more information:
When you send a request to your API and receive an error response, see Troubleshooting response errors for information on troubleshooting the error.
Checking required services
At a minimum, Endpoints and ESP require the following services:
- Service Management API (
- Service Control API (
- Google Cloud Endpoints (
- Stackdriver Logging (
But these services might also have dependencies.
With the exception of the services required to host your API on
GCP, after you create a GCP project and deploy
your Endpoints configuration by using the
services deploy command, all the services that Endpoints and
ESP require are enabled.
You can use the following procedure to get a list of the required services. See
gcloud reference for more information on the
To get a list of the required services:
Create a test project, replacing
PROJECT_IDwith a unique project ID. (Project IDs must start with a lowercase letter and can have lowercase ASCII letters, digits or hyphens. Project IDs must be between 6 and 30 characters.)
gcloud projects create PROJECT_ID
Set the default project to the one you just created.
gcloud config set project PROJECT_ID
Save a copy of the
openapi.yamlfile from the
getting-startedsample to your local machine.
openapi.yamlfile, and in the
hostfield, replace the text with the Endpoints service name, which should be in the following format.
In the directory where you saved the
openapi.yamlfile, deploy the Endpoints configuration.
gcloud endpoints services deploy openapi.yaml
Get a list of all the enabled services.
gcloud services list
After you copy the list of required services, delete the test project.
gcloud projects delete PROJECT_ID
Compare the list of enabled services from the test project to the ones that are enabled in your project.
Checking debug information
gcloud command-line tool with debug verbosity helps with
gcloud --verbosity=debug COMMAND
This command makes the
gcloud command-line tool print a verbose log of the
error. Depending on the command being run, the output can include request and
response information from the server.
Enabling a service
You can check whether a service is enabled using
gcloud services list
To display configuration for a particular service, use the following command:
gcloud endpoints services describe SERVICE_NAME
Proxy OAuth fails yet requests pass
Make sure there is a
security section that has your OAuth definition in your
OpenAPI document. An example specification file is available in the
Getting started sample on GitHub.