Webhotell-API

Denne siden dekker domenene på en webhotellkonto og PHP-versjonen for hvert domene. Alle endepunkter krever Bearer-token-autentisering. En API-nøkkel trenger tilgang til Webhotell, med lese- og skrivetilgang for endringer. Underkunder kan lese, men ikke endre domener eller PHP-versjoner. Panelsiden er beskrevet i Domener.

En suspendert konto svarer på alle endepunktene under, unntatt GET /webhosting/{id}, med 403 Hosting account is suspended. Contact support.

GET /webhosting/{id}

Returnerer kontoen. domains lister alle domenene på kontoen, primærdomenet først:

{
  "data": {
    "hosting_id": 321,
    "domain": "example.com",
    "domains": [
      { "domain": "example.com", "zone_id": 966, "primary": true },
      { "domain": "example.no", "zone_id": 967, "primary": false }
    ]
  }
}

domain er primærdomenet. zone_id er DNS-sonen til domenet, eller 0 hvis sonen ikke finnes lenger.

Velge domene: ?domain=

Hvert domene har egen nettsidemappe, e-post og SSL-sertifikat. Endepunktene under /webhosting/{id}/... gjelder primærdomenet med mindre du legger til ?domain=<navn>:

curl "https://api.gigahost.no/api/v0/webhosting/321/php?domain=example.no" \
  -H "Authorization: Bearer $TOKEN"

Et domene som ikke ligger på kontoen, gir 404 Domain not found on this hosting account., også på endepunkter som ikke gjelder ett domene.

POST /webhosting/{id}/domains

Legg et domene til kontoen. Domenet må finnes som en DNS-sone på kontoen din og kan ikke allerede ligge på en webhotellkonto.

Felt	Type	Påkrevd	Beskrivelse
zone_id	number	Ja	Sonen til domenet, fra GET /dns/zones.
update_dns	number	Nei	1 for å skrive postene for nettside og e-post inn i sonen. Standard 0.

curl -X POST https://api.gigahost.no/api/v0/webhosting/321/domains \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"zone_id": 967, "update_dns": 1}'

Returnerer 201 med domain, zone_id, dns_updated og records. records lister det domenet trenger: A (og AAAA hvis serveren har IPv6) for @, ftp, mail, smtp og www, en MX til mail.<domene>. med prioritet 10, en SPF- og en DMARC-TXT, og DKIM-TXT-en når DKIM er på.

Med update_dns satt og sonen på Gigahost sine navneservere erstatter disse postene de eksisterende A/AAAA-postene på de fem navnene og MX på roten. En eksisterende SPF-post erstattes, andre TXT-poster beholdes, og en eksisterende DMARC-post røres ikke. Ellers er dns_updated false: legg inn records hos DNS-leverandøren din.

Status	meta.message
400	Missing required field: zone_id
404	Domain not found or does not belong to your account.
409	This domain is already on a webhosting account.
500	Failed to add domain: …

PUT /webhosting/{id}/domains/{domain}/primary

Gjør et domene til primærdomene. Kontoen vises med dette domenet, og public_html peker til det. Hvert domene beholder sin egen mappe og e-post.

Returnerer 200 med domain. Feil: 400 This domain is already the primary domain., 500 Failed to change primary domain: …

DELETE /webhosting/{id}/domains/{domain}

Fjern et domene fra kontoen.

ADVARSEL

Filene, e-postkontoene og underdomenene til domenet slettes fra serveren og kan ikke gjenopprettes. DNS-sonen og postene i den blir stående som de er.

Primærdomenet kan ikke fjernes: 400 The primary domain cannot be removed. Make another domain primary first. Andre feil: 404 Domain not found on this hosting account., 500 Failed to remove domain: …

GET /webhosting/{id}/php

PHP-versjonen til et domene og versjonene det kan bytte til, nyeste først. Bruk ?domain= for et annet domene enn primærdomenet.

{
  "data": {
    "php": { "current": "8.3", "versions": ["8.4", "8.3", "8.2"] }
  }
}

versions er tom når serveren ikke tilbyr noe valg.

PUT /webhosting/{id}/php

Felt	Type	Beskrivelse
version	string	En av versions, for eksempel 8.3.

curl -X PUT "https://api.gigahost.no/api/v0/webhosting/321/php?domain=example.no" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"version": "8.3"}'

Returnerer 200 med php. Feil: 400 Missing required field: version, 400 Unsupported PHP version., 500 Failed to change PHP version: …