Automate Certificates Dokumentation
API-Schlüssel und Scopes
Ein API-Schlüssel gibt einem Skript oder Dienst Zugriff auf Ihren Workspace, ohne dass sich eine Person anmeldet. Schlüssel tragen Scopes, sodass ein Schlüssel auf das beschränkt werden kann, was seine Aufgabe braucht.
Schlüssel anlegen
- Melden Sie sich als Admin an und öffnen Sie API-Schlüssel.
- Benennen Sie den Schlüssel, wählen Sie seine Scopes und, falls gewünscht, ein Ablaufdatum in Tagen.
- Kopieren Sie den Schlüssel, wenn er angezeigt wird. Er beginnt mit
xcrt_und kann nicht erneut angezeigt werden.
Nur ein angemeldeter Admin kann einen Schlüssel anlegen oder widerrufen, und ein Schlüssel kann nur Scopes erhalten, die sein Ersteller selbst besitzt. Ein neuer Schlüssel erhält certs:read, sofern Sie keine anderen wählen.
Schlüssel verwenden
curl -H "Authorization: Bearer xcrt_your_key" \
https://api.automate-certificates.com/v1/certificatesScopes
| Scope | Erlaubt |
|---|---|
certs:read | Zertifikate und ihre Challenges auflisten und lesen. |
certs:write | Zertifikate anfordern, erneuern, importieren, widerrufen und löschen. |
targets:read | Ziele auflisten und lesen. |
targets:write | Ziele anlegen, ändern und löschen. |
deploy:read | Bereitstellungen lesen. |
deploy:execute | Bereitstellungen ausführen und Bereitstellungsregeln verwalten. |
monitoring:read | Überwachungsergebnisse lesen. |
alerts:read | Warnungen lesen. |
alerts:write | Warnregeln festlegen und Webhooks verwalten. |
audit:read | Das Audit-Log lesen. |
Was ein bereichsbezogener Schlüssel nicht kann
Das Verwalten von Mitgliedern, Rollen, API-Schlüsseln, ACME-Konten und Cloud-Zugangsdaten erfordert einen angemeldeten Admin oder einen Schlüssel mit vollem Zugriff. Ein bereichsbezogener Schlüssel wird mit 403 insufficient_scope abgelehnt, auch wenn sein Besitzer Admin ist. Einige Admin-Aktionen, etwa ein Discovery-Scan oder eine Massenerneuerung, akzeptieren einen Schlüssel, der den passenden Scope besitzt und einem Admin gehört.
Limits
Jeder Tarif erlaubt eine feste Anzahl von Schlüsseln. Anfragen sind auf 120 pro Minute für einen Workspace begrenzt.