Method: projects.locations.apps.agents.delete

Deletes the specified agent.

HTTP request

DELETE https://ces.googleapis.com/v1/{name=projects/*/locations/*/apps/*/agents/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the agent to delete.

Query parameters

Parameters
force

boolean

Optional. Indicates whether to forcefully delete the agent, even if it is still referenced by other app/agents/examples.

  • If force = false, the deletion fails if other agents/examples reference it.
  • If force = true, delete the agent and remove it from all referencing apps/agents/examples.
etag

string

Optional. The current etag of the agent. If an etag is not provided, the deletion will overwrite any concurrent changes. If an etag is provided and does not match the current etag of the agent, deletion will be blocked and an ABORTED error will be returned.

Request body

The request body must be empty.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • ces.agents.delete

For more information, see the IAM documentation.