TabGeckoLaufzeit · API
Aus dem OpenAPI-Stand erzeugt. Quellzusammenfassungen bleiben unverändert; die JSON-Schemas unten sind die exakten exportierten Definitionen.
POST /api/v1/profiles/{id}/start
Profil starten: Relay, Proxy-Prüfung (Kill-Switch), Kern-Start; liefert DevTools-Endpunkt
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: runtime:control
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | path | Ja |
Vollständige Parameterschemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Anfragekörper · erforderlich
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"skip_proxy_check": {
"type": "boolean"
},
"urls": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"maxItems": 50
}
},
"additionalProperties": false
}
}
}
}Dokumentierte Antworten
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"
},
"ws_endpoint": {
"type": "string"
},
"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"
}
}
}
}
}Vollständige Operationsdefinition
OpenAPI JSON
{
"summary": "Profil starten: Relay, Proxy-Prüfung (Kill-Switch), Kern-Start; liefert DevTools-Endpunkt",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"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"
},
"ws_endpoint": {
"type": "string"
},
"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 (Browser.close, nach Zeitlimit hart)
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: runtime:control
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | path | Ja |
Vollständige Parameterschemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Kein Anfragekörper deklariert.
Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
OpenAPI JSON
{
"summary": "Profil regulär beenden (Browser.close, 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
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: runtime:control
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | path | Ja |
Vollständige Parameterschemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Kein Anfragekörper deklariert.
Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
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
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: profiles:read
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | path | Ja |
Vollständige Parameterschemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Kein Anfragekörper deklariert.
Dokumentierte Antworten
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"
},
"ws_endpoint": {
"type": "string"
},
"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"
}
}
}
}
}Vollständige Operationsdefinition
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"
},
"ws_endpoint": {
"type": "string"
},
"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
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: profiles:read
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
Keine Pfad- oder Query-Parameter deklariert.
Kein Anfragekörper deklariert.
Dokumentierte Antworten
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"
},
"ws_endpoint": {
"type": "string"
},
"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"
}
}
}
}
}Vollständige Operationsdefinition
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"
},
"ws_endpoint": {
"type": "string"
},
"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)
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: runtime:control
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
Keine Pfad- oder Query-Parameter deklariert.
Anfragekörper · erforderlich
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
},
"skip_proxy_check": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
}Dokumentierte Antworten
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"
},
"ws_endpoint": {
"type": "string"
},
"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"
}
}
}
}
}Vollständige Operationsdefinition
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
},
"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"
},
"ws_endpoint": {
"type": "string"
},
"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
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: runtime:control
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
Keine Pfad- oder Query-Parameter deklariert.
Anfragekörper · erforderlich
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
}
}
}
}Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
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
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: profiles:write
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | path | Ja |
Vollständige Parameterschemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Anfragekörper · erforderlich
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
}
}
}
}Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
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)
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: keine deklariert
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
Keine Pfad- oder Query-Parameter deklariert.
Kein Anfragekörper deklariert.
Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
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)
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: settings:write
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
Keine Pfad- oder Query-Parameter deklariert.
Anfragekörper · erforderlich
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
}
}
}
}Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
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
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: profiles:read
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
Keine Pfad- oder Query-Parameter deklariert.
Kein Anfragekörper deklariert.
Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
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
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: settings:write
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
Keine Pfad- oder Query-Parameter deklariert.
Anfragekörper · erforderlich
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
}
}
}
}Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
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
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: runtime:control
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
Keine Pfad- oder Query-Parameter deklariert.
Anfragekörper · erforderlich
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
}
}
}
}Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
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
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: runtime:control
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
Keine Pfad- oder Query-Parameter deklariert.
Kein Anfragekörper deklariert.
Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
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)
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: runtime:control
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
Keine Pfad- oder Query-Parameter deklariert.
Anfragekörper · erforderlich
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
}
}
}
}Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
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
Authentifizierung: Bearer-Token
Erforderliche Routen-Scopes: runtime:control
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Anfrageinhalt, Tresorzustand und Ressourcenrechte können zusätzliche Voraussetzungen setzen.
| Name | Ort | Pflicht | Beschreibung |
|---|---|---|---|
id | path | Ja |
Vollständige Parameterschemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Anfragekörper · erforderlich
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
}
]
}
}
}
}Dokumentierte Antworten
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"
}
}
}
}
}Vollständige Operationsdefinition
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"
}
}
}
}
}
}