Sign in
Sandboxes

Read a sandbox by id or name

get/api/v0beta1/sandboxes/{id}

Path parameters

idstring required

Response

Sandbox.

idstring required
user_idstring nullable required
org_idstring required
namestring required
providerstring nullable required
provider_sandbox_idstring nullable required
provider_urlstring 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' | 'suspending' | 'suspended' | 'snapshotting' | 'failed' | 'unknown'
setup_status'ok' | 'setup-running' | 'git-failed' | 'setup-failed' | 'sys-setup-failed' | 'null' nullable
secret_namesstring[]
has_workflowboolean
originstring nullable

Changes

Changed in 2 of the 7 revisions of this API.3

  • b63d287ac4191See the full diff
    • ○

      added the optional property mounted_secrets to the response with the 200 status

      response-optional-property-added

  • 7356672619e12See the full diff
    • ○

      added the optional property github_auth_mode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property github_credential_provisioned to the response with the 200 status

      response-optional-property-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog