Skip to content
Catalyst Networks

API Reference

The Catalyst Networks API provides programmatic access to all platform features. The API uses JWT authentication and returns JSON responses.

Base URL

https://app.catalystnetworks.io/api/

Authentication

JWT Token

Obtain a token pair:

Terminal window
curl -X POST https://app.catalystnetworks.io/api/token/ \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com", "password": "your-password"}'

Response:

{
  "access": "eyJ...",
  "refresh": "eyJ..."
}

Use the access token in subsequent requests:

Authorization: Bearer eyJ...

Node API Token

Nodes receive an API token during registration. It is an opaque URL-safe base64 string (generated server-side with secrets.token_urlsafe(32)) — there is no fixed prefix. Use it the same way:

Authorization: Bearer 8xK2p-QeR7mNvZ3sLtY0aB9cD1fG4hJ6kW5nX8uV2oP

Endpoints

Authentication

MethodEndpointDescription
POST/api/token/Obtain JWT token pair
POST/api/token/refresh/Refresh access token

Organizations

MethodEndpointDescription
GET/api/org/List organizations

Nodes

MethodEndpointDescription
GET/api/org/{slug}/nodes/List nodes
POST/api/org/{slug}/nodes/Create a node
GET/api/org/{slug}/nodes/{id}/Get node details
PATCH/api/org/{slug}/nodes/{id}/Update a node
POST/api/org/{slug}/nodes/register/Register a new node
GET/api/org/{slug}/nodes/{id}/download_config/Download node config
POST/api/org/{slug}/nodes/{id}/renew_cert/Renew node certificate
POST/api/org/{slug}/nodes/{id}/checkin/Node check-in

For the full OpenAPI specification, see the Swagger UI (requires staff access).