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

Disables an Agent. The state of the Agent becomes DISABLED. Can be called on an Agent in the state ENABLED orSUSPENDED, otherwise it returns an error.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The name of the Agent to disable. Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}/agents/{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.