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

Administrative APIs related to server management.

• HTTP Route AdminAddRole
• HTTP Route AdminAddUser
• HTTP Route AdminDeleteRole
• HTTP Route AdminDeleteUser
• HTTP Route AdminListPermissions
• HTTP Route AdminListRoles
• HTTP Route AdminListUsers
• HTTP Route ChangeServerSettings
• HTTP Route DebugGenDocs
• HTTP Route DebugLanguageAdd
• HTTP Route GetServerResourceInfo
• HTTP Route InstallExtension
• HTTP Route ListConnectedUsers
• HTTP Route ListLogTypes
• HTTP Route ListRecentLogMessages
• HTTP Route ListServerSettings
• HTTP Route LogSubmitToPastebin
• HTTP Route ShutdownServer
• HTTP Route UninstallExtension
• HTTP Route UpdateAndRestart
• HTTP Route UpdateExtension

Admin route to create a new user permission role.

configure_roles - Configure Roles in group Admin

    "success": true

Admin route to create a new user account.

manage_users - Manage Users in group Admin

    "success": true

Admin route to delete an existing user permission role.

configure_roles - Configure Roles in group Admin

    "success": true

Admin route to delete an existing user account.

manage_users - Manage Users in group Admin

    "success": true

Admin route to get a list of all available permissions.

configure_roles - Configure Roles in group Admin

None.

    "permissions": [
        "perm_name": {
            "name": "Perm Name",
            "description": "Description text for the perm",
            "default": "USER",
            "group": {
                "name": "My Group",
                "description": "Some group description"
            },
            "safety_level": "UNTESTED",
            "alt_safety_text": "some text here or null"
        }
    ]

Admin route to get a list of all available roles.

configure_roles - Configure Roles in group Admin

None.

    "roles": [
        "user": {
            "name": "User",
            "description": "Text here...",
            "max_out_depth_path": 5,
            "is_auto_generated": true,
            "model_whitelist": [],
            "model_blacklist": [],
            "permissions": ["first", "second"],
            "max_t2i_simultaneous": 32,
            "allow_unsafe_outpaths": false
        }
    ]

Admin route to get a list of all known users by ID.

manage_users - Manage Users in group Admin

None.

    "users": [
        "user1",
        "user2"
    ]

Changes server settings.

edit_server_settings - Edit Server Settings in group Admin

"success": true

(Internal/Debug route), generates API docs.

admin_debug - Admin Debug APIs in group Admin

None.

"success": true

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

admin_debug - Admin Debug APIs in group Admin

"success": true

Returns information about the server's resource usage.

read_server_info_panels - Read Server Info Panels in group Admin

None.

    "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
        }
    }

Installs an extension from the known extensions list. Does not trigger a restart. Does signal required rebuild.

manage_extensions - Manage Extensions in group Admin

    "success": true

Returns a list of currently connected users.

read_server_info_panels - Read Server Info Panels in group Admin

None.

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

Returns a list of the available log types.

view_logs - View Server Logs in group Admin

None.

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

Returns a list of recent server log messages.

view_logs - View Server Logs in group Admin

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

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

read_server_settings - Read Server Settings in group Admin

None.

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

Submits current server log info to a pastebin service automatically.

view_logs - View Server Logs in group Admin

  "url": "a url to the paste here"

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

shutdown - Shutdown Server in group Admin

None.

"success": true

Triggers an extension uninstallation for an installed extension. Does not trigger a restart. Does signal required rebuild.

manage_extensions - Manage Extensions in group Admin

    "success": true

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

restart - Restart Server in group Admin

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

Triggers an extension update for an installed extension. Does not trigger a restart. Does signal required rebuild.

manage_extensions - Manage Extensions in group Admin

    "success": true // or false if no update available