compute
GET /v1/compute/catalogue
Get everything the server order screen is built from.
Authenticatie
Stuur een API-sleutel mee als bearer token. De sleutel moet over de permissie sites.view beschikken; een sleutel zonder deze permissie wordt geweigerd met een 403 in plaats van een 404.
Waar je organisatie-id komt te staan
Dit eindpunt accepteert org_id als queryparameter. Laat deze achterwege en de aanroep destilleert je gehele tenant-substructie; stuur deze mee om de aanroep te beperken tot één organisatie.
Uw organisatie-id staat op het scherm met API-sleutels in uw dashboard, naast de sleutel zelf. Dit is in elke aanroep die u doet dezelfde id.
Probeer het
Vervang alles tussen punthaakjes door uw eigen waarden en de sleutelplaatsvervanger door een sleutel uit uw dashboard.
curl -X GET https://api.zinndigital.com/v1/compute/catalogue \
-H "Authorization: Bearer zdk_live_…"Ingelogd? De API-console in je dashboard vult je echte organisatie-id en je eigen sleutel in, en voert het verzoek uit tegen de live API zodat je de daadwerkelijke respons kunt zien. Open dit eindpunt in de API-console
Details
The live provider / data-centre / machine-size matrix, merged with the tiers we actually sell. Nothing about a provider, a zone, a size or a stack optimisation is authored in a client: a combination a client invented is one the provider refuses *inside provisioning*, minutes after the customer chose it, where all they see is a machine that failed. ⛔ **Sizes carry no price, ever.** Retail price is catalogue data the customer sees on the plan; the provider's own figure is cost, and a cost rendered beside a size is a margin leak. Every numeric on a size is nullable and a null stays null — a size rendered as "0 GB RAM" reads as a broken product where a blank reads as "not stated", which is what it is. `spec_source` says whether the sizes came from the provider or, when it published none, from our own sold tiers — in which case a size id **is** a plan code and the two collapse at order time. `can_order` is what lets a screen say *"this cannot be ordered yet"* instead of rendering a button that `422`s. `?target=` selects the range (Zinn® Cloud by default); a target that is not a compute product is `404`, never a `403`. `?org_id=` is required only of a caller who belongs to more than one organisation, and is `422` when omitted by one who does — picking "the first org in scope" would configure against an arbitrary tenant. Requires `sites.view`.
Parameters
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
target (query) | string | Nee | Which compute range to describe. Defaults to Zinn® Cloud, the branded product; the VPS range is the same seam with a different target. |
org_id (query) | Uuid | Nee | The organisation to configure against. Required only when the caller belongs to more than one; omitted, it is their own. |
Reactie
| Naam | Type | Verplicht | Wat dit is |
|---|---|---|---|
data | ComputeProvider[] | Ja | The platforms a machine can be placed on. |
tiers | ComputeTier[] | Ja | The tiers we sell on this range. |
can_order | boolean | Ja | Whether anything here can actually be ordered — any orderable tier, or any provider size. It exists so a screen can say *"this cannot be ordered yet"* instead of rendering a but… |
Fouten die dit eindpunt kan retourneren
401 · 403 · 404 · 422 · 429 · 503