Appearance
node-manager
30 endpoints.
GET /api/v1/node-manager/health
Health
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Health Api V1 Node Manager Health Get"
}GET /api/v1/node-manager/apps
List Apps
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response List Apps Api V1 Node Manager Apps Get"
}GET /api/v1/node-manager/apps/{app_id}/status
App Status
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response App Status Api V1 Node Manager Apps App Id Status Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/node-manager/apps/{app_id}/logs
App Logs
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string | |
lines | query | no | integer |
200 — Successful Response
422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/node-manager/apps/{app_id}/env
Get Env
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Get Env Api V1 Node Manager Apps App Id Env Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}PUT /api/v1/node-manager/apps/{app_id}/env
Put Env
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string |
Request body
json
{
"properties": {
"content": {
"type": "string",
"maxLength": 65536,
"title": "Content"
}
},
"type": "object",
"required": [
"content"
],
"title": "EnvBody"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Put Env Api V1 Node Manager Apps App Id Env Put"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/node-manager/apps/{app_id}/config
Get Config
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Get Config Api V1 Node Manager Apps App Id Config Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}PUT /api/v1/node-manager/apps/{app_id}/config
Put Config
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string |
Request body
json
{
"properties": {
"overrides": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Overrides"
},
"nodeVersion": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Nodeversion"
},
"clearNodeVersion": {
"type": "boolean",
"title": "Clearnodeversion",
"default": false
},
"port": {
"anyOf": [
{
"type": "integer",
"maximum": 3999,
"minimum": 3101
},
{
"type": "null"
}
],
"title": "Port"
}
},
"type": "object",
"title": "ConfigBody"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Put Config Api V1 Node Manager Apps App Id Config Put"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/node-manager/backups
All Backups
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response All Backups Api V1 Node Manager Backups Get"
}GET /api/v1/node-manager/apps/{app_id}/backups
App Backups
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response App Backups Api V1 Node Manager Apps App Id Backups Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/node-manager/apps/{app_id}/backups
Create Backup
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Create Backup Api V1 Node Manager Apps App Id Backups Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}DELETE /api/v1/node-manager/apps/{app_id}/backups/{file}
Delete Backup
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string | |
file | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Delete Backup Api V1 Node Manager Apps App Id Backups File Delete"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/node-manager/apps/{app_id}/backups/{file}/restore
Restore Backup
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string | |
file | path | yes | string | |
confirm | query | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Restore Backup Api V1 Node Manager Apps App Id Backups File Restore Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/node-manager/apps/{app_id}/backups/{file}/download-link
Download Link
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string | |
file | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Download Link Api V1 Node Manager Apps App Id Backups File Download Link Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/node-manager/node
Node Versions
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Node Versions Api V1 Node Manager Node Get"
}POST /api/v1/node-manager/node/versions
Node Install
Request body
json
{
"properties": {
"version": {
"type": "string",
"pattern": "^v?\\d{1,2}\\.\\d{1,3}\\.\\d{1,3}$",
"title": "Version"
}
},
"type": "object",
"required": [
"version"
],
"title": "NodeInstall"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Node Install Api V1 Node Manager Node Versions Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}DELETE /api/v1/node-manager/node/versions/{version}
Node Remove
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
version | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Node Remove Api V1 Node Manager Node Versions Version Delete"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/node-manager/sites
Create Site
Request body
json
{
"properties": {
"prefix": {
"type": "string",
"pattern": "^[a-z0-9]([a-z0-9-]{0,30}[a-z0-9])?$",
"title": "Prefix"
},
"template": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Template"
}
},
"type": "object",
"required": [
"prefix"
],
"title": "NewSite"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Create Site Api V1 Node Manager Sites Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}DELETE /api/v1/node-manager/sites/{site_id}
Delete Site
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
site_id | path | yes | string | |
confirm | query | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Delete Site Api V1 Node Manager Sites Site Id Delete"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/node-manager/sites/{site_id}/domains
Site Domains
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
site_id | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Site Domains Api V1 Node Manager Sites Site Id Domains Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/node-manager/sites/{site_id}/domains
Add Domain
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
site_id | path | yes | string |
Request body
json
{
"properties": {
"domain": {
"type": "string",
"maxLength": 253,
"title": "Domain"
}
},
"type": "object",
"required": [
"domain"
],
"title": "NewDomain"
}200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Add Domain Api V1 Node Manager Sites Site Id Domains Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/node-manager/sites/{site_id}/domains/{domain}/check
Check Domain
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
site_id | path | yes | string | |
domain | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Check Domain Api V1 Node Manager Sites Site Id Domains Domain Check Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}DELETE /api/v1/node-manager/sites/{site_id}/domains/{domain}
Remove Domain
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
site_id | path | yes | string | |
domain | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Remove Domain Api V1 Node Manager Sites Site Id Domains Domain Delete"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/node-manager/settings
Get Settings
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Get Settings Api V1 Node Manager Settings Get"
}PUT /api/v1/node-manager/settings
Put Settings
Request body
json
{
"properties": {
"manager": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Manager"
},
"backup": {
"anyOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Backup"
}
},
"type": "object",
"title": "SettingsBody"
}200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Put Settings Api V1 Node Manager Settings Put"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/node-manager/settings/token/rotate
Rotate Token
Mint a new manager token, store it in the hub's connection, then promote it on host1. The manager keeps accepting the old token until the confirm call — made WITH the new token — succeeds, so a failure at any step leaves a token that works.
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Rotate Token Api V1 Node Manager Settings Token Rotate Post"
}GET /api/v1/node-manager/jobs
Jobs
200 — Successful Response
json
{
"additionalProperties": true,
"type": "object",
"title": "Response Jobs Api V1 Node Manager Jobs Get"
}GET /api/v1/node-manager/jobs/{job_id}
Job
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
job_id | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response Job Api V1 Node Manager Jobs Job Id Get"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}POST /api/v1/node-manager/apps/{app_id}/{verb}
App Control
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
app_id | path | yes | string | |
verb | path | yes | string |
200 — Successful Response
json
{
"type": "object",
"additionalProperties": true,
"title": "Response App Control Api V1 Node Manager Apps App Id Verb Post"
}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}GET /api/v1/node-manager/download/{token}
Download
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
token | path | yes | string |
200 — Successful Response
json
{}422 — Validation Error
json
{
"properties": {
"detail": {
"items": {
"properties": {
"loc": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
}
]
},
"type": "array",
"title": "Location"
},
"msg": {
"type": "string",
"title": "Message"
},
"type": {
"type": "string",
"title": "Error Type"
}
},
"type": "object",
"required": [
"loc",
"msg",
"type"
],
"title": "ValidationError"
},
"type": "array",
"title": "Detail"
}
},
"type": "object",
"title": "HTTPValidationError"
}