API

The Nucleus HTTP API lets you automate against the control plane: list and create spokes, query backup status, manage federation members, rotate tokens.

v0 — unstable

The API is currently versioned v0. We may make breaking changes with 30 days' notice via the changelog and an email to all customers with active tokens. A stable v1 will lock the surface once we have customer signal on what should and shouldn't be in it.

Where to start

• Authentication — bearer tokens
• Rate limits
• Errors — shape of an error response
• Versioning — what v0 means
• Reference — every endpoint