Change instance state
Changes the lifecycle state of an instance. Used to start, pause, resume, or stop bot sessions. The operation blocks until the state transition is complete.
Changes the lifecycle state of an instance. Used to start, pause, resume, or stop bot sessions. The operation blocks until the state transition is complete.
AuthorizationBearer <token>
Preferred API authentication. Use a JWT with the api audience.
In: header
Path Parameters
id*string
The unique identifier (UUID) of the instance.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
state*
The target state for the instance. Valid transitions:
- STOPPED -> RUNNING: Starts the instance
- RUNNING -> PAUSED: Pauses bot ticking
- PAUSED -> RUNNING: Resumes bot ticking
- RUNNING/PAUSED -> STOPPED: Stops the instance The server will handle intermediate states (STARTING, STOPPING) automatically.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "http://127.0.0.1:38765/v1/instances/p0:changeState" \ -H "Content-Type: application/json" \ -d '{ "state": {} }'{}{ "code": 0, "grpc-code": "string", "message": "string", "stack-trace": "string", "details": [ {} ]}{ "code": 0, "grpc-code": "string", "message": "string", "stack-trace": "string", "details": [ {} ]}{ "code": 0, "grpc-code": "string", "message": "string", "stack-trace": "string", "details": [ {} ]}How is this page?