Sign in
assistants

get/v1/assistants/{id}/operational/status/

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid
    • API key in header X-Session-Token
    • API key in header Authorization

Path parameters

idstring required

Headers

Vellum-Organization-Idstring uuid

Required if using Cookie-based or X-Session-Token authentication methods.

Response

state'initializing' | 'migrating' | 'provisioning' | 'active' | 'sleeping' | 'waking' | 'restarting' | 'restoring_backup' | 'upgrading_assistant_version' | 'resizing_machine' | 'resizing_storage' | 'maintenance_mode' | 'crash_loop' | 'unreachable' | 'not_found' | 'retiring' required
  • initializing - initializing
  • migrating - migrating
  • provisioning - provisioning
  • active - active
  • sleeping - sleeping
  • waking - waking
  • restarting - restarting
  • restoring_backup - restoring_backup
  • upgrading_assistant_version - upgrading_assistant_version
  • resizing_machine - resizing_machine
  • resizing_storage - resizing_storage
  • maintenance_mode - maintenance_mode
  • crash_loop - crash_loop
  • unreachable - unreachable
  • not_found - not_found
  • retiring - retiring
detail_statestring required
poll_after_msinteger required
updated_atstring date-time required
state_started_atstring date-time nullable required
storageobject nullable required

Changes

No recorded changes to this operation across all 50 revisions of this API.