Method: projects.locations.collections.engines.assistants.agents.suspendAgent

Suspends an Agent. It is still available for viewing but not for use. The state of the Agent becomes SUSPENDED. Can be called on an Agent in the state ENABLED, otherwise it returns an error.

HTTP request

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/engines/*/assistants/*/agents/*}:suspendAgent

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the Agent to suspend. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{agent}

Query parameters

Parameters
suspensionReason

string

Required. The reason for suspending the Agent. This will be shown to the users of the Agent.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.