Deleting an API proxy

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

More Information
For more information, see:

• Best practices for API proxy design and development

When you delete an API proxy, Apigee removes that API proxy and undeploys it from the cluster.

Deleting an API proxy is similar to undeploying an API proxy, except that you can return to edit the revision that you undeploy. If you delete the API proxy, it is no longer available to edit.

Classic Apigee UI

To delete an API proxy in the Apigee UI:

1. If you are using the Apigee UI in Cloud console: Select Proxy development > API Proxies.

   If you are using the classic Apigee UI: Select Develop > API Proxies and in the Proxies pane, select the environment for the proxy.

2. In the row for the proxy you want to delete, under Actions, click the trash can icon.
3. In the confirmation dialog, click Delete.

Note: Deleting the API proxy does not trigger a rollback to a previous revision of the proxy.

For information on how to check the status of the newly deleted proxy, see Viewing deployment status.

Apigee API

Delete an API proxy in your Apigee organization by issuing a DELETE request to the following resource:

https://apigee.googleapis.com/v1/organizations/$ORG/apis/$API

Note: An API proxy must be undeployed before you can delete it.

For example, to delete the helloworld API proxy:

curl "https://apigee.googleapis.com/v1/organizations/myorg/apis/helloworld" \
  -X DELETE \
  -H "Authorization: Bearer $TOKEN"

Where $TOKEN is set to your OAuth 2.0 access token, as described in Obtaining an OAuth 2.0 access token. For information about the curl options used in this example, see Using curl. For a description of the environment variables used, see Setting environment variables for Apigee API requests.

The following provides an example of the response output:

{
  "metaData": {
    "createdAt": "1559145292799",
    "lastModifiedAt": "1559145292799",
    "subType": "Proxy"
  },
  "name": "helloworld",
  "revision": [
    "1"
  ]
}

For more information, see the API proxies API.

Send feedback