Sign in

v1

latestOpenAPI 3.1.02026-07-22106199311.5 KB
Agents

Update an Agent

This request can be used to update Hybrid Agents. The following fields can be updated:

  • name - The name of the Agent.
  • description - The description for the agent.
  • enableAutoUpdates - Enabling Automatic Updates for the Agent. Note, this cannot be set for Snowflake Agents.
  • restrictedAccess - Set to true and use in conjunction with the Allow list if you wish to restrict the use of the agent to specified Environments and Projects.
  • trackName - The version track name for the Agent (CURRENT or STABLE). Note, Snowflake agents cannot be updated.

Please note, all the above fields are optional

patch/v1/agents/{agentId}

Path parameters

agentIdstring required

The ID of the agent to update

Request body

descriptionstring

The updated description to be applied to the Agent

enableAutoUpdatesstring

Set whether the Agent should automatically update.

Note, Snowflake agents cannot have this value changed.

namestring

The updated name to be applied to the Agent

restrictedAccessstring

Set whether the Agent should be restricted to a specific set of projects. If set to true, the Agent will only be applicable to projects it is scoped to have access to.

Note, this cannot be set for Streaming Agents.

trackName'CURRENT' | 'STABLE'

The version track name to set for the Agent. Must be either CURRENT or STABLE.

Note, Snowflake agents cannot be updated.

Example request

{
  "description": "An AWS Agent",
  "enableAutoUpdates": "true",
  "name": "AWS Agent",
  "restrictedAccess": "true",
  "trackName": "CURRENT"
}

Response

Agent successfully updated