Removing API management

If you added API management to your application on Google Cloud, and subsequently decide that you don't want the API management features, you can configure Cloud 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 console, or you can delete the Google Cloud 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 the Google Cloud CLI (gcloud) is authorized to access your data and services on Google Cloud:

    gcloud auth login
    
  3. Display the project IDs for your Google Cloud projects:

    gcloud projects list
    
  4. Using the applicable project ID from the previous step, set the default Google Cloud 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 don't have any other environment variables defined, delete the env_variables section.

  7. Save the app.yaml file.

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

    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. In the Google Cloud console, go to the Endpoints > Services page.

    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. In the Google Cloud console, go to the Endpoints > Services page.

    Go to the Endpoints Services page

    The request counter for the method isn't updated.

  7. Click the View logs link for the method.

    The Produced API log doesn't 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 by using the gcloud endpoints services deploy command, the command used Service Management to create a managed service for your API. If you don't 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 Google Cloud console.

To delete the managed service:

  1. Make sure that the gcloud CLI (gcloud) is authorized to access your data and services on Google Cloud:

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

    gcloud projects list
    
  3. Using the applicable project ID from the previous step, set the default Google Cloud 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 Google Cloud project:

    gcloud endpoints services list
    
  5. Delete the service from Service Management. Replace SERVICE_NAME with the name of the service you want to remove.

    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.

What's next