Skitflow
Generated

Settings

Skitflow API reference for Settings endpoints.

Settings reload Server

POST
/settings.reloadServer

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.reloadServer"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings reload Traefik

POST
/settings.reloadTraefik

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.reloadTraefik" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings toggle Dashboard

POST
/settings.toggleDashboard

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.toggleDashboard" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings clean Unused Images

POST
/settings.cleanUnusedImages

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.cleanUnusedImages" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings clean Unused Volumes

POST
/settings.cleanUnusedVolumes

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.cleanUnusedVolumes" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings clean Stopped Containers

POST
/settings.cleanStoppedContainers

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.cleanStoppedContainers" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings clean Docker Builder

POST
/settings.cleanDockerBuilder

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.cleanDockerBuilder" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings clean Docker Prune

POST
/settings.cleanDockerPrune

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.cleanDockerPrune" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings clean All

POST
/settings.cleanAll

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.cleanAll" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings clean Monitoring

POST
/settings.cleanMonitoring

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.cleanMonitoring"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings save S S H Private Key

POST
/settings.saveSSHPrivateKey

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.saveSSHPrivateKey" \  -H "Content-Type: application/json" \  -d '{}'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings assign Domain Server

POST
/settings.assignDomainServer

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.assignDomainServer" \  -H "Content-Type: application/json" \  -d '{    "host": "string"  }'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings clean S S H Private Key

POST
/settings.cleanSSHPrivateKey

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.cleanSSHPrivateKey"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings update Docker Cleanup

POST
/settings.updateDockerCleanup

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.updateDockerCleanup" \  -H "Content-Type: application/json" \  -d '{    "enableDockerCleanup": true  }'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings read Traefik Config

GET
/settings.readTraefikConfig

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.readTraefikConfig"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings update Traefik Config

POST
/settings.updateTraefikConfig

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.updateTraefikConfig" \  -H "Content-Type: application/json" \  -d '{    "traefikConfig": "string"  }'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings read Web Server Traefik Config

GET
/settings.readWebServerTraefikConfig

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.readWebServerTraefikConfig"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings update Web Server Traefik Config

POST
/settings.updateWebServerTraefikConfig

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.updateWebServerTraefikConfig" \  -H "Content-Type: application/json" \  -d '{    "traefikConfig": "string"  }'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings read Middleware Traefik Config

GET
/settings.readMiddlewareTraefikConfig

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.readMiddlewareTraefikConfig"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings update Middleware Traefik Config

POST
/settings.updateMiddlewareTraefikConfig

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.updateMiddlewareTraefikConfig" \  -H "Content-Type: application/json" \  -d '{    "traefikConfig": "string"  }'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings check And Update Image

POST
/settings.checkAndUpdateImage

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.checkAndUpdateImage"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings update Server

POST
/settings.updateServer

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.updateServer"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings get Skitflow Version

GET
/settings.getSkitflowVersion

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.getSkitflowVersion"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings read Directories

GET
/settings.readDirectories

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

serverId?string

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.readDirectories"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings update Traefik File

POST
/settings.updateTraefikFile

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.updateTraefikFile" \  -H "Content-Type: application/json" \  -d '{    "path": "string",    "traefikConfig": "string"  }'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings read Traefik File

GET
/settings.readTraefikFile

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

path*string
serverId?string

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.readTraefikFile?path=string"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings get Ip

GET
/settings.getIp

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.getIp"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings get Open Api Document

GET
/settings.getOpenApiDocument

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.getOpenApiDocument"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings read Traefik Env

GET
/settings.readTraefikEnv

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

serverId?string

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.readTraefikEnv"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings write Traefik Env

POST
/settings.writeTraefikEnv

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.writeTraefikEnv" \  -H "Content-Type: application/json" \  -d '{    "env": "string"  }'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings have Traefik Dashboard Port Enabled

GET
/settings.haveTraefikDashboardPortEnabled

Authorization

Authorization
AuthorizationBearer <token>

In: header

Query Parameters

serverId?string

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.haveTraefikDashboardPortEnabled"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings read Stats

GET
/settings.readStats

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.readStats"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings get Log Rotate Status

GET
/settings.getLogRotateStatus

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.getLogRotateStatus"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings toggle Log Rotate

POST
/settings.toggleLogRotate

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.toggleLogRotate" \  -H "Content-Type: application/json" \  -d '{    "enable": true  }'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings have Activate Requests

GET
/settings.haveActivateRequests

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.haveActivateRequests"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings toggle Requests

POST
/settings.toggleRequests

Authorization

Authorization
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/settings.toggleRequests" \  -H "Content-Type: application/json" \  -d '{    "enable": true  }'
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings is Cloud

GET
/settings.isCloud

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.isCloud"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Settings health

GET
/settings.health

Authorization

Authorization
AuthorizationBearer <token>

In: header

Response Body

application/json

application/json

curl -X GET "https://example.com/settings.health"
Empty
{  "message": "string",  "code": "string",  "issues": [    {      "message": "string"    }  ]}

Security

Skitflow API reference for Security endpoints.

Ssh Router

Skitflow API reference for Ssh Router endpoints.