API-nøkler

Vedlikeholdt av: Aether365 Team Malgruppe: Utviklere Omfang: Endepunkter for administrasjon av API-nøkler

API-nøkler brukes til å autentisere forespørsler til REST API uten en brukersesjon.

Hver API-nøkkel er bundet til leietakerkontoen som opprettet den. API-nøkler har samme tilgang som et teammedlem - de kan lese og skrive all leietakerdata, men kan ikke endre fakturering eller planinnstillinger.

Liste over API-nøkler

Returnerer alle aktive API-nøkler for leietakeren.

GET /tenants/me/api-keys

INFO

Av sikkerhetsgrunner returneres den fullstendige nøkkelverdien kun en gang - ved opprettelse. Pafølgende listeforesporsler viser kun nøkkelprefikset og metadata.

Eksempelforespørsel

curl https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>"

Eksempelrespons

{
  "success": true,
  "data": [
    {
      "id": "key_abc123",
      "name": "CI pipeline",
      "prefix": "ae_live_abc1",
      "createdAt": "2026-03-01T09:00:00Z",
      "lastUsedAt": "2026-04-10T14:23:00Z"
    }
  ]
}

Responsfelt

Felt	Type	Beskrivelse
id	string	Nokkelidentifikator
name	string	Visningsnavn
prefix	string	Første 12 tegn av nøkkelen (for identifisering)
createdAt	string	ISO 8601-tidsstempel
lastUsedAt	string eller null	ISO 8601-tidsstempel for siste autentiserte forespørsel

---

Opprett en API-nøkkel

Oppretter en ny API-nøkkel. Den fullstendige nøkkelverdien returneres en gang og kan ikke hentes igjen.

POST /tenants/me/api-keys

Forespørselsbrødtekst

{
  "name": "CI pipeline"
}

Felt	Type	Pakrevd	Beskrivelse
name	string	Ja	Visningsnavn for nøkkelen

Eksempelforespørsel

curl -X POST https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "CI pipeline"}'

Eksempelrespons

{
  "success": true,
  "data": {
    "id": "key_abc123",
    "name": "CI pipeline",
    "key": "ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "prefix": "ae_live_abc1",
    "createdAt": "2026-04-12T10:00:00Z",
    "lastUsedAt": null
  }
}

Lagre nøkkelen umiddelbart

key-feltet returneres kun i denne responsen. Det kan ikke hentes senere. Lagre det i en hemmelighetsbehandler (GitHub Actions secrets, HashiCorp Vault osv.) umiddelbart.

---

Slett en API-nøkkel

Tilbakekaller permanent en API-nøkkel. Alle forespørsler som bruker denne nøkkelen vil returnere 401 umiddelbart.

DELETE /tenants/me/api-keys/{keyId}

Eksempelforespørsel

curl -X DELETE https://api.aether365.io/tenants/me/api-keys/key_abc123 \
  -H "Authorization: Bearer <token>"

Eksempelrespons

{
  "success": true,
  "data": null
}

---

Bruke en API-nøkkel

Send API-nøkkelen som et Bearer-token i Authorization-headeren:

curl https://api.aether365.io/tenants/me/scans \
  -H "Authorization: Bearer ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

API-nøkler fungerer på samme måte som sesjonstokener for alle endepunkter. De utløper ikke, men du kan rotere dem ved å opprette en ny nøkkel og slette den gamle.

Hastighetsgrenser

APIet har en hastighetsgrense på 120 forespørsler per minutt per API-nøkkel. Forespørsler som overskrider hastighetsgrensen mottar en 429 Too Many Requests-respons. Responsen inkluderer en Retry-After-header som angir når du kan prøve igjen.