Skip to content

API Keys

Onderhouden door: Aether365 Team Doelgroep: Ontwikkelaars Scope: API key-beheer endpoints

API keys worden gebruikt om verzoeken aan de REST API te authenticeren zonder een gebruikerssessie.

Elke API key is gekoppeld aan het tenantaccount dat deze heeft aangemaakt. API keys hebben dezelfde toegang als een teamlid - ze kunnen alle tenantgegevens lezen en schrijven, maar kunnen geen facturering of abonnementsinstellingen wijzigen.

API Keys ophalen

Retourneert alle actieve API keys voor de tenant.

GET /tenants/me/api-keys

INFO

Om veiligheidsredenen wordt de volledige sleutelwaarde slechts eenmaal geretourneerd - bij het aanmaken. Opvolgende lijstverzoeken tonen alleen het sleutelprefix en metadata.

Voorbeeldverzoek

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

Voorbeeldresponse

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

Responsevelden

VeldTypeBeschrijving
idstringSleutelidentificatie
namestringWeergavenaam
prefixstringEerste 12 tekens van de sleutel (ter identificatie)
createdAtstringISO 8601-tijdstempel
lastUsedAtstring of nullISO 8601-tijdstempel van het laatste geauthenticeerde verzoek

Een API Key aanmaken

Maakt een nieuwe API key aan. De volledige sleutelwaarde wordt eenmalig geretourneerd en kan niet opnieuw worden opgehaald.

POST /tenants/me/api-keys

Verzoekbody

json
{
  "name": "CI pipeline"
}
VeldTypeVereistBeschrijving
namestringJaWeergavenaam voor de sleutel

Voorbeeldverzoek

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"}'

Voorbeeldresponse

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
  }
}

Sla de sleutel direct op

Het key-veld wordt alleen in deze response geretourneerd. Het kan later niet worden opgehaald. Sla het direct op in een secrets manager (GitHub Actions secrets, HashiCorp Vault, etc.).


Een API Key verwijderen

Trekt een API key permanent in. Verzoeken met deze sleutel retourneren onmiddellijk 401.

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

Voorbeeldverzoek

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

Voorbeeldresponse

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

Een API Key gebruiken

Geef de API key door als Bearer token in de Authorization-header:

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

API keys werken op dezelfde manier als sessietokens voor alle endpoints. Ze verlopen niet, maar je kunt ze roteren door een nieuwe sleutel aan te maken en de oude te verwijderen.

Snelheidslimieten

De API is beperkt tot 120 verzoeken per minuut per API key. Verzoeken die de snelheidslimiet overschrijden ontvangen een 429 Too Many Requests-response. De response bevat een Retry-After-header die aangeeft wanneer je het opnieuw kunt proberen.

Was deze pagina nuttig?