AMamika
Sandboxes

Read a sandbox by id or name

Changed on
get/api/v0beta1/rigs/{id}

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/rigs/{id}
  • Auth
    • HTTP bearer
    • or API key in cookie wos-session

Path parameters

idstring required

Query parameters

by'name' | 'id' | 'ref' | 'name_or_id'

How to interpret the sandbox {id} path param: ref/name_or_id (default; matches an id or a name and rejects an ambiguous match with 409 resource_ref_ambiguous), name, or id.

Response

Sandbox with its guest DNS hostname.

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
hostnamestring required

Changes

  • 86f031a957c1Revision changes
    • info

      added the optional property //// to the response with the status

  • c46868fd7b41Revision changes
    • info

      added the new optional query request parameter by

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status