Method: projects.locations.apps.guardrails.delete

Deletes the specified guardrail.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the guardrail to delete.

Query parameters

Parameters
force

boolean

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

  • If force = false, the deletion fails if any apps/agents still reference the guardrail.
  • If force = true, all existing references from apps/agents will be removed and the guardrail will be deleted.
etag

string

Optional. The current etag of the guardrail. 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 guardrail, 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.guardrails.delete

For more information, see the IAM documentation.