Guardian API

REST API for VeilNet Guardian—authentication, registration tokens, realms, and Conflux management.

Overview

The VeilNet Guardian API is a REST API that powers the Guardian authentication and management service. Use it to create registration tokens, manage realms, and register Conflux nodes programmatically.

Interactive documentation: https://guardian.veilnet.app/docs

Key Endpoints

Authentication

Method	Endpoint	Description
`POST`	`/auth/login`	User login (email/password). Returns OAuth2 access token.
`GET`	`/auth/profile`	Get authenticated user profile (requires bearer token).

Registration Tokens

Method	Endpoint	Description
`POST`	`/auth/create/registration-token`	Create a registration token (requires OAuth2 bearer token).
`GET`	`/auth/list/registration-token`	List your registration tokens.
`DELETE`	`/auth/revoke/registration-token`	Revoke a registration token by ID.

Conflux Registration

Method	Endpoint	Description
`POST`	`/conflux/register`	Register a Conflux node. Send registration token as `Authorization: Bearer <token>`.
`DELETE`	`/conflux/unregister`	Unregister a Conflux node (requires registration token).

Typical Flow

Login — POST /auth/login with email/password to get an access token.
Create registration token — POST /auth/create/registration-token with the access token and realm_id.
Register Conflux — POST /conflux/register with the registration token as Bearer auth.

For full request/response schemas and additional endpoints (realms, conflux list, teams, etc.), see the Guardian API docs.

Registration Token

Long-lived JWT for registering Conflux nodes

Data Flow

Egress, ingress, relay flows in the Anchor Protocol