---
title: "Launch an instance"
description: "Asynchronous: answers 202 with the CreateInstance operation once capacity is claimed and every volume, interface and firewall attachment is reserved. 409 insufficient_capacity when no cell has room."
---

> 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: EZGH Compute API

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

Asynchronous: answers 202 with the CreateInstance operation once capacity is claimed and every volume, interface and firewall attachment is reserved. 409 insufficient_capacity when no cell has room.

## Authentication

Requires one of the following:

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

## Path parameters

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

## Header parameters

- `CreateInstance.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._

- `CreateInstance.instanceType` (string, required)
- `CreateInstance.name` (string, required)
  - minLength 1; maxLength 100
- `CreateInstance.networkInterfaces` (array<object>, required)
  - `CreateInstance.networkInterfaces.firewallIds` (array<string>, optional) — Omitted: the project's default firewall (for a private interface, its VPC's default firewall). []: none.
    - pattern `^fwl_[a-z0-9]{12}$`
  - `CreateInstance.networkInterfaces.ipv4` (boolean, optional) — A public IPv4 address. On a private interface it is mapped onto the interface's primary private IPv4 (the instance never sees it) and needs the VPC's network gateway (409 vpc_has_no_gateway). Omitted: none on a public interface; with subnet, the subnet's autoAssignPublicIpv4 decides.
  - `CreateInstance.networkInterfaces.ipv6` (boolean, optional) — Only with subnet: a public IPv6 /64 on the private interface, configured on the instance; needs the VPC's network gateway (409 vpc_has_no_gateway). Omitted, the subnet's autoAssignPublicIpv6 decides.
  - `CreateInstance.networkInterfaces.networkInterfaceId` (string, optional) — An existing interface's eni_ ID (a UUID is 400 invalid_request).
    - pattern `^eni_[a-z0-9]{12}$`
  - `CreateInstance.networkInterfaces.privateIpv4Address` (string, optional) — The private interface's primary IPv4 address, a usable address of its subnet; omitted, the lowest free one. Only with subnet.
    - format `ipv4`
  - `CreateInstance.networkInterfaces.subnet` (string, optional) — A VPC subnet (sbn_…) of this project: the interface is private, with a primary private IPv4 and IPv6 address in it. It may be the primary (index 0): then no other interface may be public (409 primary_is_private).
    - pattern `^sbn_[a-z0-9]{12}$`
- `CreateInstance.bot` (string, optional) — A Bot of the organization (its bot_ ID) to attach: code on the instance gets short-lived API keys acting as it from the metadata service. Needs bots.pass on the Bot (403 access_denied naming bots.pass). An unknown Bot or a UUID is 400 invalid_request at bot.
  - pattern `^bot_[a-z0-9]{12}$`
- `CreateInstance.image` (string, optional) — An image alias, such as linux/ubuntu:24.04, or an exact image ID (img_…) this project may launch: its own or a public platform image. Required unless rootVolume.snapshotId restores the root volume from a snapshot.
- `CreateInstance.rootDevice` (string, optional) — instanceStore boots from the type's first instance store disk (store0): the type must have instanceStore (400 invalid_request at rootDevice), rootVolume must be absent (400 at rootVolume), the image must fit the disk (400 image_too_large), and the instance can't be stopped or resized (409 instance_store_root). Its rootVolumeId is null.
  - one of `"volume"`, `"instanceStore"`; default `"volume"`
- `CreateInstance.rootVolume` (object, optional)
  - `CreateInstance.rootVolume.iops` (integer | null, optional)
  - `CreateInstance.rootVolume.sizeGiB` (integer, optional) — Omitted: the image's minimum size, rounded up to whole GiB, or the snapshot's volume size.
    - min 1
  - `CreateInstance.rootVolume.snapshotId` (string, optional) — A snapshot (snp_…) of this project to restore the root volume from, in place of image. The caller needs blockstore.snapshots.restore on it.
  - `CreateInstance.rootVolume.throughputMBps` (integer | null, optional)
  - `CreateInstance.rootVolume.volumeType` (string, optional) — A volume type from the block store's catalog. Omitted: the catalog's default type; a region whose catalog has no default answers 400 at rootVolume.volumeType, so name one. A root from a snapshot keeps the snapshot's type, and omitted takes it.
- `CreateInstance.sshKeyIds` (array<string>, optional)
  - pattern `^ssh_[a-z0-9]{12}$`
- `CreateInstance.tags` (map<string>, optional) — At most 50; keys 1-128 characters, values at most 256, keys starting with ezgh: are reserved.
- `CreateInstance.userData` (string, optional) — Base64, at most 16 KiB decoded. Never recorded.
- `CreateInstance.volumes` (array<object>, optional)
  - `CreateInstance.volumes.iops` (integer | null, optional)
  - `CreateInstance.volumes.sizeGiB` (integer, optional)
    - min 1
  - `CreateInstance.volumes.throughputMBps` (integer | null, optional)
  - `CreateInstance.volumes.volumeId` (string, optional) — An existing volume's vol_ ID (a UUID is 400 invalid_request).
    - pattern `^vol_[a-z0-9]{12}$`
  - `CreateInstance.volumes.volumeType` (string, optional)

## Example request

```json
{
  "bot": "string",
  "image": "string",
  "instanceType": "string",
  "name": "string",
  "networkInterfaces": [
    {
      "firewallIds": [
        "string"
      ],
      "ipv4": true,
      "ipv6": true,
      "networkInterfaceId": "string",
      "privateIpv4Address": "192.168.0.1",
      "subnet": "string"
    }
  ],
  "rootDevice": "volume",
  "rootVolume": {
    "iops": 0,
    "sizeGiB": 1,
    "snapshotId": "string",
    "throughputMBps": 0,
    "volumeType": "string"
  },
  "sshKeyIds": [
    "string"
  ],
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "userData": "string",
  "volumes": [
    {
      "iops": 0,
      "sizeGiB": 1,
      "throughputMBps": 0,
      "volumeId": "string",
      "volumeType": "string"
    }
  ]
}
```

## Code samples

### cURL

```curl
curl --request POST \
  --url https://compute-api.ezghcloud.com/v1/organizations/string/projects/string/instances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bot": "string",
  "image": "string",
  "instanceType": "string",
  "name": "string",
  "networkInterfaces": [
    {
      "firewallIds": [
        "string"
      ],
      "ipv4": true,
      "ipv6": true,
      "networkInterfaceId": "string",
      "privateIpv4Address": "192.168.0.1",
      "subnet": "string"
    }
  ],
  "rootDevice": "volume",
  "rootVolume": {
    "iops": 0,
    "sizeGiB": 1,
    "snapshotId": "string",
    "throughputMBps": 0,
    "volumeType": "string"
  },
  "sshKeyIds": [
    "string"
  ],
  "tags": {
    "property1": "string",
    "property2": "string"
  },
  "userData": "string",
  "volumes": [
    {
      "iops": 0,
      "sizeGiB": 1,
      "throughputMBps": 0,
      "volumeId": "string",
      "volumeType": "string"
    }
  ]
}
'
```

### TypeScript

```typescript
const url = 'https://compute-api.ezghcloud.com/v1/organizations/string/projects/string/instances';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    bot: 'string',
    image: 'string',
    instanceType: 'string',
    name: 'string',
    networkInterfaces: [
      {
        firewallIds: ['string'],
        ipv4: true,
        ipv6: true,
        networkInterfaceId: 'string',
        privateIpv4Address: '192.168.0.1',
        subnet: 'string'
      }
    ],
    rootDevice: 'volume',
    rootVolume: {
      iops: 0,
      sizeGiB: 1,
      snapshotId: 'string',
      throughputMBps: 0,
      volumeType: 'string'
    },
    sshKeyIds: ['string'],
    tags: {property1: 'string', property2: 'string'},
    userData: 'string',
    volumes: [
      {
        iops: 0,
        sizeGiB: 1,
        throughputMBps: 0,
        volumeId: 'string',
        volumeType: 'string'
      }
    ]
  })
};

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

### Python

```python
import requests

url = "https://compute-api.ezghcloud.com/v1/organizations/string/projects/string/instances"

payload = {
    "bot": "string",
    "image": "string",
    "instanceType": "string",
    "name": "string",
    "networkInterfaces": [
        {
            "firewallIds": ["string"],
            "ipv4": True,
            "ipv6": True,
            "networkInterfaceId": "string",
            "privateIpv4Address": "192.168.0.1",
            "subnet": "string"
        }
    ],
    "rootDevice": "volume",
    "rootVolume": {
        "iops": 0,
        "sizeGiB": 1,
        "snapshotId": "string",
        "throughputMBps": 0,
        "volumeType": "string"
    },
    "sshKeyIds": ["string"],
    "tags": {
        "property1": "string",
        "property2": "string"
    },
    "userData": "string",
    "volumes": [
        {
            "iops": 0,
            "sizeGiB": 1,
            "throughputMBps": 0,
            "volumeId": "string",
            "volumeType": "string"
        }
    ]
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

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

print(response.text)
```

## Responses

### 202

The operation, which Location names; poll it until it finishes.

#### Example

```json
{
  "action": "string",
  "cancellable": true,
  "createdAt": "2019-08-24T14:15:22Z",
  "createdBy": {
    "id": "string",
    "type": "user"
  },
  "error": {},
  "finishedAt": "2019-08-24T14:15:22Z",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
  "projectId": "5a8591dd-4039-49df-9202-96385ba3eff8",
  "startedAt": "2019-08-24T14:15:22Z",
  "status": "queued",
  "target": {
    "id": "string",
    "resourceName": "string",
    "type": "string"
  },
  "type": "string",
  "updatedAt": "2019-08-24T14:15:22Z"
}
```

- `CreateInstance.response.202.action` (string, required)
- `CreateInstance.response.202.cancellable` (boolean, required)
- `CreateInstance.response.202.createdAt` (string, required)
  - format `date-time`
- `CreateInstance.response.202.createdBy` (object, required)
  - `CreateInstance.response.202.createdBy.id` (string, required)
  - `CreateInstance.response.202.createdBy.type` (unknown, required)
    - one of `"user"`, `"bot"`, `"ssoUser"`, `"service"`
- `CreateInstance.response.202.error` (object | null, required) — A failed operation's error, { code, message }.
- `CreateInstance.response.202.finishedAt` (string | null, required)
  - format `date-time`
- `CreateInstance.response.202.id` (string, required)
  - format `uuid`
- `CreateInstance.response.202.organizationId` (string, required)
  - format `uuid`
- `CreateInstance.response.202.projectId` (string | null, required)
  - format `uuid`
- `CreateInstance.response.202.startedAt` (string | null, required)
  - format `date-time`
- `CreateInstance.response.202.status` (unknown, required)
  - one of `"queued"`, `"running"`, `"succeeded"`, `"failed"`, `"cancelled"`
- `CreateInstance.response.202.target` (object, required)
  - `CreateInstance.response.202.target.id` (string, required)
  - `CreateInstance.response.202.target.resourceName` (string, required)
  - `CreateInstance.response.202.target.type` (string, required)
- `CreateInstance.response.202.type` (string, required)
- `CreateInstance.response.202.updatedAt` (string, required)
  - format `date-time`

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

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

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

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

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

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

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

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

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

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


Source: https://docs.ezghcloud.com/compute-api/CreateInstance/index.md
