---
title: "List the instance types the organization can launch"
---

> 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

`GET /v1/organizations/{orgId}/instance-types`

## Authentication

Requires one of the following:

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

## Path parameters

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

## Code samples

### cURL

```curl
curl --request GET \
  --url https://compute-api.ezghcloud.com/v1/organizations/string/instance-types \
  --header 'Authorization: Bearer <token>'
```

### TypeScript

```typescript
const url = 'https://compute-api.ezghcloud.com/v1/organizations/string/instance-types';
const options = {method: 'GET', 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://compute-api.ezghcloud.com/v1/organizations/string/instance-types"

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

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

print(response.text)
```

## Responses

### 200

Every active and deprecated type the organization can launch.

#### Example

```json
{
  "instanceTypes": [
    {
      "architecture": "amd64",
      "cpuGroup": "string",
      "cpuMaxPercent": 0,
      "family": "string",
      "instanceStore": {
        "disks": 0,
        "iops": 0,
        "sizeGiB": 0,
        "throughputMBps": 0
      },
      "limits": {
        "networkInterfaces": 0,
        "volumes": 0
      },
      "memoryMiB": 0,
      "migratable": true,
      "name": "string",
      "network": {
        "baselineMbps": 0,
        "burstMbps": 0,
        "pps": 0
      },
      "numaNodes": 0,
      "status": "active",
      "storage": {
        "iops": 0,
        "throughputMBps": 0
      },
      "vcpus": 0
    }
  ]
}
```

- `ListInstanceTypes.response.200.instanceTypes` (array<object>, required)
  - `ListInstanceTypes.response.200.instanceTypes.architecture` (unknown, required)
    - one of `"amd64"`
  - `ListInstanceTypes.response.200.instanceTypes.cpuGroup` (string, required)
  - `ListInstanceTypes.response.200.instanceTypes.cpuMaxPercent` (integer | null, required)
  - `ListInstanceTypes.response.200.instanceTypes.family` (string, required)
  - `ListInstanceTypes.response.200.instanceTypes.instanceStore` (object | null, required) — Local NVMe disks on the instance's host, virtio-blk with serials store0, store1, …: ephemeral (contents are lost when the instance stops, is terminated or moves to another host; a reboot keeps them). null for types without.
    - `ListInstanceTypes.response.200.instanceTypes.instanceStore.disks` (integer, required)
    - `ListInstanceTypes.response.200.instanceTypes.instanceStore.iops` (integer | null, required)
    - `ListInstanceTypes.response.200.instanceTypes.instanceStore.sizeGiB` (integer, required)
    - `ListInstanceTypes.response.200.instanceTypes.instanceStore.throughputMBps` (integer | null, required)
  - `ListInstanceTypes.response.200.instanceTypes.limits` (object, required)
    - `ListInstanceTypes.response.200.instanceTypes.limits.networkInterfaces` (integer, required)
    - `ListInstanceTypes.response.200.instanceTypes.limits.volumes` (integer, required)
  - `ListInstanceTypes.response.200.instanceTypes.memoryMiB` (integer, required)
  - `ListInstanceTypes.response.200.instanceTypes.migratable` (boolean, required)
  - `ListInstanceTypes.response.200.instanceTypes.name` (string, required) — The type's name, launched by (t0.small).
  - `ListInstanceTypes.response.200.instanceTypes.network` (object, required)
    - `ListInstanceTypes.response.200.instanceTypes.network.baselineMbps` (integer, required)
    - `ListInstanceTypes.response.200.instanceTypes.network.burstMbps` (integer, required)
    - `ListInstanceTypes.response.200.instanceTypes.network.pps` (integer, required)
  - `ListInstanceTypes.response.200.instanceTypes.numaNodes` (integer, required)
  - `ListInstanceTypes.response.200.instanceTypes.status` (unknown, required)
    - one of `"active"`, `"deprecated"`
  - `ListInstanceTypes.response.200.instanceTypes.storage` (object, required)
    - `ListInstanceTypes.response.200.instanceTypes.storage.iops` (integer, required)
    - `ListInstanceTypes.response.200.instanceTypes.storage.throughputMBps` (integer, required)
  - `ListInstanceTypes.response.200.instanceTypes.vcpus` (integer, required)

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

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

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

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

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

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

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

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


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