API-sleutels en scopes

Een API-sleutel geeft een script of service toegang tot uw workspace zonder dat iemand inlogt. Sleutels hebben scopes, zodat een sleutel kan worden beperkt tot wat zijn taak vereist.

Een sleutel maken

Log in als beheerder en open API-sleutels.
Geef de sleutel een naam, kies de scopes en, als u wilt, een vervaltermijn in dagen.
Kopieer de sleutel zodra hij wordt getoond. Hij begint met xcrt_ en kan niet opnieuw worden getoond.

Alleen een ingelogde beheerder kan een sleutel maken of intrekken, en een sleutel kan alleen scopes krijgen die de maker zelf heeft. Een nieuwe sleutel krijgt certs:read tenzij u andere kiest.

Een sleutel gebruiken

curl -H "Authorization: Bearer xcrt_your_key" \
     https://api.automate-certificates.com/v1/certificates

Scopes

Scope	Staat toe
`certs:read`	Certificaten en hun challenges weergeven en lezen.
`certs:write`	Certificaten aanvragen, verlengen, importeren, intrekken en verwijderen.
`targets:read`	Targets weergeven en lezen.
`targets:write`	Targets maken, wijzigen en verwijderen.
`deploy:read`	Implementaties lezen.
`deploy:execute`	Implementaties uitvoeren en implementatieregels beheren.
`monitoring:read`	Monitoringresultaten lezen.
`alerts:read`	Meldingen lezen.
`alerts:write`	Meldingsregels instellen en webhooks beheren.
`audit:read`	Het auditlogboek lezen.

Wat een sleutel met beperkte scopes niet kan

Het beheren van leden, rollen, API-sleutels, ACME-accounts en cloudinloggegevens vereist een ingelogde beheerder of een sleutel met volledige toegang. Een sleutel met beperkte scopes wordt geweigerd met 403 insufficient_scope, ook als de eigenaar beheerder is. Enkele beheeracties, zoals het uitvoeren van een discoveryscan of een bulkverlenging, accepteren een sleutel die de bijbehorende scope heeft en van een beheerder is.

Limieten

Elk abonnement staat een vast aantal sleutels toe. Verzoeken zijn beperkt tot 120 per minuut per workspace.