Update an Agent's run state

put/bots/{agentId}/state
Internal-Use Only

Update an Agent's run state. This endpoint can only be used to start running an agent (from 'idle' to 'running'); it cannot be used to stop it (from 'running' to 'idle').

Request Samples

1

Response Samples

1running

Path Parameters

NameTypeRequiredDescription
agentId
string
true

The ID of the Agent

Query Parameters

NameTypeRequiredDescription
value
string
true

the desired run state. Currently, only "running" is accepted.

Responses

StatusMeaningDescription
202AcceptedThe requested agent has started running. Results will be applied to the catalog asynchronously.Schema
400Bad RequestBad request (the request is not well-formed).Schema
401UnauthorizedNot authenticated.Schema
403ForbiddenThe user does not have permission to complete this request.Schema
404Not FoundThe specified resource was not found.Schema
406Not AcceptableNot Acceptable. Include an Accept header with a supported value on the request.Schema
409ConflictA conflict has occurred.Schema
415Unsupported Media TypeUnsupported Media Type. Include a Content-Type header with a supported value in the request.Schema
500Internal Server ErrorThe Catalog service encountered an error.Schema