Agent Versions
Delete an agent version
Deletes a specific version of an agent. For hosted agents, if the version has active
sessions, the request is rejected with HTTP 409 unless force is set to true. When
force is true, all sessions associated with this version are cascade-deleted.
Path parameters
agent_name
string
required
The name of the agent to delete.
agent_version
string
required
The version of the agent to delete
Query parameters
force
boolean
For Hosted Agents, if true, force-deletes the version even if it has active sessions, cascading deletion to all associated sessions. The service defaults to false if a value is not specified by the caller. This value is not relevant for other Agent types.
api-version
string
required
The API version to use for this operation.
Responses
The request has succeeded.
Body
object
enum
required
The object type. Always 'agent.version.deleted'.
name
string
required
The name of the agent.
version
string
required
The version identifier of the agent.
deleted
boolean
required
Whether the agent was successfully deleted.
Request
DELETE /agents/{agent_name}/versions/{agent_version} HTTP/1.1Response
Status: 200
Content-Type: application/jsonStatus: 4XX
Content-Type: application/jsonStatus: 5XX
Content-Type: application/json