API-referentie
Gebruik API-bewerkingen en interpreteer de resultaten
Lees de beschikbare endpoints, idempotentieregels, reacties op in wachtrij geplaatste acties en huidige limieten voor het volgen van bewerkingen.
Op deze pagina
Voordat u begint
- Een geldige sessie en, voor beveiligde wijzigingen, het bijbehorende CSRF-token.
- Identificaties overgenomen uit de huidige catalogus of geauthenticeerde API-reacties.
- Een unieke Idempotency-Key voor elke bestelling, opname of hardwareactie.
Lees het account voordat u het wijzigt
Gebruik de read-eindpunten om het account, het saldo en de doelresource te bevestigen. GET /api/v1/me retourneert username, balanceUsd en de csrfToken van de sessie. Resource-ID's zijn accountgebonden; gebruik de server- of netwerk-ID die voor het huidige account wordt geretourneerd in plaats van een waarde uit een andere omgeving te kopiëren.
De huidige API is een compacte accountinterface, geen compleet asynchroon taakplatform. Bewaar referenties van succesvolle schrijfacties in uw eigen administratie. Er is geen endpoint om elke bestelling te vermelden, een specifieke wachtrijactie te inspecteren of de laatste beoordelingsstatus van een opname op te halen.
| Lees endpoint | Geretourneerde gegevens |
|---|---|
| GET /api/v1/ledger | De nieuwste 100 grootboekitems, nieuwste eerst; geen pagineringscontract. |
| GET /api/v1/servers | Niet-beëindigde servers, status, regio, paidThrough, graceUntil en autoRenew. |
| GET /api/v1/network | Toegewezen adressen, prefixlengtes, PTR-waarden en gerelateerde serveridentificaties. |
| GET /api/health | Basis service- en catalogusaantallen; geen garantie voor account- of fysieke servergezondheid. |
Gebruik het bijbehorende wijzigingseindpunt
Ondersteunde serveracties zijn reboot, power_off, reinstall, mount_iso, kvm en rotate_root_password. Een aangepaste ISO-URL moet openbare HTTPS gebruiken zonder ingesloten inloggegevens. De ordertermijn is wekelijks of maandelijks, wat neerkomt op zeven of dertig dagen. Prijs, kortingen, tegoeden en capaciteit worden door de service gecontroleerd; stuur geen door de client berekende prijs als autoriteit.
| Eindpunt | Verzoekvelden en resultaat |
|---|---|
| POST /api/v1/orders | configId, regionId, osId, term, quantity; optioneel sshPublicKey. Retourneert order-id en ACCEPTED. |
| POST /api/v1/deposit-addresses | asset. Retourneert adres, asset, netwerk, confirmationsRequired en modus, of een fout 'settlement-unavailable'. |
| POST /api/v1/withdrawals | asset, bestemming, usd. Retourneert id en PENDING_REVIEW; saldo wordt vastgehouden. |
| POST /api/v1/servers/{id}/actions | actie; isoUrl voor mount_iso. Retourneert actie-ID en QUEUED. |
| PUT /api/v1/servers/{id}/ddos | modus: BASELINE of ADVANCED. Retourneert QUEUED of UNCHANGED en quoteRequired. |
| PUT /api/v1/network/{id}/rdns | ptr, of een lege waarde om deze te wissen. Retourneert de opgeslagen PTR-waarde. |
Maak nieuwe pogingen weloverwogen
Bestellingen, opnames, serveracties en DDoS-verzoeken vereisen een Idempotency-Key. Gebruik 8–100 letters, cijfers, koppeltekens of underscores en wijs een nieuwe sleutel toe aan elke afzonderlijke beoogde bewerking. Bewaar de oorspronkelijke sleutel, resource en payload voordat u verzendt, zodat een onzekere reactie kan worden onderzocht.
Bestellingen kunnen het bestaande resultaat voor dezelfde sleutel en genormaliseerd verzoek opnieuw afspelen; gewijzigde besteldetails produceren een conflict. Serveractie-replays retourneren de bestaande actie wanneer compatibel. Houd actiesleutels uniek voor alle servers in het account. Opnames melden een conflict wanneer al geregistreerd in plaats van het oorspronkelijke verzoek als succes te retourneren.
POST /api/v1/servers/{serverId}/actions HTTP/1.1
Content-Type: application/json
x-csrf-token: <current-session-token>
Idempotency-Key: <unique-operation-key>
Cookie: <current-session-cookies>
{"action":"reboot"}Onderscheid acceptatie van voltooiing
Een 202 QUEUED-reactie bevestigt dat een hardwareverzoek is vastgelegd. Deze bevat geen werkende KVM-URL, geen vervangend rootwachtwoord en geen bewijs dat de machine opnieuw is opgestart. ACCEPTED registreert eveneens een bestelling die de provisioning ingaat; PENDING_REVIEW registreert een opname die wacht op beoordeling door een operator. Bewaar de geretourneerde identificatie wanneer u naar de uitvoering vraagt.
Er is geen pollingroute voor actiestatus in deze versie. Lees de server- of netwerkgegevens opnieuw waar relevant en verkrijg operatorbevestiging voor fysieke effecten. Een opgeslagen PTR- of DDoS-voorkeur alleen is geen meting van openbare DNS of live netwerkbeveiliging.
Reageer op storingen zonder werk te dupliceren
- 400 validatiefout: corrigeer de gedocumenteerde velden voordat u opnieuw indient.
- 401 of 403: repareer sessieauthenticatie of CSRF-verificatie voordat u opnieuw probeert.
- 404: verifieer dat de resource-identificatie behoort tot het aangemelde account.
- 409: inspecteer de foutcode; onvoldoende saldo, uitgeputte capaciteit en idempotentieconflicten vereisen verschillende reacties.
- 502 of 503 bij stortingen: er is geen bruikbaar nieuw adres geretourneerd; start geen overdracht.
- Time-out of onleesbaar antwoord: controleer beschikbare accountgegevens en bewaar de oorspronkelijke aanvraagdetails. Maak niet blindelings een nieuwe operatiesleutel aan.