---
title: "Create a sandbox"
description: "Synchronous: waits up to 10 seconds for the sandbox to start and answers with the sandbox as it is by then, usually running. A sandbox that could not be started is answered too, with status failed and a statusReason. 400 image_not_found, 400 for a bot the organization doesn't have, 403 access_denied naming bots.pass, 403 image_access_denied, 409 quota_exceeded."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.ezghcloud.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Sandboxes API

`POST /v1/organizations/{orgId}/projects/{projectId}/sandboxes`

Synchronous: waits up to 10 seconds for the sandbox to start and answers with the sandbox as it is by then, usually running. A sandbox that could not be started is answered too, with status failed and a statusReason. 400 image_not_found, 400 for a bot the organization doesn't have, 403 access_denied naming bots.pass, 403 image_access_denied, 409 quota_exceeded.

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `oauth`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie

## Path parameters

- `CreateSandbox.path.orgId` (string, required) — UUID or prefixed ID (org_…)
- `CreateSandbox.path.projectId` (string, required) — UUID or prefixed ID (prj_…)

## Header parameters

- `CreateSandbox.header.Idempotency-Key` (string, optional) — Makes a retry safe: the same key and request get the stored response.
  - pattern `^[\x21-\x7e]{1,200}$`

## Request body

_Required._

- `CreateSandbox.image` (string, required) — A container image the caller may pull, by tag or digest.
  - minLength 1
- `CreateSandbox.bot` (string, optional) — A Bot of the organization, by its ID (bot_…). Code in the sandbox can get the Bot's short-lived API keys from the metadata endpoint, so give it only what that code may do. Needs bots.pass on the Bot.
  - pattern `^bot_[a-z0-9]{12}$`
- `CreateSandbox.command` (array<string>, optional) — Run when the sandbox starts, in place of the image's own. At most 64 arguments, 8 KiB in all.
- `CreateSandbox.diskGiB` (integer, optional)
  - min 1; max 50; default `5`
- `CreateSandbox.env` (map<string>, optional) — At most 64 variables, 32 KiB in all. Names match ^[A-Za-z_][A-Za-z0-9_]*$.
- `CreateSandbox.idleSeconds` (integer, optional) — 0, or 60 to 86400.
  - min 0; max 86400; default `300`
- `CreateSandbox.memoryMiB` (unknown, optional)
  - one of `512`, `1024`, `2048`, `4096`, `8192`, `16384`; default `512`
- `CreateSandbox.name` (string, optional) — Defaults to the sandbox's slug.
  - minLength 1; maxLength 63
- `CreateSandbox.network` (unknown, optional) — none: no network device; nothing in the sandbox can reach any network. Not with vpc. Not available in every region yet: where it isn't, a create that names it is 400.
  - one of `"default"`, `"none"`; default `"default"`
- `CreateSandbox.serve` (object | null, optional) — Run the image's entrypoint and command as a service that serves HTTP on port, with PORT set. Leave command out. Null, the default, runs no service. Not available in every region yet: where it isn't, a create that names it is 400.
  - `CreateSandbox.serve.maxConcurrency` (integer, required) — The most requests the sandbox takes at once.
    - min 1; max 1000
  - `CreateSandbox.serve.port` (integer, required) — The port the service listens on, given to it as PORT.
    - min 1; max 65535
  - `CreateSandbox.serve.startupTimeoutSeconds` (integer, required) — How long the service may take to open its port after the sandbox starts.
    - min 1; max 3600
- `CreateSandbox.vcpus` (unknown, optional)
  - one of `1`, `2`, `4`, `8`; default `1`
- `CreateSandbox.vpc` (object | null, optional) — Reach a VPC: its connections into the VPC come from an address in the subnet, and its internet traffic goes through the VPC's NAT gateway (IPv4 only). Nothing in the VPC can connect to the sandbox. Needs network.subnets.get on the subnet, a subnet of the sandbox's project. Null, the default, reaches only the internet.
  - `CreateSandbox.vpc.subnet` (string, required) — The subnet's ID, sbn_….
    - pattern `^sbn_[a-z0-9]{12}$`

## Example request

```json
{
  "bot": "string",
  "command": [
    "string"
  ],
  "diskGiB": 5,
  "env": {
    "property1": "string",
    "property2": "string"
  },
  "idleSeconds": 300,
  "image": "string",
  "memoryMiB": 512,
  "name": "string",
  "network": "default",
  "serve": {
    "maxConcurrency": 1,
    "port": 1,
    "startupTimeoutSeconds": 1
  },
  "vcpus": 1,
  "vpc": {
    "subnet": "string"
  }
}
```

## Code samples

### cURL

```curl
curl --request POST \
  --url https://sandboxes.ezghcloud.com/v1/organizations/string/projects/string/sandboxes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bot": "string",
  "command": [
    "string"
  ],
  "diskGiB": 5,
  "env": {
    "property1": "string",
    "property2": "string"
  },
  "idleSeconds": 300,
  "image": "string",
  "memoryMiB": 512,
  "name": "string",
  "network": "default",
  "serve": {
    "maxConcurrency": 1,
    "port": 1,
    "startupTimeoutSeconds": 1
  },
  "vcpus": 1,
  "vpc": {
    "subnet": "string"
  }
}
'
```

### TypeScript

```typescript
const url = 'https://sandboxes.ezghcloud.com/v1/organizations/string/projects/string/sandboxes';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    bot: 'string',
    command: ['string'],
    diskGiB: 5,
    env: {property1: 'string', property2: 'string'},
    idleSeconds: 300,
    image: 'string',
    memoryMiB: 512,
    name: 'string',
    network: 'default',
    serve: {maxConcurrency: 1, port: 1, startupTimeoutSeconds: 1},
    vcpus: 1,
    vpc: {subnet: 'string'}
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://sandboxes.ezghcloud.com/v1/organizations/string/projects/string/sandboxes"

payload = {
    "bot": "string",
    "command": ["string"],
    "diskGiB": 5,
    "env": {
        "property1": "string",
        "property2": "string"
    },
    "idleSeconds": 300,
    "image": "string",
    "memoryMiB": 512,
    "name": "string",
    "network": "default",
    "serve": {
        "maxConcurrency": 1,
        "port": 1,
        "startupTimeoutSeconds": 1
    },
    "vcpus": 1,
    "vpc": { "subnet": "string" }
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 201

The sandbox.

#### Example

```json
{
  "bot": {
    "id": "string",
    "name": "string"
  },
  "createdAt": "2019-08-24T14:15:22Z",
  "diskGiB": 0,
  "egressBlocked": true,
  "egressIpv4": "string",
  "egressIpv6": "string",
  "envNames": [
    "string"
  ],
  "hasCommand": true,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "idleSeconds": 0,
  "image": {
    "digest": "string",
    "reference": "string",
    "repository": "string"
  },
  "lastActivityAt": "2019-08-24T14:15:22Z",
  "memoryMiB": 0,
  "memoryRestored": true,
  "name": "string",
  "network": "default",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "region": "string",
  "resourceName": "string",
  "serve": {
    "maxConcurrency": 1,
    "port": 1,
    "startupTimeoutSeconds": 1
  },
  "slug": "string",
  "startedAt": "2019-08-24T14:15:22Z",
  "status": "starting",
  "statusReason": "string",
  "suspendedAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "vcpus": 0,
  "vpc": {
    "subnet": "string",
    "vpc": "string"
  },
  "vpcIpv4": "string",
  "vpcIpv6": "string"
}
```

- `CreateSandbox.response.201.bot` (object | null, required) — The Bot whose short-lived API keys code in the sandbox gets from the metadata endpoint; null with none. Set at create only.
  - `CreateSandbox.response.201.bot.id` (string, required) — The Bot's ID, bot_….
  - `CreateSandbox.response.201.bot.name` (string | null, required) — The Bot's name on a read of one sandbox; null in lists, and when the organization no longer has the Bot.
- `CreateSandbox.response.201.createdAt` (string, required)
  - format `date-time`
- `CreateSandbox.response.201.diskGiB` (integer, required)
- `CreateSandbox.response.201.egressBlocked` (boolean, required) — Whether EZGH has turned off this sandbox's network. It keeps running, and nothing in it can reach the internet. Contact support.
- `CreateSandbox.response.201.egressIpv4` (string | null, required) — The address its outbound IPv4 connections come from. Null unless it is running, and always null for a sandbox in a VPC or with network none.
- `CreateSandbox.response.201.egressIpv6` (string | null, required) — The address its outbound IPv6 connections come from. Null unless it is running, and always null for a sandbox in a VPC or with network none.
- `CreateSandbox.response.201.envNames` (array<string>, required) — The names of its environment variables, sorted. Their values are never returned.
- `CreateSandbox.response.201.hasCommand` (boolean, required) — Whether it was created with a command. The command is never returned.
- `CreateSandbox.response.201.id` (string, required)
  - format `uuid`
- `CreateSandbox.response.201.idleSeconds` (integer, required) — Suspended after this long with no command, file call or open stream; 0 is never.
- `CreateSandbox.response.201.image` (object, required) — The image as it was asked for, and the repository and digest it was resolved to when the sandbox was created. Every later start uses that digest.
  - `CreateSandbox.response.201.image.digest` (string, required)
  - `CreateSandbox.response.201.image.reference` (string, required)
  - `CreateSandbox.response.201.image.repository` (string, required)
- `CreateSandbox.response.201.lastActivityAt` (string | null, required) — When a command or a file call last used it, to within about a minute and a half while it runs; idleSeconds counts from the exact time.
  - format `date-time`
- `CreateSandbox.response.201.memoryMiB` (integer, required)
- `CreateSandbox.response.201.memoryRestored` (boolean | null, required) — Whether its last start, resume or restart carried its processes on (true: a resume that restored its memory) or started it again from its disk (false: a start after a stop, a restart, or a resume that could not restore its memory). Null until the first one after its creation.
- `CreateSandbox.response.201.name` (string, required)
- `CreateSandbox.response.201.network` (unknown, required) — default, or none: a sandbox with no network device, which reaches nothing and has no egress addresses.
  - one of `"default"`, `"none"`
- `CreateSandbox.response.201.organizationId` (string, required)
  - format `uuid`
- `CreateSandbox.response.201.projectId` (string, required)
  - format `uuid`
- `CreateSandbox.response.201.region` (string, required)
- `CreateSandbox.response.201.resourceName` (string, required)
- `CreateSandbox.response.201.serve` (object | null, required) — The service the sandbox runs: the image's entrypoint and command, serving HTTP on port. Null for a sandbox that runs no service.
  - `CreateSandbox.response.201.serve.maxConcurrency` (integer, required) — The most requests the sandbox takes at once.
    - min 1; max 1000
  - `CreateSandbox.response.201.serve.port` (integer, required) — The port the service listens on, given to it as PORT.
    - min 1; max 65535
  - `CreateSandbox.response.201.serve.startupTimeoutSeconds` (integer, required) — How long the service may take to open its port after the sandbox starts.
    - min 1; max 3600
- `CreateSandbox.response.201.slug` (string, required)
- `CreateSandbox.response.201.startedAt` (string | null, required)
  - format `date-time`
- `CreateSandbox.response.201.status` (unknown, required) — Clients treat any other value as unknown.
  - one of `"starting"`, `"running"`, `"suspending"`, `"suspended"`, `"resuming"`, `"stopping"`, `"stopped"`, `"impaired"`, `"failed"`, `"deleting"`
- `CreateSandbox.response.201.statusReason` (string | null, required) — Why it has its status, when there is something to say: idle, drain, host_lost, host_rebooted, suspend_failed, no_capacity, vpc_unavailable, image_prepare_failed, start_failed, reboot_loop, guest_halted, snapshot_unusable, interrupted or operator_hold (EZGH stopped it, and it can't be started or resumed until support lifts the hold); clients treat others as unknown.
- `CreateSandbox.response.201.suspendedAt` (string | null, required)
  - format `date-time`
- `CreateSandbox.response.201.updatedAt` (string, required)
  - format `date-time`
- `CreateSandbox.response.201.vcpus` (integer, required)
- `CreateSandbox.response.201.vpc` (object | null, required) — The VPC and subnet the sandbox reaches, set at create; null for a sandbox that reaches only the internet.
  - `CreateSandbox.response.201.vpc.subnet` (string, required) — The subnet's ID, sbn_….
  - `CreateSandbox.response.201.vpc.vpc` (string, required) — The VPC's ID, vpc_….
- `CreateSandbox.response.201.vpcIpv4` (string | null, required) — The address in the subnet its IPv4 connections into the VPC come from. Null unless it is running in a VPC.
- `CreateSandbox.response.201.vpcIpv6` (string | null, required) — The address in the subnet its IPv6 connections into the VPC come from. Null unless it is running in a VPC.

### 400

invalid_request (with issues), invalid_cursor, or the endpoint's own 400 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CreateSandbox.response.400.error` (object, required)
  - `CreateSandbox.response.400.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CreateSandbox.response.400.error.message` (string, required)
    - maxLength 1024
  - `CreateSandbox.response.400.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CreateSandbox.response.400.error.issues.message` (string, required)
    - `CreateSandbox.response.400.error.issues.path` (string, required)
  - `CreateSandbox.response.400.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CreateSandbox.response.400.error.quota.id` (string, required)
    - `CreateSandbox.response.400.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CreateSandbox.response.400.error.quota.limit` (integer, required)
      - min 0
    - `CreateSandbox.response.400.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CreateSandbox.response.400.error.quota.inFlight` (integer, optional)
      - min 0
    - `CreateSandbox.response.400.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.400.error.quota.region` (string, optional)
    - `CreateSandbox.response.400.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.400.error.quota.scopeResourceName` (string, optional)
    - `CreateSandbox.response.400.error.quota.used` (integer, optional)
      - min 0
    - `CreateSandbox.response.400.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 401

unauthenticated: no credential, or one that doesn't check out.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CreateSandbox.response.401.error` (object, required)
  - `CreateSandbox.response.401.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CreateSandbox.response.401.error.message` (string, required)
    - maxLength 1024
  - `CreateSandbox.response.401.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CreateSandbox.response.401.error.issues.message` (string, required)
    - `CreateSandbox.response.401.error.issues.path` (string, required)
  - `CreateSandbox.response.401.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CreateSandbox.response.401.error.quota.id` (string, required)
    - `CreateSandbox.response.401.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CreateSandbox.response.401.error.quota.limit` (integer, required)
      - min 0
    - `CreateSandbox.response.401.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CreateSandbox.response.401.error.quota.inFlight` (integer, optional)
      - min 0
    - `CreateSandbox.response.401.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.401.error.quota.region` (string, optional)
    - `CreateSandbox.response.401.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.401.error.quota.scopeResourceName` (string, optional)
    - `CreateSandbox.response.401.error.quota.used` (integer, optional)
      - min 0
    - `CreateSandbox.response.401.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 403

access_denied: the caller's policies don't allow the action; forbidden_origin: a cookie-authenticated write from an origin that isn't allowed; spend_limit_reached.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CreateSandbox.response.403.error` (object, required)
  - `CreateSandbox.response.403.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CreateSandbox.response.403.error.message` (string, required)
    - maxLength 1024
  - `CreateSandbox.response.403.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CreateSandbox.response.403.error.issues.message` (string, required)
    - `CreateSandbox.response.403.error.issues.path` (string, required)
  - `CreateSandbox.response.403.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CreateSandbox.response.403.error.quota.id` (string, required)
    - `CreateSandbox.response.403.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CreateSandbox.response.403.error.quota.limit` (integer, required)
      - min 0
    - `CreateSandbox.response.403.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CreateSandbox.response.403.error.quota.inFlight` (integer, optional)
      - min 0
    - `CreateSandbox.response.403.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.403.error.quota.region` (string, optional)
    - `CreateSandbox.response.403.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.403.error.quota.scopeResourceName` (string, optional)
    - `CreateSandbox.response.403.error.quota.used` (integer, optional)
      - min 0
    - `CreateSandbox.response.403.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 404

not_found: unknown, malformed, or in an organization the caller isn't in.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CreateSandbox.response.404.error` (object, required)
  - `CreateSandbox.response.404.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CreateSandbox.response.404.error.message` (string, required)
    - maxLength 1024
  - `CreateSandbox.response.404.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CreateSandbox.response.404.error.issues.message` (string, required)
    - `CreateSandbox.response.404.error.issues.path` (string, required)
  - `CreateSandbox.response.404.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CreateSandbox.response.404.error.quota.id` (string, required)
    - `CreateSandbox.response.404.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CreateSandbox.response.404.error.quota.limit` (integer, required)
      - min 0
    - `CreateSandbox.response.404.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CreateSandbox.response.404.error.quota.inFlight` (integer, optional)
      - min 0
    - `CreateSandbox.response.404.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.404.error.quota.region` (string, optional)
    - `CreateSandbox.response.404.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.404.error.quota.scopeResourceName` (string, optional)
    - `CreateSandbox.response.404.error.quota.used` (integer, optional)
      - min 0
    - `CreateSandbox.response.404.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 409

quota_exceeded (an allocation quota, with quota), idempotency_conflict, idempotency_in_progress (with Retry-After), organization_deletion_pending, operation_in_progress, or the endpoint's own 409 codes.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CreateSandbox.response.409.error` (object, required)
  - `CreateSandbox.response.409.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CreateSandbox.response.409.error.message` (string, required)
    - maxLength 1024
  - `CreateSandbox.response.409.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CreateSandbox.response.409.error.issues.message` (string, required)
    - `CreateSandbox.response.409.error.issues.path` (string, required)
  - `CreateSandbox.response.409.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CreateSandbox.response.409.error.quota.id` (string, required)
    - `CreateSandbox.response.409.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CreateSandbox.response.409.error.quota.limit` (integer, required)
      - min 0
    - `CreateSandbox.response.409.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CreateSandbox.response.409.error.quota.inFlight` (integer, optional)
      - min 0
    - `CreateSandbox.response.409.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.409.error.quota.region` (string, optional)
    - `CreateSandbox.response.409.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.409.error.quota.scopeResourceName` (string, optional)
    - `CreateSandbox.response.409.error.quota.used` (integer, optional)
      - min 0
    - `CreateSandbox.response.409.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 413

payload_too_large: the body is over the endpoint's limit (1 MiB unless it says otherwise).

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CreateSandbox.response.413.error` (object, required)
  - `CreateSandbox.response.413.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CreateSandbox.response.413.error.message` (string, required)
    - maxLength 1024
  - `CreateSandbox.response.413.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CreateSandbox.response.413.error.issues.message` (string, required)
    - `CreateSandbox.response.413.error.issues.path` (string, required)
  - `CreateSandbox.response.413.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CreateSandbox.response.413.error.quota.id` (string, required)
    - `CreateSandbox.response.413.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CreateSandbox.response.413.error.quota.limit` (integer, required)
      - min 0
    - `CreateSandbox.response.413.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CreateSandbox.response.413.error.quota.inFlight` (integer, optional)
      - min 0
    - `CreateSandbox.response.413.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.413.error.quota.region` (string, optional)
    - `CreateSandbox.response.413.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.413.error.quota.scopeResourceName` (string, optional)
    - `CreateSandbox.response.413.error.quota.used` (integer, optional)
      - min 0
    - `CreateSandbox.response.413.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 429

too_many_requests, with Retry-After; or quota_exceeded (a rate, usage or concurrency quota, with quota), never with Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CreateSandbox.response.429.error` (object, required)
  - `CreateSandbox.response.429.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CreateSandbox.response.429.error.message` (string, required)
    - maxLength 1024
  - `CreateSandbox.response.429.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CreateSandbox.response.429.error.issues.message` (string, required)
    - `CreateSandbox.response.429.error.issues.path` (string, required)
  - `CreateSandbox.response.429.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CreateSandbox.response.429.error.quota.id` (string, required)
    - `CreateSandbox.response.429.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CreateSandbox.response.429.error.quota.limit` (integer, required)
      - min 0
    - `CreateSandbox.response.429.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CreateSandbox.response.429.error.quota.inFlight` (integer, optional)
      - min 0
    - `CreateSandbox.response.429.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.429.error.quota.region` (string, optional)
    - `CreateSandbox.response.429.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.429.error.quota.scopeResourceName` (string, optional)
    - `CreateSandbox.response.429.error.quota.used` (integer, optional)
      - min 0
    - `CreateSandbox.response.429.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 500

internal_error: a bug; the details are in the logs, under the request ID.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CreateSandbox.response.500.error` (object, required)
  - `CreateSandbox.response.500.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CreateSandbox.response.500.error.message` (string, required)
    - maxLength 1024
  - `CreateSandbox.response.500.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CreateSandbox.response.500.error.issues.message` (string, required)
    - `CreateSandbox.response.500.error.issues.path` (string, required)
  - `CreateSandbox.response.500.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CreateSandbox.response.500.error.quota.id` (string, required)
    - `CreateSandbox.response.500.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CreateSandbox.response.500.error.quota.limit` (integer, required)
      - min 0
    - `CreateSandbox.response.500.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CreateSandbox.response.500.error.quota.inFlight` (integer, optional)
      - min 0
    - `CreateSandbox.response.500.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.500.error.quota.region` (string, optional)
    - `CreateSandbox.response.500.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.500.error.quota.scopeResourceName` (string, optional)
    - `CreateSandbox.response.500.error.quota.used` (integer, optional)
      - min 0
    - `CreateSandbox.response.500.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.

### 503

unavailable: a dependency the request needs is down. Retry after Retry-After.

#### Example

```json
{
  "error": {
    "code": "string",
    "issues": [
      {
        "message": "string",
        "path": "string"
      }
    ],
    "message": "string",
    "quota": {
      "id": "string",
      "inFlight": 0,
      "kind": "allocation",
      "limit": 0,
      "periodStart": "2019-08-24T14:15:22Z",
      "region": "string",
      "resetsAt": "2019-08-24T14:15:22Z",
      "scope": "organization",
      "scopeResourceName": "string",
      "used": 0,
      "window": "string"
    }
  }
}
```

- `CreateSandbox.response.503.error` (object, required)
  - `CreateSandbox.response.503.error.code` (string, required)
    - maxLength 64; pattern `^[a-z][a-z0-9_]*$`
  - `CreateSandbox.response.503.error.message` (string, required)
    - maxLength 1024
  - `CreateSandbox.response.503.error.issues` (array<object>, optional) — invalid_request: one entry per problem, at a dotted path.
    - `CreateSandbox.response.503.error.issues.message` (string, required)
    - `CreateSandbox.response.503.error.issues.path` (string, required)
  - `CreateSandbox.response.503.error.quota` (object, optional) — quota_exceeded: the quota that refused the request. Never with Retry-After.
    - `CreateSandbox.response.503.error.quota.id` (string, required)
    - `CreateSandbox.response.503.error.quota.kind` (unknown, required)
      - one of `"allocation"`, `"rate"`, `"usage"`, `"concurrency"`
    - `CreateSandbox.response.503.error.quota.limit` (integer, required)
      - min 0
    - `CreateSandbox.response.503.error.quota.scope` (unknown, required)
      - one of `"organization"`, `"project"`, `"resource"`
    - `CreateSandbox.response.503.error.quota.inFlight` (integer, optional)
      - min 0
    - `CreateSandbox.response.503.error.quota.periodStart` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.503.error.quota.region` (string, optional)
    - `CreateSandbox.response.503.error.quota.resetsAt` (string, optional)
      - format `date-time`
    - `CreateSandbox.response.503.error.quota.scopeResourceName` (string, optional)
    - `CreateSandbox.response.503.error.quota.used` (integer, optional)
      - min 0
    - `CreateSandbox.response.503.error.quota.window` (string, optional) — rate only: an ISO 8601 duration, PT1S to PT1H.


Source: https://docs.ezghcloud.com/sandboxes-api/CreateSandbox/index.md
