TabGeckoRuntime · API
Generated from the OpenAPI snapshot. Source summaries remain unchanged; JSON schemas below are the exact exported definitions.
POST /api/v1/runtime/once
Temporären Browser starten; Daten nach Ablauf oder Schließen entfernen
Authentication: bearer token
Required route scopes: runtime:control, profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profile": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100
},
"notes": {
"type": [
"string",
"null"
],
"maxLength": 400
},
"group_id": {
"type": [
"string",
"null"
]
},
"group_name": {
"type": "string",
"maxLength": 100
},
"tag_ids": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 30
},
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"maxItems": 30
},
"status_id": {
"type": [
"string",
"null"
]
},
"pinned": {
"type": "boolean"
},
"color": {
"type": [
"string",
"null"
],
"maxLength": 32
},
"custom_no": {
"type": [
"string",
"null"
],
"maxLength": 64
},
"engine": {
"anyOf": [
{
"type": "string",
"enum": [
"chromium"
]
},
{
"type": "string",
"enum": [
"firefox"
]
}
]
},
"engine_version": {
"type": "string",
"minLength": 1,
"maxLength": 16
},
"engine_auto_update": {
"type": "boolean"
},
"os": {
"anyOf": [
{
"type": "string",
"enum": [
"windows"
]
},
{
"type": "string",
"enum": [
"macos"
]
},
{
"type": "string",
"enum": [
"linux"
]
},
{
"type": "string",
"enum": [
"android"
]
},
{
"type": "string",
"enum": [
"ios"
]
}
]
},
"os_version": {
"type": [
"string",
"null"
],
"maxLength": 32
},
"user_agent": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"fingerprint_overrides": {
"type": "object",
"additionalProperties": {}
},
"proxy": {
"type": "object",
"required": [
"mode"
],
"properties": {
"ssh_private_key": {
"type": [
"string",
"null"
],
"maxLength": 65536
},
"ssh_key_passphrase": {
"type": [
"string",
"null"
],
"maxLength": 1024
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"none"
]
},
{
"type": "string",
"enum": [
"ref"
]
},
{
"type": "string",
"enum": [
"inline"
]
}
]
},
"proxy_id": {
"type": [
"string",
"null"
]
},
"proxy_group_id": {
"type": [
"string",
"null"
],
"maxLength": 64
},
"ssh_host_key": {
"type": [
"string",
"null"
],
"pattern": "^SHA256:[A-Za-z0-9+/]{43}$"
},
"protocol": {
"anyOf": [
{
"type": "string",
"enum": [
"http"
]
},
{
"type": "string",
"enum": [
"https"
]
},
{
"type": "string",
"enum": [
"socks4"
]
},
{
"type": "string",
"enum": [
"socks4a"
]
},
{
"type": "string",
"enum": [
"socks5"
]
},
{
"type": "string",
"enum": [
"socks5h"
]
},
{
"type": "string",
"enum": [
"ssh"
]
}
]
},
"host": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"username": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"password": {
"type": [
"string",
"null"
],
"maxLength": 1024
}
},
"additionalProperties": false
},
"ip_checker": {
"type": [
"string",
"null"
],
"maxLength": 32
},
"browser_options": {
"type": "object",
"properties": {
"block_images": {
"type": "boolean"
},
"block_video": {
"type": "boolean"
},
"block_audio": {
"type": "boolean"
},
"block_notifications": {
"type": "boolean"
},
"block_password_view": {
"type": "boolean"
},
"block_password_save": {
"type": "boolean"
},
"block_extension_pages": {
"type": "boolean"
},
"block_translation": {
"type": "boolean"
},
"block_devtools": {
"type": "boolean"
},
"local_network": {
"type": "object",
"required": [
"blocked",
"allowed_ports"
],
"properties": {
"blocked": {
"type": "boolean"
},
"allowed_ports": {
"type": "string",
"maxLength": 1536
}
},
"additionalProperties": false
},
"taskbar_icon": {
"anyOf": [
{
"type": "string",
"minLength": 50,
"maxLength": 393216
},
{
"type": "null"
}
]
},
"ui_language": {
"anyOf": [
{
"type": "string",
"minLength": 2,
"maxLength": 35
},
{
"type": "null"
}
]
},
"tls_cipher_blocklist": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "null"
}
]
},
"secure_dns": {
"anyOf": [
{
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"off"
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mode",
"server"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"secure"
]
},
"server": {
"type": "string",
"minLength": 9,
"maxLength": 2048
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"net": {
"type": "object",
"additionalProperties": {}
},
"start_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"new_tab"
]
},
{
"type": "string",
"enum": [
"last_tabs"
]
},
{
"type": "string",
"enum": [
"urls"
]
},
{
"type": "string",
"enum": [
"last_and_urls"
]
}
]
},
"start_urls": {
"type": "array",
"items": {
"type": "string",
"maxLength": 2048
},
"maxItems": 20
},
"open_account_pages": {
"type": "boolean"
},
"homepage": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"launch_args": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1024
},
"maxItems": 100
},
"extension_set_id": {
"type": [
"string",
"null"
]
},
"storage_options": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"clear_on_close": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"fingerprint_seeds": {
"type": "object",
"required": [
"identity",
"canvas",
"webgl",
"audio",
"clientRects"
],
"properties": {
"identity": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"canvas": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"webgl": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"audio": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"clientRects": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
},
"additionalProperties": false
},
"accounts": {
"type": "array",
"items": {
"type": "object",
"required": [
"platform_url"
],
"properties": {
"platform_url": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"username": {
"type": [
"string",
"null"
],
"maxLength": 256
},
"password": {
"type": [
"string",
"null"
],
"maxLength": 1024
},
"totp_secret": {
"type": [
"string",
"null"
],
"maxLength": 1024
},
"notes": {
"type": [
"string",
"null"
],
"maxLength": 1024
},
"sort_order": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"maxItems": 50
},
"imported_from": {
"type": [
"string",
"null"
],
"maxLength": 64
}
}
},
"duration_seconds": {
"type": "integer",
"minimum": 10,
"maximum": 86400
},
"auto_close": {
"type": "boolean"
},
"headless": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response"
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}At least one documented response has no content schema. Its body shape is not specified by this export. General HTTP/authentication errors can occur in addition.
Complete operation definition
OpenAPI JSON
{
"summary": "Temporären Browser starten; Daten nach Ablauf oder Schließen entfernen",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"profile": {
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100
},
"notes": {
"type": [
"string",
"null"
],
"maxLength": 400
},
"group_id": {
"type": [
"string",
"null"
]
},
"group_name": {
"type": "string",
"maxLength": 100
},
"tag_ids": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 30
},
"tags": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 50
},
"maxItems": 30
},
"status_id": {
"type": [
"string",
"null"
]
},
"pinned": {
"type": "boolean"
},
"color": {
"type": [
"string",
"null"
],
"maxLength": 32
},
"custom_no": {
"type": [
"string",
"null"
],
"maxLength": 64
},
"engine": {
"anyOf": [
{
"type": "string",
"enum": [
"chromium"
]
},
{
"type": "string",
"enum": [
"firefox"
]
}
]
},
"engine_version": {
"type": "string",
"minLength": 1,
"maxLength": 16
},
"engine_auto_update": {
"type": "boolean"
},
"os": {
"anyOf": [
{
"type": "string",
"enum": [
"windows"
]
},
{
"type": "string",
"enum": [
"macos"
]
},
{
"type": "string",
"enum": [
"linux"
]
},
{
"type": "string",
"enum": [
"android"
]
},
{
"type": "string",
"enum": [
"ios"
]
}
]
},
"os_version": {
"type": [
"string",
"null"
],
"maxLength": 32
},
"user_agent": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"fingerprint_overrides": {
"type": "object",
"additionalProperties": {}
},
"proxy": {
"type": "object",
"required": [
"mode"
],
"properties": {
"ssh_private_key": {
"type": [
"string",
"null"
],
"maxLength": 65536
},
"ssh_key_passphrase": {
"type": [
"string",
"null"
],
"maxLength": 1024
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"none"
]
},
{
"type": "string",
"enum": [
"ref"
]
},
{
"type": "string",
"enum": [
"inline"
]
}
]
},
"proxy_id": {
"type": [
"string",
"null"
]
},
"proxy_group_id": {
"type": [
"string",
"null"
],
"maxLength": 64
},
"ssh_host_key": {
"type": [
"string",
"null"
],
"pattern": "^SHA256:[A-Za-z0-9+/]{43}$"
},
"protocol": {
"anyOf": [
{
"type": "string",
"enum": [
"http"
]
},
{
"type": "string",
"enum": [
"https"
]
},
{
"type": "string",
"enum": [
"socks4"
]
},
{
"type": "string",
"enum": [
"socks4a"
]
},
{
"type": "string",
"enum": [
"socks5"
]
},
{
"type": "string",
"enum": [
"socks5h"
]
},
{
"type": "string",
"enum": [
"ssh"
]
}
]
},
"host": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"username": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"password": {
"type": [
"string",
"null"
],
"maxLength": 1024
}
},
"additionalProperties": false
},
"ip_checker": {
"type": [
"string",
"null"
],
"maxLength": 32
},
"browser_options": {
"type": "object",
"properties": {
"block_images": {
"type": "boolean"
},
"block_video": {
"type": "boolean"
},
"block_audio": {
"type": "boolean"
},
"block_notifications": {
"type": "boolean"
},
"block_password_view": {
"type": "boolean"
},
"block_password_save": {
"type": "boolean"
},
"block_extension_pages": {
"type": "boolean"
},
"block_translation": {
"type": "boolean"
},
"block_devtools": {
"type": "boolean"
},
"local_network": {
"type": "object",
"required": [
"blocked",
"allowed_ports"
],
"properties": {
"blocked": {
"type": "boolean"
},
"allowed_ports": {
"type": "string",
"maxLength": 1536
}
},
"additionalProperties": false
},
"taskbar_icon": {
"anyOf": [
{
"type": "string",
"minLength": 50,
"maxLength": 393216
},
{
"type": "null"
}
]
},
"ui_language": {
"anyOf": [
{
"type": "string",
"minLength": 2,
"maxLength": 35
},
{
"type": "null"
}
]
},
"tls_cipher_blocklist": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "null"
}
]
},
"secure_dns": {
"anyOf": [
{
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"off"
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mode",
"server"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"secure"
]
},
"server": {
"type": "string",
"minLength": 9,
"maxLength": 2048
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"net": {
"type": "object",
"additionalProperties": {}
},
"start_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"new_tab"
]
},
{
"type": "string",
"enum": [
"last_tabs"
]
},
{
"type": "string",
"enum": [
"urls"
]
},
{
"type": "string",
"enum": [
"last_and_urls"
]
}
]
},
"start_urls": {
"type": "array",
"items": {
"type": "string",
"maxLength": 2048
},
"maxItems": 20
},
"open_account_pages": {
"type": "boolean"
},
"homepage": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"launch_args": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1024
},
"maxItems": 100
},
"extension_set_id": {
"type": [
"string",
"null"
]
},
"storage_options": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"clear_on_close": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"fingerprint_seeds": {
"type": "object",
"required": [
"identity",
"canvas",
"webgl",
"audio",
"clientRects"
],
"properties": {
"identity": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"canvas": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"webgl": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"audio": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
},
"clientRects": {
"type": "integer",
"minimum": 0,
"maximum": 4294967295
}
},
"additionalProperties": false
},
"accounts": {
"type": "array",
"items": {
"type": "object",
"required": [
"platform_url"
],
"properties": {
"platform_url": {
"type": "string",
"minLength": 1,
"maxLength": 256
},
"username": {
"type": [
"string",
"null"
],
"maxLength": 256
},
"password": {
"type": [
"string",
"null"
],
"maxLength": 1024
},
"totp_secret": {
"type": [
"string",
"null"
],
"maxLength": 1024
},
"notes": {
"type": [
"string",
"null"
],
"maxLength": 1024
},
"sort_order": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"maxItems": 50
},
"imported_from": {
"type": [
"string",
"null"
],
"maxLength": 64
}
}
},
"duration_seconds": {
"type": "integer",
"minimum": 10,
"maximum": 86400
},
"auto_close": {
"type": "boolean"
},
"headless": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"runtime:control",
"profiles:write"
],
"responses": {
"200": {
"description": "Default Response"
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/profiles/{id}/start
Profil starten: Relay, Proxy-Prüfung, Kern-Start; optional ohne API-Steuerung
Authentication: bearer token
Required route scopes: runtime:control
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"automation": {
"type": "boolean",
"description": "API-Steuerung aktivieren (Standard: true); false öffnet ein normales Windows-Profilfenster ohne Debug-Endpunkt."
},
"skip_proxy_check": {
"type": "boolean"
},
"urls": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"maxItems": 50
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer",
"description": "Debug-Port; 0 bei normalem Profilfenster ohne API-Steuerung."
},
"ws_endpoint": {
"type": "string",
"description": "DevTools-Endpunkt; leer bei normalem Profilfenster ohne API-Steuerung."
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"null",
"string"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"null",
"integer"
]
},
"exit_ip": {
"type": [
"null",
"string"
]
},
"proxy_country": {
"type": [
"null",
"string"
]
},
"timezone": {
"type": [
"null",
"string"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Profil starten: Relay, Proxy-Prüfung, Kern-Start; optional ohne API-Steuerung",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"automation": {
"type": "boolean",
"description": "API-Steuerung aktivieren (Standard: true); false öffnet ein normales Windows-Profilfenster ohne Debug-Endpunkt."
},
"skip_proxy_check": {
"type": "boolean"
},
"urls": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"maxItems": 50
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"runtime:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer",
"description": "Debug-Port; 0 bei normalem Profilfenster ohne API-Steuerung."
},
"ws_endpoint": {
"type": "string",
"description": "DevTools-Endpunkt; leer bei normalem Profilfenster ohne API-Steuerung."
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"null",
"string"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"null",
"integer"
]
},
"exit_ip": {
"type": [
"null",
"string"
]
},
"proxy_country": {
"type": [
"null",
"string"
]
},
"timezone": {
"type": [
"null",
"string"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/profiles/{id}/stop
Profil regulär beenden (API oder Fensterverwaltung, nach Zeitlimit hart)
Authentication: bearer token
Required route scopes: runtime:control
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"state"
],
"properties": {
"profile_id": {
"type": "string"
},
"state": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Profil regulär beenden (API oder Fensterverwaltung, nach Zeitlimit hart)",
"tags": [
"Laufzeit"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"runtime:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"state"
],
"properties": {
"profile_id": {
"type": "string"
},
"state": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/profiles/{id}/kill
Profil sofort hart beenden
Authentication: bearer token
Required route scopes: runtime:control
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"state"
],
"properties": {
"profile_id": {
"type": "string"
},
"state": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Profil sofort hart beenden",
"tags": [
"Laufzeit"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"runtime:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"state"
],
"properties": {
"profile_id": {
"type": "string"
},
"state": {
"type": "string"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/profiles/{id}/runtime
Laufzeitstatus eines Profils
Authentication: bearer token
Required route scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"state",
"phase",
"running",
"session",
"relay"
],
"properties": {
"profile_id": {
"type": "string"
},
"state": {
"type": "string"
},
"phase": {
"type": [
"string",
"null"
],
"enum": [
"syncing_extensions"
]
},
"running": {
"type": "boolean"
},
"session": {
"anyOf": [
{
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer",
"description": "Debug-Port; 0 bei normalem Profilfenster ohne API-Steuerung."
},
"ws_endpoint": {
"type": "string",
"description": "DevTools-Endpunkt; leer bei normalem Profilfenster ohne API-Steuerung."
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"null",
"string"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"null",
"integer"
]
},
"exit_ip": {
"type": [
"null",
"string"
]
},
"proxy_country": {
"type": [
"null",
"string"
]
},
"timezone": {
"type": [
"null",
"string"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
},
{
"type": "null"
}
]
},
"relay": {
"anyOf": [
{
"type": "object",
"required": [
"up",
"down",
"connections",
"failures"
],
"properties": {
"up": {
"type": "integer"
},
"down": {
"type": "integer"
},
"connections": {
"type": "integer"
},
"failures": {
"type": "integer"
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Laufzeitstatus eines Profils",
"tags": [
"Laufzeit"
],
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"profiles:read"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"state",
"phase",
"running",
"session",
"relay"
],
"properties": {
"profile_id": {
"type": "string"
},
"state": {
"type": "string"
},
"phase": {
"type": [
"string",
"null"
],
"enum": [
"syncing_extensions"
]
},
"running": {
"type": "boolean"
},
"session": {
"anyOf": [
{
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer",
"description": "Debug-Port; 0 bei normalem Profilfenster ohne API-Steuerung."
},
"ws_endpoint": {
"type": "string",
"description": "DevTools-Endpunkt; leer bei normalem Profilfenster ohne API-Steuerung."
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"null",
"string"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"null",
"integer"
]
},
"exit_ip": {
"type": [
"null",
"string"
]
},
"proxy_country": {
"type": [
"null",
"string"
]
},
"timezone": {
"type": [
"null",
"string"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
},
{
"type": "null"
}
]
},
"relay": {
"anyOf": [
{
"type": "object",
"required": [
"up",
"down",
"connections",
"failures"
],
"properties": {
"up": {
"type": "integer"
},
"down": {
"type": "integer"
},
"connections": {
"type": "integer"
},
"failures": {
"type": "integer"
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/runtime
Alle laufenden Profile
Authentication: bearer token
Required route scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items",
"phases"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer",
"description": "Debug-Port; 0 bei normalem Profilfenster ohne API-Steuerung."
},
"ws_endpoint": {
"type": "string",
"description": "DevTools-Endpunkt; leer bei normalem Profilfenster ohne API-Steuerung."
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"null",
"string"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"null",
"integer"
]
},
"exit_ip": {
"type": [
"null",
"string"
]
},
"proxy_country": {
"type": [
"null",
"string"
]
},
"timezone": {
"type": [
"null",
"string"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
}
},
"phases": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"phase"
],
"properties": {
"profile_id": {
"type": "string"
},
"phase": {
"type": "string",
"enum": [
"syncing_extensions"
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Alle laufenden Profile",
"tags": [
"Laufzeit"
],
"x-required-scopes": [
"profiles:read"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items",
"phases"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer",
"description": "Debug-Port; 0 bei normalem Profilfenster ohne API-Steuerung."
},
"ws_endpoint": {
"type": "string",
"description": "DevTools-Endpunkt; leer bei normalem Profilfenster ohne API-Steuerung."
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"null",
"string"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"null",
"integer"
]
},
"exit_ip": {
"type": [
"null",
"string"
]
},
"proxy_country": {
"type": [
"null",
"string"
]
},
"timezone": {
"type": [
"null",
"string"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
}
},
"phases": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"phase"
],
"properties": {
"profile_id": {
"type": "string"
},
"phase": {
"type": "string",
"enum": [
"syncing_extensions"
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/runtime/batch/start
Mehrere Profile starten (Warteschlange, Parallelität laut Einstellung)
Authentication: bearer token
Required route scopes: runtime:control
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"minItems": 1,
"maxItems": 1000
},
"automation": {
"type": "boolean"
},
"skip_proxy_check": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"ok",
"error",
"session"
],
"properties": {
"id": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
{
"type": "null"
}
]
},
"session": {
"anyOf": [
{
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer",
"description": "Debug-Port; 0 bei normalem Profilfenster ohne API-Steuerung."
},
"ws_endpoint": {
"type": "string",
"description": "DevTools-Endpunkt; leer bei normalem Profilfenster ohne API-Steuerung."
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"null",
"string"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"null",
"integer"
]
},
"exit_ip": {
"type": [
"null",
"string"
]
},
"proxy_country": {
"type": [
"null",
"string"
]
},
"timezone": {
"type": [
"null",
"string"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Mehrere Profile starten (Warteschlange, Parallelität laut Einstellung)",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"minItems": 1,
"maxItems": 1000
},
"automation": {
"type": "boolean"
},
"skip_proxy_check": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"runtime:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"ok",
"error",
"session"
],
"properties": {
"id": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
{
"type": "null"
}
]
},
"session": {
"anyOf": [
{
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer",
"description": "Debug-Port; 0 bei normalem Profilfenster ohne API-Steuerung."
},
"ws_endpoint": {
"type": "string",
"description": "DevTools-Endpunkt; leer bei normalem Profilfenster ohne API-Steuerung."
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"null",
"string"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"null",
"integer"
]
},
"exit_ip": {
"type": [
"null",
"string"
]
},
"proxy_country": {
"type": [
"null",
"string"
]
},
"timezone": {
"type": [
"null",
"string"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/runtime/batch/stop
Mehrere Profile beenden
Authentication: bearer token
Required route scopes: runtime:control
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"minItems": 1,
"maxItems": 1000
},
"force": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"ok",
"error"
],
"properties": {
"id": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Mehrere Profile beenden",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ids"
],
"properties": {
"ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"minItems": 1,
"maxItems": 1000
},
"force": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"runtime:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"ok",
"error"
],
"properties": {
"id": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"error": {
"anyOf": [
{
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
{
"type": "null"
}
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/profiles/{id}/cache/clear
Browserdaten eines gestoppten Profils löschen
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"types"
],
"properties": {
"types": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"local_storage"
]
},
{
"type": "string",
"enum": [
"indexed_db"
]
},
{
"type": "string",
"enum": [
"service_workers"
]
},
{
"type": "string",
"enum": [
"history"
]
},
{
"type": "string",
"enum": [
"passwords"
]
},
{
"type": "string",
"enum": [
"bookmarks"
]
},
{
"type": "string",
"enum": [
"extensions"
]
},
{
"type": "string",
"enum": [
"extension_data"
]
},
{
"type": "string",
"enum": [
"cache"
]
}
]
},
"minItems": 1
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"removed"
],
"properties": {
"removed": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Browserdaten eines gestoppten Profils löschen",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"types"
],
"properties": {
"types": {
"type": "array",
"items": {
"anyOf": [
{
"type": "string",
"enum": [
"cookies"
]
},
{
"type": "string",
"enum": [
"local_storage"
]
},
{
"type": "string",
"enum": [
"indexed_db"
]
},
{
"type": "string",
"enum": [
"service_workers"
]
},
{
"type": "string",
"enum": [
"history"
]
},
{
"type": "string",
"enum": [
"passwords"
]
},
{
"type": "string",
"enum": [
"bookmarks"
]
},
{
"type": "string",
"enum": [
"extensions"
]
},
{
"type": "string",
"enum": [
"extension_data"
]
},
{
"type": "string",
"enum": [
"cache"
]
}
]
},
"minItems": 1
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"profiles:write"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"removed"
],
"properties": {
"removed": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/settings/cache
Automatisches Leeren des Caches von Profilen, die N Tage nicht geöffnet wurden (0 = aus)
Authentication: bearer token
Required route scopes: none declared
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"auto_clear_days"
],
"properties": {
"auto_clear_days": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Automatisches Leeren des Caches von Profilen, die N Tage nicht geöffnet wurden (0 = aus)",
"tags": [
"Laufzeit"
],
"x-required-scopes": [],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"auto_clear_days"
],
"properties": {
"auto_clear_days": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/settings/cache
Automatisches Cache-Leeren einstellen (0 = aus, sonst 7–365 Tage ohne Öffnen)
Authentication: bearer token
Required route scopes: settings:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"auto_clear_days"
],
"properties": {
"auto_clear_days": {
"type": "integer",
"minimum": 0,
"maximum": 365
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"auto_clear_days"
],
"properties": {
"auto_clear_days": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Automatisches Cache-Leeren einstellen (0 = aus, sonst 7–365 Tage ohne Öffnen)",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"auto_clear_days"
],
"properties": {
"auto_clear_days": {
"type": "integer",
"minimum": 0,
"maximum": 365
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"settings:write"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"auto_clear_days"
],
"properties": {
"auto_clear_days": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/settings/runtime
Einstellungen für den Profilstart
Authentication: bearer token
Required route scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"hardware_acceleration",
"download_directory",
"info_page",
"max_parallel_starts",
"stop_timeout_ms"
],
"properties": {
"hardware_acceleration": {
"type": [
"null",
"boolean"
]
},
"download_directory": {
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 1024
},
"info_page": {
"type": "boolean"
},
"max_parallel_starts": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"stop_timeout_ms": {
"type": "integer",
"minimum": 1000,
"maximum": 120000
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Einstellungen für den Profilstart",
"tags": [
"Laufzeit"
],
"x-required-scopes": [
"profiles:read"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"hardware_acceleration",
"download_directory",
"info_page",
"max_parallel_starts",
"stop_timeout_ms"
],
"properties": {
"hardware_acceleration": {
"type": [
"null",
"boolean"
]
},
"download_directory": {
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 1024
},
"info_page": {
"type": "boolean"
},
"max_parallel_starts": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"stop_timeout_ms": {
"type": "integer",
"minimum": 1000,
"maximum": 120000
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}PUT /api/v1/settings/runtime
Einstellungen für den Profilstart ändern
Authentication: bearer token
Required route scopes: settings:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"hardware_acceleration": {
"type": [
"boolean",
"null"
]
},
"download_directory": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 1024
},
"info_page": {
"type": "boolean"
},
"max_parallel_starts": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"stop_timeout_ms": {
"type": "integer",
"minimum": 1000,
"maximum": 120000
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"hardware_acceleration",
"download_directory",
"info_page",
"max_parallel_starts",
"stop_timeout_ms"
],
"properties": {
"hardware_acceleration": {
"type": [
"null",
"boolean"
]
},
"download_directory": {
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 1024
},
"info_page": {
"type": "boolean"
},
"max_parallel_starts": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"stop_timeout_ms": {
"type": "integer",
"minimum": 1000,
"maximum": 120000
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Einstellungen für den Profilstart ändern",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"hardware_acceleration": {
"type": [
"boolean",
"null"
]
},
"download_directory": {
"type": [
"string",
"null"
],
"minLength": 1,
"maxLength": 1024
},
"info_page": {
"type": "boolean"
},
"max_parallel_starts": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"stop_timeout_ms": {
"type": "integer",
"minimum": 1000,
"maximum": 120000
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"settings:write"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"hardware_acceleration",
"download_directory",
"info_page",
"max_parallel_starts",
"stop_timeout_ms"
],
"properties": {
"hardware_acceleration": {
"type": [
"null",
"boolean"
]
},
"download_directory": {
"type": [
"null",
"string"
],
"minLength": 1,
"maxLength": 1024
},
"info_page": {
"type": "boolean"
},
"max_parallel_starts": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"stop_timeout_ms": {
"type": "integer",
"minimum": 1000,
"maximum": 120000
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/windows/uniform
Fenstergröße des Steuerprofils auf ausgewählte Profile übertragen, Positionen erhalten
Authentication: bearer token
Required route scopes: runtime:control
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"source_id",
"profile_ids"
],
"properties": {
"source_id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"profile_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"minItems": 1,
"maxItems": 200,
"uniqueItems": true
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"width",
"height",
"results"
],
"properties": {
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"ok",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"error": {
"type": [
"string",
"null"
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Fenstergröße des Steuerprofils auf ausgewählte Profile übertragen, Positionen erhalten",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"source_id",
"profile_ids"
],
"properties": {
"source_id": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"profile_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"minItems": 1,
"maxItems": 200,
"uniqueItems": true
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"runtime:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"width",
"height",
"results"
],
"properties": {
"width": {
"type": "integer"
},
"height": {
"type": "integer"
},
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"ok",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"ok": {
"type": "boolean"
},
"error": {
"type": [
"string",
"null"
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}GET /api/v1/displays
Aktuelle Bildschirme des Managers mit Arbeitsbereichen in geräteunabhängigen Pixeln und Skalierung abrufen
Authentication: bearer token
Required route scopes: runtime:control
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"label",
"primary",
"work_area",
"scale_factor"
],
"properties": {
"id": {
"type": "integer"
},
"label": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"work_area": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"y": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"width": {
"type": "integer",
"minimum": 200,
"maximum": 100000
},
"height": {
"type": "integer",
"minimum": 200,
"maximum": 100000
}
},
"additionalProperties": false
},
"scale_factor": {
"type": "number",
"exclusiveMinimum": 0
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Aktuelle Bildschirme des Managers mit Arbeitsbereichen in geräteunabhängigen Pixeln und Skalierung abrufen",
"tags": [
"Laufzeit"
],
"x-required-scopes": [
"runtime:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"label",
"primary",
"work_area",
"scale_factor"
],
"properties": {
"id": {
"type": "integer"
},
"label": {
"type": "string"
},
"primary": {
"type": "boolean"
},
"work_area": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"y": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"width": {
"type": "integer",
"minimum": 200,
"maximum": 100000
},
"height": {
"type": "integer",
"minimum": 200,
"maximum": 100000
}
},
"additionalProperties": false
},
"scale_factor": {
"type": "number",
"exclusiveMinimum": 0
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/windows/arrange
Fenster geöffneter Profile anordnen (grid: gleich große Kacheln, cascade: versetzt übereinander) in einem Bildschirmbereich (Koordinaten in geräteunabhängigen Pixeln)
Authentication: bearer token
Required route scopes: runtime:control
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"mode",
"area"
],
"properties": {
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"grid"
]
},
{
"type": "string",
"enum": [
"cascade"
]
}
]
},
"area": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"y": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"width": {
"type": "integer",
"minimum": 200,
"maximum": 100000
},
"height": {
"type": "integer",
"minimum": 200,
"maximum": 100000
}
},
"additionalProperties": false
},
"profile_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"minItems": 1,
"maxItems": 200
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"gap": {
"type": "integer",
"minimum": 0,
"maximum": 200
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"profile_no",
"ok",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": [
"null",
"integer"
]
},
"ok": {
"type": "boolean"
},
"error": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Fenster geöffneter Profile anordnen (grid: gleich große Kacheln, cascade: versetzt übereinander) in einem Bildschirmbereich (Koordinaten in geräteunabhängigen Pixeln)",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"mode",
"area"
],
"properties": {
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"grid"
]
},
{
"type": "string",
"enum": [
"cascade"
]
}
]
},
"area": {
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"y": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"width": {
"type": "integer",
"minimum": 200,
"maximum": 100000
},
"height": {
"type": "integer",
"minimum": 200,
"maximum": 100000
}
},
"additionalProperties": false
},
"profile_ids": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"minItems": 1,
"maxItems": 200
},
"columns": {
"type": "integer",
"minimum": 1,
"maximum": 20
},
"gap": {
"type": "integer",
"minimum": 0,
"maximum": 200
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"runtime:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"results"
],
"properties": {
"results": {
"type": "array",
"items": {
"type": "object",
"required": [
"profile_id",
"profile_no",
"ok",
"error"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": [
"null",
"integer"
]
},
"ok": {
"type": "boolean"
},
"error": {
"type": [
"null",
"string"
]
}
}
}
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}POST /api/v1/windows/{id}/bounds
Position und Größe eines Profilfensters setzen oder es minimieren bzw. maximieren
Authentication: bearer token
Required route scopes: runtime:control
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"y": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"width": {
"type": "integer",
"minimum": 200,
"maximum": 100000
},
"height": {
"type": "integer",
"minimum": 200,
"maximum": 100000
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"minimized"
]
},
{
"type": "string",
"enum": [
"maximized"
]
}
]
}
},
"additionalProperties": false
}
]
}
}
}
}Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"summary": "Position und Größe eines Profilfensters setzen oder es minimieren bzw. maximieren",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"anyOf": [
{
"type": "object",
"required": [
"x",
"y",
"width",
"height"
],
"properties": {
"x": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"y": {
"type": "integer",
"minimum": -100000,
"maximum": 100000
},
"width": {
"type": "integer",
"minimum": 200,
"maximum": 100000
},
"height": {
"type": "integer",
"minimum": 200,
"maximum": 100000
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"state"
],
"properties": {
"state": {
"anyOf": [
{
"type": "string",
"enum": [
"minimized"
]
},
{
"type": "string",
"enum": [
"maximized"
]
}
]
}
},
"additionalProperties": false
}
]
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"runtime:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"ok"
],
"properties": {
"ok": {
"type": "boolean"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}