Skip to content

Latest commit

 

History

History
238 lines (163 loc) · 4.44 KB

AdminAPI.md

File metadata and controls

238 lines (163 loc) · 4.44 KB

StableSwarmUI API Documentation - AdminAPI

This is a subset of the API docs, see /docs/API.md for general info.

Administrative APIs related to server management.

Table of Contents:

HTTP Route /API/ChangeServerSettings

Description

Changes server settings.

Parameters

Name Type Description Default
rawData JObject Dynamic input of "settingname": valuehere. (REQUIRED)

Return Format

"success": true

HTTP Route /API/DebugGenDocs

Description

(Internal/Debug route), generates API docs.

Parameters

None.

Return Format

"success": true

HTTP Route /API/DebugLanguageAdd

Description

(Internal/Debug route), adds language data to the language file builder.

Parameters

Name Type Description Default
raw JObject "set": [ "word", ... ] (REQUIRED)

Return Format

"success": true

HTTP Route /API/GetServerResourceInfo

Description

Returns information about the server's resource usage.

Parameters

None.

Return Format

    "cpu": {
        "usage": 0.0,
        "cores": 0
    },
    "system_ram": {
        "total": 0,
        "used": 0,
        "free": 0
    },
    "gpus": {
        "0": {
            "id": 0,
            "name": "namehere",
            "temperature": 0,
            "utilization_gpu": 0,
            "utilization_memory": 0,
            "total_memory": 0,
            "free_memory": 0,
            "used_memory": 0
        }
    }

HTTP Route /API/ListConnectedUsers

Description

Returns a list of currently connected users.

Parameters

None.

Return Format

    "users":
    [
        {
            "id": "useridhere",
            "last_active_seconds": 0,
            "active_sessions": [ "addresshere", "..." ],
            "last_active": "10 seconds ago"
        }
    ]

HTTP Route /API/ListLogTypes

Description

Returns a list of the available log types.

Parameters

None.

Return Format

    "types_available": [
        {
            "name": "namehere",
            "color": "#RRGGBB",
            "identifier": "identifierhere"
        }
    ]

HTTP Route /API/ListRecentLogMessages

Description

Returns a list of recent server log messages.

Parameters

Name Type Description Default
raw JObject Optionally input "last_sequence_ids": { "info": 123 } to set the start point. (REQUIRED)

Return Format

  "last_sequence_id": 123,
  "data": {
        "info": [
            {
                "sequence_id": 123,
                "timestamp": "yyyy-MM-dd HH:mm:ss.fff",
                "message": "messagehere"
            }, ...
        ]
    }

HTTP Route /API/ListServerSettings

Description

Returns a list of the server settings, will full metadata.

Parameters

None.

Return Format

    "settings": {
        "settingname": {
            "type": "typehere",
            "name": "namehere",
            "value": somevaluehere,
            "description": "sometext",
            "values": [...] or null,
            "value_names": [...] or null
        }
    }

HTTP Route /API/ShutdownServer

Description

Shuts the server down. Returns success before the server is gone.

Parameters

None.

Return Format

"success": true

HTTP Route /API/UpdateAndRestart

Description

Causes swarm to update, then close and restart itself. If there's no update to apply, won't restart.

Parameters

None.

Return Format

    "success": true, // or false if not updated
    "result": "No changes found." // or any other applicable human-readable English message