---
title: "Suspend a sandbox"
description: "Saves the sandbox's memory and disk and frees its host. Waits up to 10 seconds. 409 sandbox_not_running when it isn't running."
---

> 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/{sandboxId}/suspend`

Saves the sandbox's memory and disk and frees its host. Waits up to 10 seconds. 409 sandbox_not_running when it isn't running.

## Authentication

Requires one of the following:

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

## Path parameters

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

## Header parameters

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

## Code samples

### cURL

```curl
curl --request POST \
  --url https://sandboxes.ezghcloud.com/v1/organizations/string/projects/string/sandboxes/string/suspend \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://sandboxes.ezghcloud.com/v1/organizations/string/projects/string/sandboxes/string/suspend';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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/string/suspend"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)
```

## Responses

### 200

The sandbox, as it is when the call answers.

#### 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"
}
```

- `SuspendSandbox.response.200.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.
  - `SuspendSandbox.response.200.bot.id` (string, required) — The Bot's ID, bot_….
  - `SuspendSandbox.response.200.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.
- `SuspendSandbox.response.200.createdAt` (string, required)
  - format `date-time`
- `SuspendSandbox.response.200.diskGiB` (integer, required)
- `SuspendSandbox.response.200.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.
- `SuspendSandbox.response.200.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.
- `SuspendSandbox.response.200.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.
- `SuspendSandbox.response.200.envNames` (array<string>, required) — The names of its environment variables, sorted. Their values are never returned.
- `SuspendSandbox.response.200.hasCommand` (boolean, required) — Whether it was created with a command. The command is never returned.
- `SuspendSandbox.response.200.id` (string, required)
  - format `uuid`
- `SuspendSandbox.response.200.idleSeconds` (integer, required) — Suspended after this long with no command, file call or open stream; 0 is never.
- `SuspendSandbox.response.200.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.
  - `SuspendSandbox.response.200.image.digest` (string, required)
  - `SuspendSandbox.response.200.image.reference` (string, required)
  - `SuspendSandbox.response.200.image.repository` (string, required)
- `SuspendSandbox.response.200.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`
- `SuspendSandbox.response.200.memoryMiB` (integer, required)
- `SuspendSandbox.response.200.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.
- `SuspendSandbox.response.200.name` (string, required)
- `SuspendSandbox.response.200.network` (unknown, required) — default, or none: a sandbox with no network device, which reaches nothing and has no egress addresses.
  - one of `"default"`, `"none"`
- `SuspendSandbox.response.200.organizationId` (string, required)
  - format `uuid`
- `SuspendSandbox.response.200.projectId` (string, required)
  - format `uuid`
- `SuspendSandbox.response.200.region` (string, required)
- `SuspendSandbox.response.200.resourceName` (string, required)
- `SuspendSandbox.response.200.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.
  - `SuspendSandbox.response.200.serve.maxConcurrency` (integer, required) — The most requests the sandbox takes at once.
    - min 1; max 1000
  - `SuspendSandbox.response.200.serve.port` (integer, required) — The port the service listens on, given to it as PORT.
    - min 1; max 65535
  - `SuspendSandbox.response.200.serve.startupTimeoutSeconds` (integer, required) — How long the service may take to open its port after the sandbox starts.
    - min 1; max 3600
- `SuspendSandbox.response.200.slug` (string, required)
- `SuspendSandbox.response.200.startedAt` (string | null, required)
  - format `date-time`
- `SuspendSandbox.response.200.status` (unknown, required) — Clients treat any other value as unknown.
  - one of `"starting"`, `"running"`, `"suspending"`, `"suspended"`, `"resuming"`, `"stopping"`, `"stopped"`, `"impaired"`, `"failed"`, `"deleting"`
- `SuspendSandbox.response.200.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.
- `SuspendSandbox.response.200.suspendedAt` (string | null, required)
  - format `date-time`
- `SuspendSandbox.response.200.updatedAt` (string, required)
  - format `date-time`
- `SuspendSandbox.response.200.vcpus` (integer, required)
- `SuspendSandbox.response.200.vpc` (object | null, required) — The VPC and subnet the sandbox reaches, set at create; null for a sandbox that reaches only the internet.
  - `SuspendSandbox.response.200.vpc.subnet` (string, required) — The subnet's ID, sbn_….
  - `SuspendSandbox.response.200.vpc.vpc` (string, required) — The VPC's ID, vpc_….
- `SuspendSandbox.response.200.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.
- `SuspendSandbox.response.200.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"
    }
  }
}
```

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

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

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

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

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

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

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

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

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


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