Skip to main content

JSON output schemas

whzbox currently implements JSON rendering for create and list.

Commands​

CommandTop-level JSON type
whzbox create aws --jsonobject
whzbox list --jsonarray of objects

Sandbox object schema​

FieldTypeDescription
kindstringSandbox kind, currently aws.
slugstringWhizlabs provider slug, currently aws-sandbox.
credentialsobjectProgrammatic credentials.
consoleobjectBrowser console login details.
identityobjectVerified identity data, when available.
started_atstringSandbox start time as an RFC 3339 timestamp.
expires_atstringSandbox expiry time as an RFC 3339 timestamp.

credentials​

FieldTypeDescription
access_keystringAWS access key ID
secret_keystringAWS secret access key

console​

FieldTypeDescription
urlstringAWS console sign-in URL
usernamestringConsole username
passwordstringConsole password

identity​

FieldTypeDescription
accountstringAWS account ID
user_idstringAWS user ID
arnstringAWS ARN
regionstringAWS region

Example: create --json​

{
  "kind": "aws",
  "slug": "aws-sandbox",
  "credentials": {
    "access_key": "AKIAEXAMPLE",
    "secret_key": "secret"
  },
  "console": {
    "url": "https://111111111111.signin.aws.amazon.com/console",
    "username": "whiz_user",
    "password": "password"
  },
  "identity": {
    "account": "111111111111",
    "user_id": "AIDAEXAMPLE",
    "arn": "arn:aws:iam::111111111111:user/whiz_user",
    "region": "us-east-1"
  },
  "started_at": "2026-04-12T00:00:00Z",
  "expires_at": "2026-04-12T01:00:00Z"
}

Example: list --json​

[
  {
    "kind": "aws",
    "slug": "aws-sandbox",
    "credentials": {
      "access_key": "AKIAEXAMPLE",
      "secret_key": "secret"
    },
    "console": {
      "url": "https://111111111111.signin.aws.amazon.com/console",
      "username": "whiz_user",
      "password": "password"
    },
    "identity": {
      "account": "111111111111",
      "user_id": "AIDAEXAMPLE",
      "arn": "arn:aws:iam::111111111111:user/whiz_user",
      "region": "us-east-1"
    },
    "started_at": "2026-04-12T00:00:00Z",
    "expires_at": "2026-04-12T01:00:00Z"
  }
]

Notes​

  • status, login, logout, destroy, exec, version, and completion do not have JSON renderers.
  • create --json can still return a non-zero exit code if verification fails after creation.

See also​