Claves de API y ámbitos

Una clave de API da a un script o servicio acceso a su espacio de trabajo sin que una persona inicie sesión. Las claves llevan ámbitos, de modo que una clave puede limitarse a lo que necesita su tarea.

Cree una clave

Inicie sesión como administrador y abra API Keys.
Ponga nombre a la clave, elija sus ámbitos y, si lo desea, una caducidad en días.
Copie la clave cuando se muestre. Empieza por xcrt_ y no se puede volver a mostrar.

Solo un administrador con sesión iniciada puede crear o revocar una clave, y a una clave solo se le pueden dar ámbitos que posea su creador. Una clave nueva recibe certs:read salvo que elija otros.

Use una clave

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

Ámbitos

Ámbito	Permite
`certs:read`	Listar y leer certificados y sus desafíos.
`certs:write`	Solicitar, renovar, importar, revocar y eliminar certificados.
`targets:read`	Listar y leer destinos.
`targets:write`	Crear, modificar y eliminar destinos.
`deploy:read`	Leer despliegues.
`deploy:execute`	Ejecutar despliegues y gestionar reglas de despliegue.
`monitoring:read`	Leer resultados de monitorización.
`alerts:read`	Leer alertas.
`alerts:write`	Definir reglas de alerta y gestionar webhooks.
`audit:read`	Leer el registro de auditoría.

Lo que una clave con ámbito no puede hacer

Gestionar miembros, roles, claves de API, cuentas ACME y credenciales de nube requiere un administrador con sesión iniciada o una clave de acceso total. Una clave con ámbito recibe 403 insufficient_scope, incluso cuando su propietario es administrador. Algunas acciones de administrador, como ejecutar un escaneo de descubrimiento o una renovación masiva, aceptan una clave que tenga el ámbito correspondiente y pertenezca a un administrador.

Límites

Cada plan permite un número fijo de claves. Las solicitudes están limitadas a 120 por minuto por espacio de trabajo.