Create Sandbox

Beta

POST/v1/core/sandboxes

Idempotent with Idempotency-Key header. Learn more

Creates a sandbox account.

include[]optional arrayenumValues:owner_account

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

namestring

Display name.

modeoptional stringnullableenumValues:blankseeded

Controls whether the sandbox is blank or seeded with tutorial data. Defaults to blank.

idstring

Sandbox ID.

objectstringenumValues:sandbox

Resource type identifier.

namestring

Display name.

owner_accountobjectExpandablenullable

Owner account.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

Display name.

default_billing_addressobjectnullable

Default billing address.

Always returned as null in this endpoint.

default_shipping_addressobjectnullable

Default shipping address.

Always returned as null in this endpoint.

brandingobjectnullable

Branding configuration.

Always returned as null in this endpoint.

portalobjectnullable

Portal configuration.

Always returned as null in this endpoint.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

created_atstring (date-time)

When this sandbox was created.

updated_atstring (date-time)

When this sandbox was last updated.

Responses

201

Successful response for Create Sandbox

Create Sandbox

curl API_HOST/v1/core/sandboxes \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Integration Testing",
  "mode": "blank"
}'

curl API_HOST/v1/core/sandboxes \
  -X POST \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Augno-Version: 1.0.forge-preview.1" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Integration Testing",
  "mode": "blank"
}'

201 example

{
  "id": "sbac_01jm4r6700f8nwq3v5hx2d9ktp",
  "object": "sandbox",
  "name": "Integration Testing",
  "owner_account": {
    "id": "ac_01gf7a8200eaj8fke1xvw4h50x",
    "object": "account",
    "name": "Acme Inc.",
    "default_billing_address": null,
    "default_shipping_address": null,
    "branding": null,
    "portal": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "sbac_01jm4r6700f8nwq3v5hx2d9ktp",
  "object": "sandbox",
  "name": "Integration Testing",
  "owner_account": {
    "id": "ac_01gf7a8200eaj8fke1xvw4h50x",
    "object": "account",
    "name": "Acme Inc.",
    "default_billing_address": null,
    "default_shipping_address": null,
    "branding": null,
    "portal": null,
    "created_at": "2026-05-10T00:00:00Z",
    "updated_at": "2026-05-10T00:23:00Z"
  },
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Sandbox

Query Parameters

Request Body

Returns

Responses