API-oversikt

Gigahost API er et JSON REST-API for det du gjør i Flux: servere, DNS, domener, BGP, fakturering og kontoen din.

API-et er også dokumentert på nettsiden vår, gigahost.no/api-dokumentasjon.

Base-URL

https://api.gigahost.no/api/v0

Legg ressursbanen til etter base-URLen, for eksempel https://api.gigahost.no/api/v0/servers.

Autentisering

Send et bearer-token fra POST /authenticate, eller en API-nøkkel, i Authorization-headeren. Se Autentisering.

Forespørselsformat

• Alle POST- og PUT-forespørsler må sende en JSON-kodet body og Content-Type: application/json, med mindre endepunktet sier noe annet (POST /bgp/asn er form-kodet).
• Import av BIND-sonefil tar multipart/form-data.
• URL-kod spesialtegn i path-parametere. Brukernavn er e-postadresser, så + blir %2B og @ blir %40.

Responsformat

Hvert JSON-svar pakker payloaden i en meta-konvolutt:

{
  "meta": {
    "status": 200,
    "status_message": "200 OK"
  },
  "data": {
    "...": "..."
  }
}

Noen endepunkter returnerer resultatfeltene sine i meta i stedet for data; referansesidene viser hvilke.

Feilformat

Feil har samme form, med en statuskode utenfor 2xx og en message:

{
  "meta": {
    "status": 400,
    "status_message": "400 Bad Request",
    "message": "ASN is not valid"
  }
}

Vanlige HTTP-statuskoder:

Kode	Betydning
200	OK
201	Created
400	Bad Request: validering av payload eller parameter feilet
401	Unauthorized: manglende eller ugyldig token
403	Forbidden: tokenet er gyldig, men gir ikke tilgang til ressursen
404	Not Found
500	Server Error

Postman-samling

Postman v2.1-samlingen har alle endepunktene på disse sidene.

1. Last ned gigahost-api.postman_collection.json og importer den i Postman.
2. Sett samlingsvariablene username og password til påloggingen din hos Gigahost.
3. Kjør Authentication → Authenticate én gang. Den lagrer tokenet i , og alle andre forespørsler bruker det.

Sett server_id, zone_id og asn_id for å peke forespørslene mot dine egne ressurser.