Skip to content

API-nøgler

API-nøgler bruges til at autentificere forespørgsler til REST API'et uden en brugersession.

Hver API-nøgle er bundet til den tenant-konto, der oprettede den. API-nøgler har samme adgang som et teammedlem - de kan læse og skrive alle tenant-data, men kan ikke ændre fakturerings- eller planindstillinger.

List API-nøgler

Returnerer alle aktive API-nøgler for tenanten.

GET /tenants/me/api-keys

INFO

Af sikkerhedshensyn returneres den fulde nøgleværdi kun en gang - ved oprettelsen. Efterfølgende listeforespørgsler viser kun nøglepræfikset og metadata.

Eksempel på forespørgsel

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

Eksempel på svar

json
{
  "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"
    }
  ]
}

Svarfelter

FeltTypeBeskrivelse
idstringNøgleidentifikator
namestringVisningsnavn
prefixstringFørste 12 tegn af nøglen (til identifikation)
createdAtstringISO 8601-tidsstempel
lastUsedAtstring eller nullISO 8601-tidsstempel for sidste autentificerede forespørgsel

Opret en API-nøgle

Opretter en ny API-nøgle. Den fulde nøgleværdi returneres en gang og kan ikke hentes igen.

POST /tenants/me/api-keys

Forespørgselsindhold

json
{
  "name": "CI pipeline"
}
FeltTypePåkrævetBeskrivelse
namestringJaVisningsnavn for nøglen

Eksempel på forespørgsel

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

Eksempel på svar

json
{
  "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
  }
}

Gem nøglen med det samme

key-feltet returneres kun i dette svar. Det kan ikke hentes senere. Gem den i en secrets manager (GitHub Actions secrets, HashiCorp Vault osv.) med det samme.


Slet en API-nøgle

Tilbagekalder permanent en API-nøgle. Alle forespørgsler, der bruger denne nøgle, vil returnere 401 med det samme.

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

Eksempel på forespørgsel

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

Eksempel på svar

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

Brug af en API-nøgle

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

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

API-nøgler fungerer på samme måde som sessionstokens for alle endpoints. De udløber ikke, men du kan rotere dem ved at oprette en ny nøgle og slette den gamle.

Ratebegrænsninger

API'et er ratebegrænset til 120 forespørgsler per minut per API-nøgle. Forespørgsler, der overskrider ratebegrænsningen, modtager et 429 Too Many Requests-svar. Svaret inkluderer en Retry-After-header, der angiver, hvornår du kan prøve igen.

Var denne side nyttig?