Node and setup

OpenAPI document for this node

GET /api/v1/openapi.json

This document, as the node serves it. Needs no sign-in.

Who may call it: None: anyone may call it.

Response (200, JSON):

Field	Type	Required	Notes
(body)	object	yes

Errors: 400, 401, 403, 404, 429, as described in errors.

curl -X GET "https://node.example.com/api/v1/openapi.json"

Claim the owner account with a setup token

POST /api/v1/setup

Claims a new node: creates the owner account with the one-time token from the setup link (cloudoak setup-link), and signs it in.

Who may call it: None: anyone may call it.

Request body (JSON):

Field	Type	Required	Notes
email	string	yes
name	string	yes
password	string	yes
token	string	yes
username	string	yes

Response (200, JSON):

Field	Type	Required	Notes
csrfToken	string	yes
user	object	yes
user.createdAt	string	yes
user.email	string	yes
user.id	string	yes
user.name	string	yes
user.role	string	yes
user.status	string	yes
user.username	string	yes

Errors: 400, 401, 403, 404, 429, as described in errors.

curl -X POST "https://node.example.com/api/v1/setup" \
  -H "Content-Type: application/json" \
  -d '{"token": "...", "email": "...", "username": "...", "name": "...", "password": "..."}'

First-run setup state

GET /api/v1/setup/status

Whether the node has an owner yet. Needs no sign-in.

Who may call it: None: anyone may call it.

Response (200, JSON):

Field	Type	Required	Notes
initialized	boolean	yes

Errors: 400, 401, 403, 404, 429, as described in errors.

curl -X GET "https://node.example.com/api/v1/setup/status"

Node version and license

GET /api/v1/version

The node’s name, version, licence and public address. Needs no sign-in.

Who may call it: None: anyone may call it.

Response (200, JSON):

Field	Type	Required	Notes
license	string	yes
name	string	yes
nodeUrl	string	yes
version	string	yes

Errors: 400, 401, 403, 404, 429, as described in errors.

curl -X GET "https://node.example.com/api/v1/version"