Compute

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.

List the active add-ons with their sellable periods

GET
/catalog/addons

Every ACTIVE add-on, each exposing ONLY its sellable (operator-priced) periods. attachScope selects the surface: instance (sold in the compute wizard, metered with the VM) or subscription (an account-level entitlement that outlives any VM); omitted returns both. The filter is a convenience -- instance-create refuses a subscription-scoped item server-side whatever the client sends. Any authenticated principal may read it; platform-global. Validation: attachScope, when given, must be instance or subscription (case-insensitive) -- else 422 field=attachScope. Async & state: Synchronous read; no state change. Errors: 401; 422; 500. Idempotency/Concurrency: Safe.

Authorization

bearerToken
headerAuthorizationBearer <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.

Query Parameters

attachScope?string

Filter to the items sold at one surface: instance (compute wizard) or subscription (account-level entitlements). Omit for both. Matched case-insensitively.

Value in"instance""subscription"

Response Body

The active add-ons.

application/json
  1. response
addons*array<>
curl -X GET "https://example.com/catalog/addons"
{  "addons": [    {      "id": "string",      "slug": "string",      "name": "string",      "description": "string",      "currency": "string",      "attachScope": "instance",      "prices": {        "hour": 0,        "month": 0,        "year": 0      },      "sellablePeriods": [        "hour"      ]    }  ]}