Referencia de administración

Alcance#

La API de administración es el lado de escritura del CDN. Todo lo que crea trabajo o cambia lo que está activo pasa por ella, con un miembro autenticado de una organización. Sigue el protocolo beyond-cdn-management/1, y todas las rutas comienzan con /v1.

Páginas#

• Autenticación y convenciones — Convenciones de la API de administración: autenticación con bearer, roles y capacidades, mutaciones idempotentes, paginación y el sobre de error.
• Aplicaciones y targets — Crea y cambia aplicaciones, elige su visibilidad, su modo de carga y su política de source maps, define sus targets de frontend y de backend, y vincula una aplicación a un proyecto de Beyond.
• El registro y el grafo fijado — Etapa 1. Registra las selecciones de dependencias y deja que el CDN fije el grafo completo de paquetes y versiones a partir de metadatos; luego revisa grafos, diferencias y avisos de actualización.
• Preparación e inventario — Etapas 2 y 3. Prepara un release candidato a partir de un registro fijado, inspecciona el inventario de lo que es alcanzable y entiende cuándo un release está listo.
• Trabajos — Los trabajos durables de las tres etapas: estados, progreso por etapa, posición en la cola, turnos y límites, cancelación, reintentos, registros y códigos de fallo.
• Releases, promoción y reversión — Los releases inmutables y sus estados, cómo vincular los entornos de producción y de pruebas con una operación de comparar y establecer, cómo revertir a un release retenido y cómo retirar uno.
• Dominios — Reserva el único subdominio de pruebas gratuito de una aplicación, agrega dominios propios y verifica su titularidad con un registro DNS TXT.
• Acceso e invitados — Lee la política de acceso de una aplicación, invita a personas externas con permisos que vencen y se limitan a una aplicación, y revócalos.
• Planes, crédito y consumo — Lee el plan y las habilitaciones de una organización, su saldo y su libro de crédito, su consumo medido por categoría, y entra en la lista de espera de premium.
• Cuotas — Los límites configurables de paquetes y bytes por aplicación y por organización, cómo se cuenta el uso lógico y qué ocurre cuando se alcanza un límite.