Preview — pending review
This reference is generated from the platform API contract and is still under review. Operations, fields, and descriptions can change before publication.
The active Category → Series → Flavor tree for one region
The structural backbone of the instance-create size picker: every ACTIVE plan category that
has at least one ACTIVE series, each series carrying the flavors assigned to it IN region.
A flavor is listed ONLY when its region compute product exists and is published + priced +
present -- the rule the launch enforces, so the tree never offers a size whose create would
409. A series with no offerable flavor in the region is still returned
with an empty flavors list (shown disabled).
Any authenticated principal may read it (no scope, no platform role); the catalog is
platform-global, so it is the same answer for every tenant.
Validation: region is required and non-empty (422); it is not resolved against the
region registry -- an unknown region simply yields categories whose series carry no flavors
(or no categories).
Async & state: Synchronous read; no state change.
Errors: 401 unauthenticated; 422 missing region; 500.
Idempotency/Concurrency: Safe.
bearerTokenAuthorizationBearer <token>An API token (pc_live_…) or a service-account key (sak_live_…), created in Identity & Access Management and sent as Authorization: Bearer <token>. Requests are rate limited per credential and per tenant: every response carries X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset, and a refused request gets 429 RATE_LIMITED with Retry-After.
region*stringThe platform region code whose assigned flavors are listed.
1 <= lengthThe active category tree for the region.
application/json- response
The GET /catalog body.
region*stringThe requested region, echoed.
categories*array<>curl -X GET "https://example.com/catalog?region=string"{ "region": "string", "categories": [ { "id": "string", "name": "string", "slug": "string", "description": "string", "icon": "string", "iconLightUrl": "string", "iconDarkUrl": "string", "sortOrder": 0, "series": [ { "id": "string", "name": "string", "slug": "string", "description": "string", "icon": "string", "iconLightUrl": "string", "iconDarkUrl": "string", "sortOrder": 0, "flavors": [ { "id": "string", "name": "string", "family": "string", "vcpus": 0, "ramMb": 0, "diskGb": 0, "priceHourly": { "amount": 0, "currency": "USD" }, "priceMonthly": { "amount": 0, "currency": "USD" }, "gpu": { "count": 1, "model": "string" } } ] } ] } ]}