Method: projects.locations.apis.delete

Delete an API resource in the API hub. API can only be deleted if all underlying versions are deleted.

HTTP request

DELETE https://apihub.googleapis.com/v1/{name=projects/*/locations/*/apis/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the API resource to delete. Format: projects/{project}/locations/{location}/apis/{api}

Query parameters

Parameters
force

boolean

Optional. If set to true, any versions from this API will also be deleted. Otherwise, the request will only work if the API has no versions.

Request body

The request body must be empty.

Response body

If successful, the response body is empty.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

IAM Permissions

Requires the following IAM permission on the name resource:

  • apihub.apis.delete

For more information, see the IAM documentation.