Management reference

Scope#

The management API is the write side of the CDN. Everything that creates work or changes what is live goes through it, with an authenticated member of an organization. It follows the protocol beyond-cdn-management/1, and every path starts with /v1.

Pages#

• Authentication and conventions — Conventions of the management API: bearer authentication, roles and capabilities, idempotent mutations, pagination and the error envelope.
• Applications and targets — Create and change applications, choose their visibility, loader mode and source map policy, define their frontend and backend targets, and bind an application to a Beyond project.
• Registration and the pinned graph — Stage 1. Register dependency selections and let the CDN pin the complete package and version graph from metadata, then review graphs, diffs and update notices.
• Preparation and inventory — Stages 2 and 3. Prepare a candidate release from a pinned registration, inspect the inventory of what is reachable, and understand readiness.
• Jobs — Durable jobs of the three stages: states, stage progress, queue position, turns and limits, cancellation, retries, logs and failure codes.
• Releases, promotion and rollback — Immutable releases and their states, binding the production and testing environments with a compare-and-set, rolling back to a retained release, and retiring.
• Domains — Reserve the single free testing subdomain of an application, add custom domains and verify their ownership with a DNS TXT record.
• Access and guests — Read the access policy of an application, invite external guests with expiring application-scoped grants, and revoke them.
• Plans, credit and usage — Read the plan and entitlements of an organization, its credit balance and ledger, its measured usage by category, and join the premium waitlist.
• Quotas — The configurable limits on packages and bytes per application and organization, how logical use is counted, and what happens when a limit is reached.