Removing API Management

If you have added API management to your application, and subsequently you decide that you do not want the API management features, you can configure Endpoints Frameworks to stop managing your API.

Removing API management doesn't stop your API from being served. If you want to stop serving your API, you can either disable the application on the App Engine Settings page in the Google Cloud Platform (GCP) Console, or you can delete the GCP project. See Disabling an application and Shutting down a project for more information.

To remove API management:

  1. Backup your API project's app.yaml file.

  2. Make sure that Cloud SDK (gcloud) is authorized to access your data and services on GCP:

    gcloud auth login
    
  3. Enter the following to display the project IDs for your GCP projects:

    gcloud projects list
    
  4. Using the applicable project ID from the previous step, set the default GCP project to the one that your application is in:

    gcloud config set project [YOUR_PROJECT_ID]
    
  5. Change to the directory where your app.yaml file is located, and open it.

  6. In the env_variables section, delete the lines containing the ENDPOINTS_SERVICE_NAME and ENDPOINTS_SERVICE_VERSION environment variables. If you do not have any other environment variables defined, delete the env_variables line.

  7. Save app.yaml.

  8. Deploy your application with the updated app.yaml:

    gcloud app deploy
    

After you redeploy your application, Endpoints Frameworks stops managing your API.

Verifying API management removal

To verify that Endpoints Frameworks is no longer managing your API:

  1. Go to the Endpoints Services page in the GCP Console.

    Go to the Endpoints Services page

  2. Write down the number of requests to one of the methods in your API.

  3. Click the View logs link for the method.

  4. In the Produced API log, write down the date and time of the most recent log entry.

  5. Send some requests to the method in your API.

  6. Go to the Endpoints Services page in the GCP Console.

    Go to the Endpoints Services page

    The request counter for the method is not updated.

  7. Click the View logs link for the method.

    The Produced API log does not contain log entries for the requests that you sent.

Deleting the managed service

Endpoints Frameworks uses Google's Service Management to manage your API. When you deployed the OpenAPI document using the gcloud endpoints services deploy command, the command used Service Management to create a managed service for your API. If you no do not need the data on the Endpoints Services page and in the Produced API log on the Logs Viewer page, you can delete the managed service for your API, which removes the data from the GCP Console.

To delete the managed service:

  1. Make sure that Cloud SDK (gcloud) is authorized to access your data and services on GCP:

    gcloud auth login
    
  2. Enter the following to display the project IDs for your GCP projects:

    gcloud projects list
    
  3. Using the applicable project ID from the previous step, set the default GCP project to the one that your application is in:

    gcloud config set project [YOUR_PROJECT_ID]
    
  4. Obtain the name of all managed services in your GCP project:

    gcloud endpoints services list
    
  5. Delete the service from Service Management:

    gcloud endpoints services delete [SERVICE_NAME]
    

    Running gcloud endpoints services delete doesn't immediately delete the managed service. Service Management disables the managed service for 30 days, which allows you time to restore it if you need to. After 30 days, Service Management permanently deletes the managed service.

Learn more

Was this page helpful? Let us know how we did:

Send feedback about...

Cloud Endpoints Frameworks for App Engine
Need help? Visit our support page.