Method: organizations.apis.keyvaluemaps.entries.delete

Deletes a key value entry from a key value map scoped to an organization, environment, or API proxy.

Notes:

  • After you delete the key value entry, the policy consuming the entry will continue to function with its cached values for a few minutes. This is expected behavior.
  • Supported for Apigee hybrid 1.8.x and higher.

HTTP request

DELETE https://apigee.googleapis.com/v1/{name=organizations/*/apis/*/keyvaluemaps/*/entries/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Scope as indicated by the URI in which to delete the key value map entry. Use one of the following structures in your request:

  • organizations/{organization}/apis/{api}/keyvaluemaps/{keyvaluemap}/entries/{entry}.
  • organizations/{organization}/environments/{environment}/keyvaluemaps/{keyvaluemap}/entries/{entry}
  • organizations/{organization}/keyvaluemaps/{keyvaluemap}/entries/{entry}.

If the KeyValueMap is under an API Proxy resource that has the space attribute set, IAM permissions are checked against the Space resource path. To learn more, read the Apigee Spaces Overview.

Authorization requires the following IAM permission on the specified resource name:

  • apigee.keyvaluemapentries.delete

Request body

The request body must be empty.

Response body

If successful, the response body contains an instance of KeyValueEntry.

Authorization scopes

Requires the following OAuth scope:

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