प्रमाणीकरण

एपिआई कुञ्जीलाई बियरर टोकन (bearer token) को रूपमा पठाउनुहोस्। कुञ्जीसँग sites.view अनुमति हुनुपर्छ; अनुमति नभएको कुञ्जीलाई 404 होइन, 403 मार्फत अस्वीकार गरिन्छ।

तपाईंको संस्थाको आइडी राख्ने ठाउँ

यो इन्डपोटले JSON बडीमा एक फिल्डको रूपमा org_id लिन्छ।

तपाईंको संस्थाको आइडी (ID) तपाईंको ड्यासबोर्डमा रहेको API कुञ्जीहरू (keys) स्क्रिनमा, कुञ्जीको छेउमा हुन्छ। तपाईंले गर्ने प्रत्येक कलमा यही आइडी प्रयोग हुन्छ।

प्रयास गर्नुहोस्

कोणीय कोष्ठकभित्र भएका जुनसुकै कुरालाई आफ्नो मानहरूद्वारा बदल्नुहोस्, र मुख्य स्थानहोल्डरलाई तपाईंको ड्यासबोर्डको कुञ्जीद्वारा बदल्नुहोस्।

curl -X POST https://api.zinndigital.com/v1/compute/servers \
  -H "Authorization: Bearer zdk_live_…" \
  -H "Content-Type: application/json" \
  -d '{ "name": <string>, "zone": <string> }'

लगइन गर्नुभएको छ? तपाईंको ड्यासबोर्डमा रहेको API कन्सोलले तपाईंको वास्तविक संस्थाको आईडी र आफ्नै कुञ्जी भरिदिन्छ, र लाइभ API विरुद्ध अनुरोध चलाउँछ ताकि तपाईंले वास्तविक प्रतिक्रिया हेर्न सक्नुहोस्। यो एन्डपोइन्टलाई API कन्सोलमा खोल्नुहोस्

विवरणहरू

Buys a machine. 202 and the pending server: the purchase is durable and runs off the request path as a Temporal workflow (§2.9), so the client polls the returned server until status leaves provisioning. ⛔ The row is written first and the workflow started second. The reverse would mean a workflow whose row does not exist yet, and its first activity would fail on a race it can never win. The row's id is also the workflow id and the machine's name at the provider, which is what makes the whole path idempotent. If the workflow service cannot be reached the order is refused 503 with nothing charged — an acceptance is never fabricated, because the customer would watch a spinner for a server that was never ordered and then order it again. Send either spec or plan_code; neither is 422, not a 500. org_id is required only of a caller who belongs to more than one organisation, and naming one they cannot create in is 403. A size, zone or disk/bandwidth pair the provider does not offer, or a name already taken, is 422 in our wording. Requires sites.view and billing.entitlement.manage — ⛔ not sites.create, which is what this was until #1682. Ordering a machine charges Zinn®'s reseller balance immediately and bills nobody, so it is deliberately a STAFF key; sites.create is held by the customer dev role.

अनुरोध बडी

नामप्रकारआवश्यकयो के हो
namestringहुन्छWhat to call the machine. It is also the name at the provider, which is what lets a retried purchase find the machine it already bought instead of buying a second.
zonestringहुन्छThe data centre, as getComputeCatalogue reported it.
specstringहैनThe machine size, as the configurator reported it. ⭐ Either this or plan_code, not both — and where the provider publishes no sizes the two collapse into one, because the…
plan_codestringहैनThe tier to buy, for a catalogue-aware caller. Either this or spec.
org_idUuidहैनThe organisation to buy for. Required only when the caller belongs to more than one — picking "the first org in scope" would buy a server on an arbitrary tenant's balance.…
providerstringहैनWhich platform to place it on. Omitted, the engine resolves the range's default — ⛔ except on a range priced per data centre (ComputeTier.zoned), where omitting it is…
imagestringहैनThe operating system or one-click application the machine boots, as getComputeCatalogue reported it in ComputeProvider.images. ⛔ Required — 422 — on any range that publishes…
ssh_keysstring[]हैनThe ids of the authorised keys to install at build time, from listComputeSshKeys. ⛔⛔…
blueprintstring<, bare, docker, k3s, k3s_argocd>हैनW43-49 (docs/689). The software stack installed at first boot on a Zinn® Cloud machine: Docker Engine, single-machine k3s, or k3s with Argo CD. Refused on a range whose first…
term_monthsintegerहैनHow many months to buy up front. Outside 1…36 is refused 422 before a single vendor write, the same bound renewComputeServer applies.
optimisationstringहैनA stack optimisation profile, as the configurator reported it.
diskstringहैनAn explicit disk allocation, for a provider whose supports_disk_and_bandwidth is true. Sending it to one whose is false is refused.
bandwidthstringहैनAn explicit transfer allocation, for a provider whose supports_disk_and_bandwidth is true.

प्रतिक्रिया

नामप्रकारआवश्यकयो के हो
idUuidहुन्छOurs, and also the provisioning workflow's id and the machine's name at the provider — which is what makes the whole purchase path idempotent.
namestringहुन्छWhat the customer called it. ⛔ At the provider a machine's name is its row id; confusing the two is a cross-tenant defect, so this is the customer's string and nothing else.
deploy_targetstringहुन्छWhich compute range the machine belongs to.
plan_codestringहुन्छThe tier it was bought on, or "" when it was ordered by size alone.
providerstringहुन्छOur provider id.
specstringहुन्छThe machine size it currently runs.
zonestringहुन्छThe data centre it runs in.
statusstring<pending, provisioning, active, failed, suspended, terminated, resizing, terminating>हुन्छHow far the order got — ours, and a different fact from power_state. pending is a row with nothing bought and nothing charged; failed is the state whose message is the…
messagestringहुन्छWhy the order failed, in a sentence the customer reads. Blank unless failed.
vendor_statusstringहुन्छThe provider's own word, verbatim and unrounded. Staff-facing detail; a customer client renders status and never this.
power_statestring<unknown, on, off, starting, stopping, rebooting>हुन्छWhat the machine is doing right now. ⛔ Six values, not two, and the four extra ones are the point: a machine mid-transition is not "on". unknown is the honest answer when…
addressesstring[]हुन्छPublic addresses if the provider states them. Empty means not stated, never "none" — a machine rendered as having no address reads as broken.
optimisationstringहुन्छThe stack optimisation profile it was built with, or "" for none.
term_monthsintegerहुन्छThe term it was bought on, or null when the provider states none.
renews_atstringहुन्छAlways null today, and honestly so: the provider publishes no renewal date, and one computed from the order plus the term would be our arithmetic rendered as the provider's…
created_atstringहुन्छWhen the row was created, or "" when not stated.
operablebooleanहुन्छWhether the customer may act on this machine — power, resize, renew, rebuild. ⛔ Read rather than re-derived from status: the engine refuses every one of those on anything but…
imagestringहुन्छThe provider image the machine was built from. Blank on the resold range, which installs one managed image and offers no choice.
suspendedbooleanहुन्छ⛔⛔ Whether WE stopped it, which is not the same fact as power_state. A stopped machine is the customer's own choice and they may start it again; a suspended one is ours and…
suspension_reasonstringहुन्छWhy, verbatim, so the customer reads the same sentence support wrote. Blank when the machine is in good standing.
capabilitiesstring[]हुन्छ⭐⭐ What this machine's provider can actually do — capability tokens such as compute:snapshots, compute:console, compute:firewall, compute:backups_manage and…
billingComputeServerBillingहुन्छHow a machine is paid for (W43-47, docs/687). term machines are charged ahead by a per-machine subscription. metered machines are charged per started hour from the account…
login_userstringहुन्छThe account to sign in as (W43-49, docs/689). admin — key-only, passwordless sudo, root login refused — on a Zinn® Cloud machine built under the access model; root on one…
blueprintstring<, docker, k3s, k3s_argocd>हुन्छThe software stack installed at first boot. Blank for none.
cluster_idstringहुन्छThe cluster this machine is a node of, or blank.
cluster_rolestring<, server, agent>हुन्छ

यो इन्डपोइन्टले फर्काउन सक्ने त्रुटिहरू

401 · 403 · 404 · 422 · 429 · 503