AMamika
Sandboxes

List the org's sandboxes

Changed on
get/api/v0beta1/sandboxes

Request

  • Base URL
    https://app.amika.dev (the document declares no server; this is the origin it was published from)
  • URL
    https://app.amika.dev/api/v0beta1/sandboxes
  • Auth
    • HTTP bearer
    • or API key in cookie wos-session

Query parameters

host_idstring

If set, only return rigs on this one of the organization's own hosts.

live_state'true' | 'false'

Set to false to skip reading each active rig's live state from its provider. Statuses are then derived from stored state, and rows whose status is unconfirmed carry live_state_pending: true.

Response

Sandboxes.

idstring required
user_idstring nullable required
org_idstring required
namestring required
providerstring nullable required
provider_sandbox_idstring nullable required
amika_opencode_webstring nullable required
repo_namestring nullable required
repo_providerstring nullable required
repo_idstring nullable required
repo_urlstring nullable required
branchstring nullable required
commit_hashstring nullable required
snapshotstring nullable required
snapshot_namestring nullable
sandbox_presetstring nullable
sandbox_sizestring nullable
github_auth_mode'pat' | 'app_token' | 'null' nullable
github_credential_provisionedboolean nullable
error_messagestring nullable
current_session_idstring nullable required
statestring
status'creating' | 'starting' | 'running' | 'stopping' | 'stopped' | 'suspending' | 'suspended' | 'snapshotting' | 'failed' | 'unknown'
setup_status'ok' | 'setup-running' | 'git-failed' | 'setup-failed' | 'sys-setup-failed' | 'null' nullable
live_state_pendingboolean
secret_namesstring[]
agent_cwdstring nullable
ssh_key_status'ready' | 'no-key' | 'stale-keys' | 'unknown'
originstring nullable
host_idstring nullable

Changes

  • 86f031a957c1Revision changes
    • info

      added the new optional query request parameter live_state

    • info

      added the optional property / to the response with the status

  • a122301d00e0Revision changes
    • warning

      removed the optional property / from the response with the status

    • warning

      added the new stopped enum value to the / response property for the response status