Ga naar inhoud

API-sleutels

Beheer API-sleutels voor de geauthenticeerde gebruiker.

Deze endpoints zijn niet beschikbaar via OAuth — ze vereisen een sessie- of API-sleutel-credential. De sleutelwaarde (token) wordt alleen teruggegeven wanneer de sleutel wordt aangemaakt; daarna wordt hij nooit meer teruggegeven.

In de browser beheer je je persoonlijke API-sleutels onder API-sleutels in je accountinstellingen. De onderstaande endpoints beheren dezelfde sleutels.

Elke sleutel kan een IP-toegangslijst (allowed_ips) hebben. Een lege lijst betekent dat elk adres de sleutel mag gebruiken; anders wordt een verzoek vanaf een adres buiten de lijst behandeld als een verzoek met een ongeldige sleutel.


API-sleutels opvragen

GET /api/api_keys

Teruggegeven params
  • api_keys: Array<Object>
    • id: Integer
    • name: String
    • allowed_ips: Array<String> | de toegangslijst van de sleutel, elk item een adres of CIDR-bereik; leeg als er geen beperking is
    • created_at: DateTime
    • updated_at: DateTime

Een API-sleutel bekijken

GET /api/api_keys/:id

Teruggegeven params
  • api_key: Object
    • id: Integer
    • name: String
    • allowed_ips: Array<String> | de toegangslijst van de sleutel, elk item een adres of CIDR-bereik; leeg als er geen beperking is
    • created_at: DateTime
    • updated_at: DateTime

Een API-sleutel aanmaken

POST /api/api_keys

Aangemaakte sleutels zijn altijd niet-admin en niet systeembeheerd.

Params
  • api_key: Object
    • name: String
    • allowed_ips: Array<String> | optioneel. IPv4- of IPv6-adressen of CIDR-bereiken, maximaal 20. Een enkele string met items gescheiden door nieuwe regels, komma's, puntkomma's of spaties wordt ook geaccepteerd.
Fouten
  • 422 invalid_api_key | de sleutel is niet geldig (bijvoorbeeld een lege name)
  • 422 invalid_allowed_ips | een item is geen geldig adres of bereik; er wordt niets opgeslagen
  • 422 too_many_allowed_ips | meer dan 20 items
Teruggegeven params
  • api_key: Object
    • id: Integer
    • name: String
    • token: String | Wordt alleen bij het aanmaken teruggegeven — sla hem nu op.
    • allowed_ips: Array<String>
    • created_at: DateTime
    • updated_at: DateTime

Een API-sleutel hernoemen of de IP-toegangslijst wijzigen

PATCH /api/api_keys/:id

Laat allowed_ips weg om de lijst ongewijzigd te laten. Een lijst meesturen vervangt hem; een lege array of lege string wist hem, zodat elk adres de sleutel mag gebruiken. Eén ongeldig item laat het hele verzoek mislukken en er wordt niets gewijzigd. Geeft de sleutel terug in dezelfde structuur als Een API-sleutel bekijken, met dezelfde fouten als Een API-sleutel aanmaken.

Params
  • api_key: Object
    • name: String
    • allowed_ips: Array<String> | optioneel; zie hierboven

Een API-sleutel verwijderen

DELETE /api/api_keys/:id

Geeft 202 terug.