Stop a running computer asset | Athena

Stop (suspend) a running computer’s runtime — the same operation as the Stop button in Athena. The computer’s files persist and it can be started again with start_computer. Returns 409 when the provider does not support lifecycle operations or when the stop was refused because the workspace could not be saved (the computer is left running; retry).

Authentication

X-API-KEYstring

API Key authentication via header

Path parameters

asset_idstringRequired

Response

Successful Response

asset_idstring

The computer asset id.

statestring

Runtime state after the operation: started, stopped, a transitional state such as restoring, or pending when the transition was durably queued.

providerstring or nullOptional

The computer’s runtime provider (e.g. talos_v2).

Errors

401

Unauthorized Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

502

Bad Gateway Error