Sign Up

Catalog

Get the CPU catalog

GET
/cpu-catalog

Shows which CPU architectures and types are currently available in the included regions.

Authorization

headerAuthorizationBearer <token>

Bearer project API key.

Query Parameters

region?string

Comma-separated list of regions to include. Defaults to all regions.

Response Body

The CPU catalog

application/json
  1. response

GET /cpu-catalog body.

arches*array<>

The CPU architectures present in the catalog, with their availability.

cpu_types*array<>

CPU types and their availability.

regions*array<>

Regions included in the catalog.

curl -X GET 'https://example.com/cpu-catalog'
{  "arches": [    {      "available": true,      "id": "amd64",      "regions": [        "string"      ]    }  ],  "cpu_types": [    {      "available": true,      "cpu_arch": "amd64",      "exact_regions": [        "string"      ],      "fallback_regions": [        "string"      ],      "id": "string",      "name": "string",      "tier": 0    }  ],  "regions": [    {      "default_arch": "amd64",      "default_type": "string",      "id": "string"    }  ]}

Get the Mac catalog

GET
/mac-catalog

Shows each covered region's default Mac model and, per Mac model, how many Macs a reservation can take now and its price.

Authorization

headerAuthorizationBearer <token>

Bearer project API key.

Query Parameters

region?string

Comma-separated list of regions to include. Defaults to all regions.

Response Body

The Mac catalog

application/json
  1. response

Free Macs and prices per Mac model, per region.

regions*array<>

Every region the answer covers, in catalog order.

curl -X GET 'https://example.com/mac-catalog'
{  "regions": [    {      "default_model": "string",      "id": "string",      "models": [        {          "available": 0,          "model": {            "default_size": null,            "disk_mib": 0,            "id": "string",            "max_sandboxes": 0,            "memory_mib": 0,            "name": "string",            "sandbox_disk_mib": 0,            "vcpus": 0          },          "price": null        }      ]    }  ]}

List Mac models

GET
/mac-models

Authorization

headerAuthorizationBearer <token>

Bearer project API key.

Response Body

The Mac models

application/json
  1. response

The registered Mac models.

mac_models*array<>

Every registered Mac model, ordered by ID.

curl -X GET 'https://example.com/mac-models'
{  "mac_models": [    {      "default_size": null,      "disk_mib": 0,      "id": "string",      "max_sandboxes": 0,      "memory_mib": 0,      "name": "string",      "sandbox_disk_mib": 0,      "vcpus": 0    }  ]}