{ "openapi": "3.1.0", "info": { "title": "TabGecko Local API", "version": "0.5.2", "description": "x-required-scopes lists the fixed route-level scopes (all required, subject to admin/session privileges). An empty list does not imply public access; security determines authentication. Action- and resource-dependent checks can require additional permissions, including RPA execution, secrets, cookies and transfers." }, "components": { "securitySchemes": { "bearer": { "type": "http", "scheme": "bearer" } }, "schemas": { "Error": { "type": "object", "required": [ "error", "request_id" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "details" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } }, "request_id": { "type": "string" } }, "title": "Error" } } }, "paths": { "/status": { "get": { "summary": "Erreichbarkeit prüfen (ohne Token)", "tags": [ "System" ], "security": [], "x-required-scopes": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "version" ], "properties": { "status": { "type": "string", "enum": [ "ok" ] }, "version": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/version": { "get": { "summary": "Versionen von App, API und Datenbank", "tags": [ "System" ], "x-required-scopes": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "app_version", "api_version", "db_version" ], "properties": { "app_version": { "type": "string" }, "api_version": { "type": "integer" }, "db_version": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/system/status": { "get": { "summary": "Zustand des Core", "tags": [ "System" ], "x-required-scopes": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "mode", "reason", "warnings", "data_root", "store_id", "disk", "disk_free_bytes", "db_version", "vault", "api" ], "properties": { "mode": { "type": "string" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "warnings": { "type": "array", "items": { "type": "string" } }, "data_root": { "type": "string" }, "store_id": { "type": "string" }, "disk": { "type": "string" }, "disk_free_bytes": { "anyOf": [ { "type": "integer" }, { "type": "null" } ] }, "db_version": { "type": "integer" }, "vault": { "type": "object", "required": [ "state", "reason" ], "properties": { "state": { "type": "string" }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } }, "api": { "type": "object", "required": [ "url", "port" ], "properties": { "url": { "type": "string" }, "port": { "type": "integer" } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/system/logs": { "get": { "summary": "Vorhandene technische Protokolldateien auflisten", "tags": [ "System" ], "x-required-scopes": [ "audit:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "stream", "file", "size", "modified_at" ], "properties": { "stream": { "anyOf": [ { "type": "string", "enum": [ "core" ] }, { "type": "string", "enum": [ "api" ] }, { "type": "string", "enum": [ "jobs" ] }, { "type": "string", "enum": [ "kernel" ] }, { "type": "string", "enum": [ "relay" ] } ] }, "file": { "type": "string" }, "size": { "type": "integer" }, "modified_at": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/system/logs/{stream}/{file}": { "get": { "summary": "Bereinigten Auszug einer technischen Protokolldatei lesen (maximal 256 KiB und 1.000 Zeilen)", "tags": [ "System" ], "parameters": [ { "schema": { "anyOf": [ { "type": "string", "enum": [ "core" ] }, { "type": "string", "enum": [ "api" ] }, { "type": "string", "enum": [ "jobs" ] }, { "type": "string", "enum": [ "kernel" ] }, { "type": "string", "enum": [ "relay" ] } ] }, "in": "path", "name": "stream", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 155, "pattern": "^[a-zA-Z0-9][a-zA-Z0-9._-]{0,150}\\.log$" }, "example": "core.log", "in": "path", "name": "file", "required": true } ], "x-required-scopes": [ "audit:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "stream", "file", "size", "modified_at", "text", "lines", "truncated" ], "properties": { "stream": { "anyOf": [ { "type": "string", "enum": [ "core" ] }, { "type": "string", "enum": [ "api" ] }, { "type": "string", "enum": [ "jobs" ] }, { "type": "string", "enum": [ "kernel" ] }, { "type": "string", "enum": [ "relay" ] } ] }, "file": { "type": "string" }, "size": { "type": "integer" }, "modified_at": { "type": "integer" }, "text": { "type": "string" }, "lines": { "type": "integer" }, "truncated": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/settings/logs": { "get": { "summary": "Aufbewahrung der Protokolldateien von Programm und Browser-Kernen", "tags": [ "System" ], "x-required-scopes": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "retention_days", "kernel_retention_days" ], "properties": { "retention_days": { "type": "integer", "minimum": 1, "maximum": 365 }, "kernel_retention_days": { "type": "integer", "minimum": 1, "maximum": 365 } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Aufbewahrung der Protokolldateien ändern (1–365 Tage); ältere Dateien entfernt der tägliche Aufräumlauf", "tags": [ "System" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "retention_days": { "type": "integer", "minimum": 1, "maximum": 365 }, "kernel_retention_days": { "type": "integer", "minimum": 1, "maximum": 365 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "settings:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "retention_days", "kernel_retention_days" ], "properties": { "retention_days": { "type": "integer", "minimum": 1, "maximum": 365 }, "kernel_retention_days": { "type": "integer", "minimum": 1, "maximum": 365 } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/account/status": { "get": { "summary": "Serverbestätigten Kontostatus abrufen", "tags": [ "Account" ], "x-required-scopes": [], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "authenticated", "verifiedUntil", "validForMs", "account", "error" ], "properties": { "authenticated": { "type": "boolean" }, "verifiedUntil": { "type": "number" }, "validForMs": { "type": "number" }, "account": { "anyOf": [ { "type": "object", "required": [ "membership", "entitlements", "limits", "isAdmin", "notificationsUnread", "serverTime", "validUntil" ], "properties": { "membership": { "type": "object", "required": [ "plan", "trialEndsAt", "premiumExpiresAt" ], "properties": { "plan": { "anyOf": [ { "type": "string", "enum": [ "free" ] }, { "type": "string", "enum": [ "trial" ] }, { "type": "string", "enum": [ "premium" ] } ] }, "trialEndsAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "premiumExpiresAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "periodStartedAt": { "anyOf": [ { "type": "number" }, { "type": "null" } ] } } }, "entitlements": { "type": "object", "required": [ "profiles", "api", "automation", "synchronizer", "teamSync" ], "properties": { "profiles": { "type": "boolean" }, "api": { "type": "boolean" }, "automation": { "type": "boolean" }, "synchronizer": { "type": "boolean" }, "teamSync": { "type": "boolean" } } }, "limits": { "type": "object", "required": [ "profiles", "runningProfiles", "groups" ], "properties": { "profiles": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "runningProfiles": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "groups": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "members": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "dailyStarts": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] } } }, "usage": { "type": "object", "required": [ "profiles", "members", "startsToday", "day", "resetAt" ], "properties": { "profiles": { "type": "integer", "minimum": 0 }, "members": { "type": "integer", "minimum": 0 }, "startsToday": { "type": "integer", "minimum": 0 }, "day": { "type": "string" }, "resetAt": { "type": "number" } } }, "team": { "type": "object", "required": [ "id", "name", "role", "ownerId" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "anyOf": [ { "type": "string", "enum": [ "owner" ] }, { "type": "string", "enum": [ "admin" ] }, { "type": "string", "enum": [ "member" ] } ] }, "ownerId": { "type": "string" } } }, "isAdmin": { "type": "boolean" }, "notificationsUnread": { "type": "integer", "minimum": 0 }, "serverTime": { "type": "number" }, "validUntil": { "type": "number" } } }, { "type": "null" } ] }, "error": { "anyOf": [ { "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" } } } } } } }, "/api/v1/automation/globals": { "get": { "summary": "Globale RPA-Variablen ohne Werte auflisten", "tags": [ "Automation" ], "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": [ "name", "revision", "bytes", "updated_at" ], "properties": { "name": { "type": "string" }, "revision": { "type": "integer" }, "bytes": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/globals/{name}": { "get": { "summary": "Globale RPA-Variable lesen", "tags": [ "Automation" ], "parameters": [ { "schema": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "in": "path", "name": "name", "required": true } ], "x-required-scopes": [ "runtime:control", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "value", "revision" ], "properties": { "value": { "type": "string" }, "revision": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Globale RPA-Variable mit Versionsprüfung speichern", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "value", "expected_revision" ], "properties": { "value": { "type": "string", "maxLength": 1048576 }, "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "in": "path", "name": "name", "required": true } ], "x-required-scopes": [ "runtime:control", "secrets:read", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "revision", "bytes", "updated_at" ], "properties": { "name": { "type": "string" }, "revision": { "type": "integer" }, "bytes": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Globale RPA-Variable mit Versionsprüfung löschen", "tags": [ "Automation" ], "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "query", "name": "expected_revision", "required": true }, { "schema": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "in": "path", "name": "name", "required": true } ], "x-required-scopes": [ "runtime:control", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/shares": { "get": { "summary": "Lokale Ablauffreigaben auflisten", "tags": [ "Automation" ], "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", "name", "expires_at", "max_uses", "uses", "size", "sha256" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "expires_at": { "type": "integer" }, "max_uses": { "type": "integer" }, "uses": { "type": "integer" }, "size": { "type": "integer" }, "sha256": { "type": "string" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Verschlüsselten Freigabecode mit Ablauf und Abruflimit erzeugen", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "name", "expires_in_minutes", "max_uses" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000, "uniqueItems": true }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "expires_in_minutes": { "type": "integer", "minimum": 1, "maximum": 43200 }, "max_uses": { "type": "integer", "minimum": 1, "maximum": 1000 }, "include_secrets": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "secrets:read", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "expires_at", "max_uses", "uses", "size", "sha256", "code" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "expires_at": { "type": "integer" }, "max_uses": { "type": "integer" }, "uses": { "type": "integer" }, "size": { "type": "integer" }, "sha256": { "type": "string" }, "code": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/shares/{id}": { "delete": { "summary": "Ablauffreigabe widerrufen", "tags": [ "Automation" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "runtime:control", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/shares/redeem": { "post": { "summary": "Freigabecode einmal abrufen und Importvorschau erstellen", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "code" ], "properties": { "code": { "type": "string", "minLength": 8, "maxLength": 2010 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "sha256", "created_at", "items", "ticket", "expires_at" ], "properties": { "sha256": { "type": "string" }, "created_at": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "dependencies", "group", "description", "missing_values", "is_template", "steps", "protected_values" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "dependencies": { "type": "array", "items": { "type": "string" } }, "group": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "missing_values": { "type": "integer" }, "is_template": { "type": "boolean" }, "steps": { "type": "integer" }, "protected_values": { "type": "integer" } } } }, "ticket": { "type": "string" }, "expires_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/shares/import": { "post": { "summary": "Vorbereitetes Freigabepaket als neue Abläufe importieren", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ticket", "ids" ], "properties": { "ticket": { "type": "string", "pattern": "^[a-f0-9-]{36}$" }, "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000, "uniqueItems": true } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "is_template" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "is_template": { "type": "boolean" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/files": { "get": { "summary": "RPA-Dateien auflisten", "tags": [ "Automation" ], "x-required-scopes": [ "runtime:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "directory", "items" ], "properties": { "directory": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "name", "size_bytes" ], "properties": { "name": { "type": "string" }, "size_bytes": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Eine RPA-Datei importieren, ohne bestehende Dateien zu ersetzen", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "base64" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "base64": { "type": "string", "maxLength": 5592408, "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/files/content": { "get": { "summary": "Eine RPA-Datei exportieren", "tags": [ "Automation" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "in": "query", "name": "name", "required": true } ], "x-required-scopes": [ "runtime:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "base64" ], "properties": { "base64": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/synchronizer": { "get": { "summary": "Synchronizer-Status", "tags": [ "Automation" ], "x-required-scopes": [ "runtime:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "running", "source_id", "follower_ids", "mode", "options", "tabs", "events", "error" ], "properties": { "running": { "type": "boolean" }, "source_id": { "type": [ "string", "null" ] }, "follower_ids": { "type": "array", "items": { "type": "string" } }, "mode": { "anyOf": [ { "type": "string", "enum": [ "element" ] }, { "type": "string", "enum": [ "coordinates" ] } ] }, "options": { "type": "object", "required": [ "mouse", "keyboard", "scroll", "navigation", "tabs", "native_controls", "extension_pages", "delay_min_ms", "delay_max_ms" ], "properties": { "mouse": { "type": "boolean" }, "keyboard": { "type": "boolean" }, "scroll": { "type": "boolean" }, "navigation": { "type": "boolean" }, "tabs": { "type": "boolean" }, "native_controls": { "type": "boolean" }, "extension_pages": { "type": "boolean" }, "delay_min_ms": { "type": "integer" }, "delay_max_ms": { "type": "integer" } } }, "tabs": { "type": "array", "items": { "type": "object", "required": [ "id", "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } }, "events": { "type": "integer" }, "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" } } } } } } }, "/api/v1/automation/synchronizer/start": { "post": { "summary": "Live-Synchronisierung starten", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "source_id", "follower_ids", "mode" ], "properties": { "source_id": { "type": "string", "minLength": 1, "maxLength": 64 }, "follower_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 20, "uniqueItems": true }, "mode": { "anyOf": [ { "type": "string", "enum": [ "element" ] }, { "type": "string", "enum": [ "coordinates" ] } ] }, "options": { "type": "object", "properties": { "mouse": { "type": "boolean" }, "keyboard": { "type": "boolean" }, "scroll": { "type": "boolean" }, "navigation": { "type": "boolean" }, "tabs": { "type": "boolean" }, "native_controls": { "type": "boolean" }, "extension_pages": { "type": "boolean" }, "delay_min_ms": { "type": "integer", "minimum": 0, "maximum": 5000 }, "delay_max_ms": { "type": "integer", "minimum": 0, "maximum": 5000 } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "sync:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "running", "source_id", "follower_ids", "mode", "options", "tabs", "events", "error" ], "properties": { "running": { "type": "boolean" }, "source_id": { "type": [ "string", "null" ] }, "follower_ids": { "type": "array", "items": { "type": "string" } }, "mode": { "anyOf": [ { "type": "string", "enum": [ "element" ] }, { "type": "string", "enum": [ "coordinates" ] } ] }, "options": { "type": "object", "required": [ "mouse", "keyboard", "scroll", "navigation", "tabs", "native_controls", "extension_pages", "delay_min_ms", "delay_max_ms" ], "properties": { "mouse": { "type": "boolean" }, "keyboard": { "type": "boolean" }, "scroll": { "type": "boolean" }, "navigation": { "type": "boolean" }, "tabs": { "type": "boolean" }, "native_controls": { "type": "boolean" }, "extension_pages": { "type": "boolean" }, "delay_min_ms": { "type": "integer" }, "delay_max_ms": { "type": "integer" } } }, "tabs": { "type": "array", "items": { "type": "object", "required": [ "id", "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } }, "events": { "type": "integer" }, "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" } } } } } } }, "/api/v1/automation/synchronizer/stop": { "post": { "summary": "Live-Synchronisierung stoppen", "tags": [ "Automation" ], "x-required-scopes": [ "runtime:control", "sync:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "running", "source_id", "follower_ids", "mode", "options", "tabs", "events", "error" ], "properties": { "running": { "type": "boolean" }, "source_id": { "type": [ "string", "null" ] }, "follower_ids": { "type": "array", "items": { "type": "string" } }, "mode": { "anyOf": [ { "type": "string", "enum": [ "element" ] }, { "type": "string", "enum": [ "coordinates" ] } ] }, "options": { "type": "object", "required": [ "mouse", "keyboard", "scroll", "navigation", "tabs", "native_controls", "extension_pages", "delay_min_ms", "delay_max_ms" ], "properties": { "mouse": { "type": "boolean" }, "keyboard": { "type": "boolean" }, "scroll": { "type": "boolean" }, "navigation": { "type": "boolean" }, "tabs": { "type": "boolean" }, "native_controls": { "type": "boolean" }, "extension_pages": { "type": "boolean" }, "delay_min_ms": { "type": "integer" }, "delay_max_ms": { "type": "integer" } } }, "tabs": { "type": "array", "items": { "type": "object", "required": [ "id", "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } }, "events": { "type": "integer" }, "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" } } } } } } }, "/api/v1/automation/synchronizer/options": { "patch": { "summary": "Synchronizer-Optionen ändern", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "mouse": { "type": "boolean" }, "keyboard": { "type": "boolean" }, "scroll": { "type": "boolean" }, "navigation": { "type": "boolean" }, "tabs": { "type": "boolean" }, "native_controls": { "type": "boolean" }, "extension_pages": { "type": "boolean" }, "delay_min_ms": { "type": "integer", "minimum": 0, "maximum": 5000 }, "delay_max_ms": { "type": "integer", "minimum": 0, "maximum": 5000 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "sync:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "running", "source_id", "follower_ids", "mode", "options", "tabs", "events", "error" ], "properties": { "running": { "type": "boolean" }, "source_id": { "type": [ "string", "null" ] }, "follower_ids": { "type": "array", "items": { "type": "string" } }, "mode": { "anyOf": [ { "type": "string", "enum": [ "element" ] }, { "type": "string", "enum": [ "coordinates" ] } ] }, "options": { "type": "object", "required": [ "mouse", "keyboard", "scroll", "navigation", "tabs", "native_controls", "extension_pages", "delay_min_ms", "delay_max_ms" ], "properties": { "mouse": { "type": "boolean" }, "keyboard": { "type": "boolean" }, "scroll": { "type": "boolean" }, "navigation": { "type": "boolean" }, "tabs": { "type": "boolean" }, "native_controls": { "type": "boolean" }, "extension_pages": { "type": "boolean" }, "delay_min_ms": { "type": "integer" }, "delay_max_ms": { "type": "integer" } } }, "tabs": { "type": "array", "items": { "type": "object", "required": [ "id", "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } }, "events": { "type": "integer" }, "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" } } } } } } }, "/api/v1/automation/synchronizer/text": { "post": { "summary": "Text oder Zufallszahlen auf synchronisierte Fenster verteilen", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "target_id", "mode" ], "properties": { "target_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "selector": { "type": "string", "minLength": 1, "maxLength": 4000 }, "frames": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 4000 }, "maxItems": 16 }, "include_source": { "type": "boolean" }, "append": { "type": "boolean" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "same" ] }, { "type": "string", "enum": [ "lines" ] }, { "type": "string", "enum": [ "shuffle" ] }, { "type": "string", "enum": [ "random" ] } ] }, "text": { "type": "string", "maxLength": 210000 }, "minimum": { "type": "integer", "minimum": -1000000000, "maximum": 1000000000 }, "maximum": { "type": "integer", "minimum": -1000000000, "maximum": 1000000000 }, "unique": { "type": "boolean" }, "key_min_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "key_max_ms": { "type": "integer", "minimum": 0, "maximum": 2000 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "sync:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "ok" ], "properties": { "profile_id": { "type": "string" }, "ok": { "type": "boolean" }, "error": { "type": "string" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/synchronizer/tabs": { "post": { "summary": "Gemeinsame Tab-Befehle ausführen", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "action" ], "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "open" ] }, { "type": "string", "enum": [ "align" ] }, { "type": "string", "enum": [ "activate" ] }, { "type": "string", "enum": [ "reload" ] }, { "type": "string", "enum": [ "close" ] }, { "type": "string", "enum": [ "close_others" ] }, { "type": "string", "enum": [ "close_blank" ] } ] }, "target_id": { "type": "string", "minLength": 1, "maxLength": 128 }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 16000 }, "minItems": 1, "maxItems": 20 }, "reuse_current": { "type": "boolean" }, "close_extra": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "sync:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "running", "source_id", "follower_ids", "mode", "options", "tabs", "events", "error" ], "properties": { "running": { "type": "boolean" }, "source_id": { "type": [ "string", "null" ] }, "follower_ids": { "type": "array", "items": { "type": "string" } }, "mode": { "anyOf": [ { "type": "string", "enum": [ "element" ] }, { "type": "string", "enum": [ "coordinates" ] } ] }, "options": { "type": "object", "required": [ "mouse", "keyboard", "scroll", "navigation", "tabs", "native_controls", "extension_pages", "delay_min_ms", "delay_max_ms" ], "properties": { "mouse": { "type": "boolean" }, "keyboard": { "type": "boolean" }, "scroll": { "type": "boolean" }, "navigation": { "type": "boolean" }, "tabs": { "type": "boolean" }, "native_controls": { "type": "boolean" }, "extension_pages": { "type": "boolean" }, "delay_min_ms": { "type": "integer" }, "delay_max_ms": { "type": "integer" } } }, "tabs": { "type": "array", "items": { "type": "object", "required": [ "id", "url" ], "properties": { "id": { "type": "string" }, "url": { "type": "string" } } } }, "events": { "type": "integer" }, "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" } } } } } } }, "/api/v1/automation/package/export": { "post": { "summary": "Ausgewählte Abläufe und Vorlagen als verschlüsseltes Paket exportieren", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "target_path", "password" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000, "uniqueItems": true }, "target_path": { "type": "string", "minLength": 4, "maxLength": 1024 }, "password": { "type": "string", "minLength": 12, "maxLength": 1024 }, "include_secrets": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "secrets:read", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "path", "size_bytes", "sha256", "count" ], "properties": { "path": { "type": "string" }, "size_bytes": { "type": "integer" }, "sha256": { "type": "string" }, "count": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/package/preview": { "post": { "summary": "Verschlüsseltes Ablaufpaket prüfen und Inhalte ohne Eingabewerte anzeigen", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "path", "password" ], "properties": { "path": { "type": "string", "minLength": 4, "maxLength": 1024 }, "password": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "sha256", "created_at", "items" ], "properties": { "sha256": { "type": "string" }, "created_at": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "dependencies", "group", "description", "missing_values", "is_template", "steps", "protected_values" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "dependencies": { "type": "array", "items": { "type": "string" } }, "group": { "type": [ "string", "null" ] }, "description": { "type": [ "string", "null" ] }, "missing_values": { "type": "integer" }, "is_template": { "type": "boolean" }, "steps": { "type": "integer" }, "protected_values": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/package/import": { "post": { "summary": "Geprüfte Abläufe als neue Kopien ohne Profile und aktive Zeitpläne importieren", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "path", "password", "sha256", "ids" ], "properties": { "path": { "type": "string", "minLength": 4, "maxLength": 1024 }, "password": { "type": "string", "minLength": 1, "maxLength": 1024 }, "sha256": { "type": "string", "pattern": "^[a-f0-9]{64}$" }, "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000, "uniqueItems": true } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "is_template" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "is_template": { "type": "boolean" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/schedule/preview": { "post": { "summary": "Die nächsten fünf Startzeiten eines RPA-Zeitplans berechnen", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "next_at", "interval_minutes" ], "properties": { "next_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "interval_minutes": { "type": "integer", "minimum": 0, "maximum": 525600 }, "time_zone": { "type": "string", "minLength": 1, "maxLength": 128 }, "remaining_runs": { "type": "integer", "minimum": 1, "maximum": 100000 }, "end_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "revision": { "type": "string", "minLength": 1, "maxLength": 64 }, "calendar": { "type": "object", "required": [ "frequency", "start_date", "time" ], "properties": { "frequency": { "anyOf": [ { "type": "string", "enum": [ "daily" ] }, { "type": "string", "enum": [ "weekly" ] }, { "type": "string", "enum": [ "monthly" ] }, { "type": "string", "enum": [ "yearly" ] } ] }, "start_date": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "time": { "type": "string", "pattern": "^[0-9]{2}:[0-9]{2}$" }, "weekdays": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 }, "minItems": 1, "maxItems": 7, "uniqueItems": true }, "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "month_day": { "anyOf": [ { "type": "number", "enum": [ -1 ] }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "time_zone", "next_at", "starts" ], "properties": { "time_zone": { "type": "string" }, "next_at": { "type": "integer" }, "starts": { "type": "array", "items": { "type": "integer" } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/templates": { "get": { "summary": "Lokale RPA-Beispielvorlagen", "tags": [ "Automation" ], "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", "name", "description", "steps" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "steps": { "type": "array", "items": { "type": "object", "required": [ "action" ], "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "navigate" ] }, { "type": "string", "enum": [ "click" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string", "enum": [ "key" ] }, { "type": "string", "enum": [ "wait" ] }, { "type": "string", "enum": [ "wait_selector" ] }, { "type": "string", "enum": [ "extract" ] }, { "type": "string", "enum": [ "page_data" ] }, { "type": "string", "enum": [ "tab_open" ] }, { "type": "string", "enum": [ "tab_switch" ] }, { "type": "string", "enum": [ "tab_close" ] }, { "type": "string", "enum": [ "frame_enter" ] }, { "type": "string", "enum": [ "frame_parent" ] }, { "type": "string", "enum": [ "frame_top" ] }, { "type": "string", "enum": [ "reload" ] }, { "type": "string", "enum": [ "hover" ] }, { "type": "string", "enum": [ "double_click" ] }, { "type": "string", "enum": [ "right_click" ] }, { "type": "string", "enum": [ "scroll" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "attribute" ] }, { "type": "string", "enum": [ "screenshot" ] }, { "type": "string", "enum": [ "cookies_get" ] }, { "type": "string", "enum": [ "cookies_set" ] }, { "type": "string", "enum": [ "cookies_delete" ] }, { "type": "string", "enum": [ "focus" ] }, { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "attribute_set" ] }, { "type": "string", "enum": [ "mouse_move" ] }, { "type": "string", "enum": [ "wheel" ] }, { "type": "string", "enum": [ "history_back" ] }, { "type": "string", "enum": [ "history_forward" ] }, { "type": "string", "enum": [ "tab_list" ] }, { "type": "string", "enum": [ "tab_activate" ] }, { "type": "string", "enum": [ "script" ] }, { "type": "string", "enum": [ "workflow_call" ] }, { "type": "string", "enum": [ "branch" ] }, { "type": "string", "enum": [ "loop_count" ] }, { "type": "string", "enum": [ "loop_data" ] }, { "type": "string", "enum": [ "loop_elements" ] }, { "type": "string", "enum": [ "element_capture" ] }, { "type": "string", "enum": [ "element_release" ] }, { "type": "string", "enum": [ "loop_while" ] }, { "type": "string", "enum": [ "loop_break" ] }, { "type": "string", "enum": [ "loop_continue" ] }, { "type": "string", "enum": [ "variable_set" ] }, { "type": "string", "enum": [ "global" ] }, { "type": "string", "enum": [ "data_transform" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "service" ] }, { "type": "string", "enum": [ "network" ] } ] }, "data": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "csv_parse" ] }, { "type": "string", "enum": [ "csv_stringify" ] }, { "type": "string", "enum": [ "table_cell" ] }, { "type": "string", "enum": [ "table_set" ] }, { "type": "string", "enum": [ "table_row" ] }, { "type": "string", "enum": [ "table_column" ] }, { "type": "string", "enum": [ "table_append" ] }, { "type": "string", "enum": [ "table_slice" ] }, { "type": "string", "enum": [ "json_parse" ] }, { "type": "string", "enum": [ "json_get" ] }, { "type": "string", "enum": [ "json_keys" ] }, { "type": "string", "enum": [ "list_length" ] }, { "type": "string", "enum": [ "list_join" ] }, { "type": "string", "enum": [ "list_append" ] }, { "type": "string", "enum": [ "list_random" ] }, { "type": "string", "enum": [ "text_split" ] }, { "type": "string", "enum": [ "text_replace" ] }, { "type": "string", "enum": [ "regex_extract" ] }, { "type": "string", "enum": [ "regex_replace" ] }, { "type": "string", "enum": [ "text_trim" ] }, { "type": "string", "enum": [ "text_lower" ] }, { "type": "string", "enum": [ "text_upper" ] }, { "type": "string", "enum": [ "number_add" ] }, { "type": "string", "enum": [ "number_subtract" ] }, { "type": "string", "enum": [ "number_multiply" ] }, { "type": "string", "enum": [ "number_divide" ] }, { "type": "string", "enum": [ "number_remainder" ] }, { "type": "string", "enum": [ "url_parse" ] }, { "type": "string", "enum": [ "url_parameter" ] }, { "type": "string", "enum": [ "random_integer" ] }, { "type": "string", "enum": [ "random_text" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "global": { "type": "object", "required": [ "operation", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "delete" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "page_data": { "anyOf": [ { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "html" ] }, { "type": "string", "enum": [ "links" ] }, { "type": "string", "enum": [ "images" ] }, { "type": "string", "enum": [ "form_values" ] }, { "type": "string", "enum": [ "element_count" ] } ] }, "file": { "type": "object", "required": [ "operation", "format", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "append" ] } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "txt" ] }, { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "csv" ] }, { "type": "string", "enum": [ "xlsx" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "delimiter": { "anyOf": [ { "type": "string", "enum": [ "," ] }, { "type": "string", "enum": [ ";" ] }, { "type": "string", "enum": [ "\t" ] }, { "type": "string", "enum": [ "|" ] } ] }, "sheet": { "type": "string", "minLength": 1, "maxLength": 31 }, "overwrite": { "type": "boolean" } }, "additionalProperties": false }, "service": { "type": "object", "required": [ "kind" ], "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "http" ] }, { "type": "string", "enum": [ "google_sheets" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "network": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "stop" ] } ] }, "url_contains": { "type": "string", "maxLength": 2000 }, "phase": { "anyOf": [ { "type": "string", "enum": [ "all" ] }, { "type": "string", "enum": [ "request" ] }, { "type": "string", "enum": [ "response" ] }, { "type": "string", "enum": [ "error" ] } ] }, "include_headers": { "type": "boolean" }, "include_bodies": { "type": "boolean" }, "max_events": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "additionalProperties": false }, "selector": { "type": "string", "maxLength": 2000 }, "element_ref": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "else_workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "predicate": { "type": "object", "required": [ "variable", "operator" ], "properties": { "variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "operator": { "anyOf": [ { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "not_exists" ] }, { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] }, { "type": "string", "enum": [ "less" ] }, { "type": "string", "enum": [ "less_equal" ] }, { "type": "string", "enum": [ "greater" ] }, { "type": "string", "enum": [ "greater_equal" ] }, { "type": "string", "enum": [ "one_of" ] }, { "type": "string", "enum": [ "not_one_of" ] } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "number" ] } ] } }, "additionalProperties": false }, "data_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "item_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "index_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "loop_start": { "type": "integer", "minimum": 0, "maximum": 9999 }, "max_iterations": { "type": "integer", "minimum": 1, "maximum": 10000 }, "script_variables": { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "maxItems": 64, "uniqueItems": true }, "element_index": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_min": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_max": { "type": "integer", "minimum": 1, "maximum": 100000 }, "tab_match": { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "previous" ] }, { "type": "string", "enum": [ "index" ] } ] }, "tab_compare": { "anyOf": [ { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] } ] }, "tab_wrap": { "type": "boolean" }, "scroll_x": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "scroll_y": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "full_page": { "type": "boolean" }, "screenshot_format": { "anyOf": [ { "type": "string", "enum": [ "png" ] }, { "type": "string", "enum": [ "jpeg" ] } ] }, "screenshot_frame_content": { "type": "boolean" }, "screenshot_output": { "anyOf": [ { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "base64" ] } ] }, "screenshot_quality": { "type": "integer", "minimum": 0, "maximum": 100 }, "screenshot_name": { "type": "string", "maxLength": 100 }, "pointer_x": { "type": "integer", "minimum": 0, "maximum": 100000 }, "pointer_y": { "type": "integer", "minimum": 0, "maximum": 100000 }, "wait_ms": { "type": "integer", "minimum": 0, "maximum": 119000 }, "attribute_name": { "type": "string", "minLength": 1, "maxLength": 256 }, "secret_value": { "type": "boolean" }, "value_missing": { "type": "boolean" }, "cookie_domain": { "type": "string", "maxLength": 253 }, "cookie_name": { "type": "string", "maxLength": 1024 }, "cookie_path": { "type": "string", "maxLength": 2048 }, "cookie_mode": { "anyOf": [ { "type": "string", "enum": [ "merge" ] }, { "type": "string", "enum": [ "replace" ] } ] }, "cookie_output": { "anyOf": [ { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] }, { "type": "string", "enum": [ "value" ] } ] }, "value": { "type": "string", "maxLength": 10000 }, "save_as": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "repeat": { "type": "integer", "minimum": 1, "maximum": 100 }, "retries": { "type": "integer", "minimum": 0, "maximum": 5 }, "timeout_ms": { "type": "integer", "minimum": 100, "maximum": 120000 }, "on_error": { "anyOf": [ { "type": "string", "enum": [ "stop" ] }, { "type": "string", "enum": [ "continue" ] } ] }, "condition": { "type": "object", "required": [ "variable", "equals" ], "properties": { "variable": { "type": "string", "maxLength": 64 }, "equals": { "type": "string", "maxLength": 10000 } }, "additionalProperties": false } }, "additionalProperties": false }, "minItems": 1, "maxItems": 200 } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/groups": { "get": { "summary": "Ablaufgruppen mit Anzahl", "tags": [ "Automation" ], "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": [ "name", "count" ], "properties": { "name": { "type": "string" }, "count": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Ablaufgruppe umbenennen oder Zuordnung entfernen", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "new_name" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 80 }, "new_name": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 80 }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "name", "count" ], "properties": { "name": { "type": "string" }, "count": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/workflows/{id}/copy": { "post": { "summary": "Ablauf oder eigene Vorlage kopieren", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "as_template": { "type": "boolean" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "runtime:control", "rpa:write", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "steps", "profile_ids", "concurrency", "close_after", "delay_ms", "schedule", "id" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "group": { "type": "string", "maxLength": 80 }, "description": { "type": "string", "maxLength": 2000 }, "is_template": { "type": "boolean" }, "steps": { "type": "array", "items": { "type": "object", "required": [ "action" ], "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "navigate" ] }, { "type": "string", "enum": [ "click" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string", "enum": [ "key" ] }, { "type": "string", "enum": [ "wait" ] }, { "type": "string", "enum": [ "wait_selector" ] }, { "type": "string", "enum": [ "extract" ] }, { "type": "string", "enum": [ "page_data" ] }, { "type": "string", "enum": [ "tab_open" ] }, { "type": "string", "enum": [ "tab_switch" ] }, { "type": "string", "enum": [ "tab_close" ] }, { "type": "string", "enum": [ "frame_enter" ] }, { "type": "string", "enum": [ "frame_parent" ] }, { "type": "string", "enum": [ "frame_top" ] }, { "type": "string", "enum": [ "reload" ] }, { "type": "string", "enum": [ "hover" ] }, { "type": "string", "enum": [ "double_click" ] }, { "type": "string", "enum": [ "right_click" ] }, { "type": "string", "enum": [ "scroll" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "attribute" ] }, { "type": "string", "enum": [ "screenshot" ] }, { "type": "string", "enum": [ "cookies_get" ] }, { "type": "string", "enum": [ "cookies_set" ] }, { "type": "string", "enum": [ "cookies_delete" ] }, { "type": "string", "enum": [ "focus" ] }, { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "attribute_set" ] }, { "type": "string", "enum": [ "mouse_move" ] }, { "type": "string", "enum": [ "wheel" ] }, { "type": "string", "enum": [ "history_back" ] }, { "type": "string", "enum": [ "history_forward" ] }, { "type": "string", "enum": [ "tab_list" ] }, { "type": "string", "enum": [ "tab_activate" ] }, { "type": "string", "enum": [ "script" ] }, { "type": "string", "enum": [ "workflow_call" ] }, { "type": "string", "enum": [ "branch" ] }, { "type": "string", "enum": [ "loop_count" ] }, { "type": "string", "enum": [ "loop_data" ] }, { "type": "string", "enum": [ "loop_elements" ] }, { "type": "string", "enum": [ "element_capture" ] }, { "type": "string", "enum": [ "element_release" ] }, { "type": "string", "enum": [ "loop_while" ] }, { "type": "string", "enum": [ "loop_break" ] }, { "type": "string", "enum": [ "loop_continue" ] }, { "type": "string", "enum": [ "variable_set" ] }, { "type": "string", "enum": [ "global" ] }, { "type": "string", "enum": [ "data_transform" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "service" ] }, { "type": "string", "enum": [ "network" ] } ] }, "data": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "csv_parse" ] }, { "type": "string", "enum": [ "csv_stringify" ] }, { "type": "string", "enum": [ "table_cell" ] }, { "type": "string", "enum": [ "table_set" ] }, { "type": "string", "enum": [ "table_row" ] }, { "type": "string", "enum": [ "table_column" ] }, { "type": "string", "enum": [ "table_append" ] }, { "type": "string", "enum": [ "table_slice" ] }, { "type": "string", "enum": [ "json_parse" ] }, { "type": "string", "enum": [ "json_get" ] }, { "type": "string", "enum": [ "json_keys" ] }, { "type": "string", "enum": [ "list_length" ] }, { "type": "string", "enum": [ "list_join" ] }, { "type": "string", "enum": [ "list_append" ] }, { "type": "string", "enum": [ "list_random" ] }, { "type": "string", "enum": [ "text_split" ] }, { "type": "string", "enum": [ "text_replace" ] }, { "type": "string", "enum": [ "regex_extract" ] }, { "type": "string", "enum": [ "regex_replace" ] }, { "type": "string", "enum": [ "text_trim" ] }, { "type": "string", "enum": [ "text_lower" ] }, { "type": "string", "enum": [ "text_upper" ] }, { "type": "string", "enum": [ "number_add" ] }, { "type": "string", "enum": [ "number_subtract" ] }, { "type": "string", "enum": [ "number_multiply" ] }, { "type": "string", "enum": [ "number_divide" ] }, { "type": "string", "enum": [ "number_remainder" ] }, { "type": "string", "enum": [ "url_parse" ] }, { "type": "string", "enum": [ "url_parameter" ] }, { "type": "string", "enum": [ "random_integer" ] }, { "type": "string", "enum": [ "random_text" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "global": { "type": "object", "required": [ "operation", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "delete" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "page_data": { "anyOf": [ { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "html" ] }, { "type": "string", "enum": [ "links" ] }, { "type": "string", "enum": [ "images" ] }, { "type": "string", "enum": [ "form_values" ] }, { "type": "string", "enum": [ "element_count" ] } ] }, "file": { "type": "object", "required": [ "operation", "format", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "append" ] } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "txt" ] }, { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "csv" ] }, { "type": "string", "enum": [ "xlsx" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "delimiter": { "anyOf": [ { "type": "string", "enum": [ "," ] }, { "type": "string", "enum": [ ";" ] }, { "type": "string", "enum": [ "\t" ] }, { "type": "string", "enum": [ "|" ] } ] }, "sheet": { "type": "string", "minLength": 1, "maxLength": 31 }, "overwrite": { "type": "boolean" } }, "additionalProperties": false }, "service": { "type": "object", "required": [ "kind" ], "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "http" ] }, { "type": "string", "enum": [ "google_sheets" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "network": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "stop" ] } ] }, "url_contains": { "type": "string", "maxLength": 2000 }, "phase": { "anyOf": [ { "type": "string", "enum": [ "all" ] }, { "type": "string", "enum": [ "request" ] }, { "type": "string", "enum": [ "response" ] }, { "type": "string", "enum": [ "error" ] } ] }, "include_headers": { "type": "boolean" }, "include_bodies": { "type": "boolean" }, "max_events": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "additionalProperties": false }, "selector": { "type": "string", "maxLength": 2000 }, "element_ref": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "else_workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "predicate": { "type": "object", "required": [ "variable", "operator" ], "properties": { "variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "operator": { "anyOf": [ { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "not_exists" ] }, { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] }, { "type": "string", "enum": [ "less" ] }, { "type": "string", "enum": [ "less_equal" ] }, { "type": "string", "enum": [ "greater" ] }, { "type": "string", "enum": [ "greater_equal" ] }, { "type": "string", "enum": [ "one_of" ] }, { "type": "string", "enum": [ "not_one_of" ] } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "number" ] } ] } }, "additionalProperties": false }, "data_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "item_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "index_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "loop_start": { "type": "integer", "minimum": 0, "maximum": 9999 }, "max_iterations": { "type": "integer", "minimum": 1, "maximum": 10000 }, "script_variables": { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "maxItems": 64, "uniqueItems": true }, "element_index": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_min": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_max": { "type": "integer", "minimum": 1, "maximum": 100000 }, "tab_match": { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "previous" ] }, { "type": "string", "enum": [ "index" ] } ] }, "tab_compare": { "anyOf": [ { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] } ] }, "tab_wrap": { "type": "boolean" }, "scroll_x": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "scroll_y": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "full_page": { "type": "boolean" }, "screenshot_format": { "anyOf": [ { "type": "string", "enum": [ "png" ] }, { "type": "string", "enum": [ "jpeg" ] } ] }, "screenshot_frame_content": { "type": "boolean" }, "screenshot_output": { "anyOf": [ { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "base64" ] } ] }, "screenshot_quality": { "type": "integer", "minimum": 0, "maximum": 100 }, "screenshot_name": { "type": "string", "maxLength": 100 }, "pointer_x": { "type": "integer", "minimum": 0, "maximum": 100000 }, "pointer_y": { "type": "integer", "minimum": 0, "maximum": 100000 }, "wait_ms": { "type": "integer", "minimum": 0, "maximum": 119000 }, "attribute_name": { "type": "string", "minLength": 1, "maxLength": 256 }, "secret_value": { "type": "boolean" }, "value_missing": { "type": "boolean" }, "cookie_domain": { "type": "string", "maxLength": 253 }, "cookie_name": { "type": "string", "maxLength": 1024 }, "cookie_path": { "type": "string", "maxLength": 2048 }, "cookie_mode": { "anyOf": [ { "type": "string", "enum": [ "merge" ] }, { "type": "string", "enum": [ "replace" ] } ] }, "cookie_output": { "anyOf": [ { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] }, { "type": "string", "enum": [ "value" ] } ] }, "value": { "type": "string", "maxLength": 10000 }, "save_as": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "repeat": { "type": "integer", "minimum": 1, "maximum": 100 }, "retries": { "type": "integer", "minimum": 0, "maximum": 5 }, "timeout_ms": { "type": "integer", "minimum": 100, "maximum": 120000 }, "on_error": { "anyOf": [ { "type": "string", "enum": [ "stop" ] }, { "type": "string", "enum": [ "continue" ] } ] }, "condition": { "type": "object", "required": [ "variable", "equals" ], "properties": { "variable": { "type": "string", "maxLength": 64 }, "equals": { "type": "string", "maxLength": 10000 } }, "additionalProperties": false } }, "additionalProperties": false }, "minItems": 1, "maxItems": 200 }, "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 500, "uniqueItems": true }, "concurrency": { "type": "integer", "minimum": 1, "maximum": 20 }, "close_after": { "type": "boolean" }, "headless": { "type": "boolean" }, "delay_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "input_timing": { "type": "object", "required": [ "key_min_ms", "key_max_ms", "step_jitter_ms" ], "properties": { "key_min_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "key_max_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "step_jitter_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "mouse_min_ms": { "type": "integer", "minimum": 0, "maximum": 5000 }, "mouse_max_ms": { "type": "integer", "minimum": 0, "maximum": 5000 } }, "additionalProperties": false }, "schedule": { "anyOf": [ { "type": "object", "required": [ "next_at", "interval_minutes" ], "properties": { "next_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "interval_minutes": { "type": "integer", "minimum": 0, "maximum": 525600 }, "time_zone": { "type": "string", "minLength": 1, "maxLength": 128 }, "remaining_runs": { "type": "integer", "minimum": 1, "maximum": 100000 }, "end_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "revision": { "type": "string", "minLength": 1, "maxLength": 64 }, "calendar": { "type": "object", "required": [ "frequency", "start_date", "time" ], "properties": { "frequency": { "anyOf": [ { "type": "string", "enum": [ "daily" ] }, { "type": "string", "enum": [ "weekly" ] }, { "type": "string", "enum": [ "monthly" ] }, { "type": "string", "enum": [ "yearly" ] } ] }, "start_date": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "time": { "type": "string", "pattern": "^[0-9]{2}:[0-9]{2}$" }, "weekdays": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 }, "minItems": 1, "maxItems": 7, "uniqueItems": true }, "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "month_day": { "anyOf": [ { "type": "number", "enum": [ -1 ] }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "id": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/workflows": { "get": { "summary": "Gespeicherte RPA-Abläufe", "tags": [ "Automation" ], "x-required-scopes": [ "runtime:control", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "name", "steps", "profile_ids", "concurrency", "close_after", "delay_ms", "schedule", "id" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "group": { "type": "string", "maxLength": 80 }, "description": { "type": "string", "maxLength": 2000 }, "is_template": { "type": "boolean" }, "steps": { "type": "array", "items": { "type": "object", "required": [ "action" ], "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "navigate" ] }, { "type": "string", "enum": [ "click" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string", "enum": [ "key" ] }, { "type": "string", "enum": [ "wait" ] }, { "type": "string", "enum": [ "wait_selector" ] }, { "type": "string", "enum": [ "extract" ] }, { "type": "string", "enum": [ "page_data" ] }, { "type": "string", "enum": [ "tab_open" ] }, { "type": "string", "enum": [ "tab_switch" ] }, { "type": "string", "enum": [ "tab_close" ] }, { "type": "string", "enum": [ "frame_enter" ] }, { "type": "string", "enum": [ "frame_parent" ] }, { "type": "string", "enum": [ "frame_top" ] }, { "type": "string", "enum": [ "reload" ] }, { "type": "string", "enum": [ "hover" ] }, { "type": "string", "enum": [ "double_click" ] }, { "type": "string", "enum": [ "right_click" ] }, { "type": "string", "enum": [ "scroll" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "attribute" ] }, { "type": "string", "enum": [ "screenshot" ] }, { "type": "string", "enum": [ "cookies_get" ] }, { "type": "string", "enum": [ "cookies_set" ] }, { "type": "string", "enum": [ "cookies_delete" ] }, { "type": "string", "enum": [ "focus" ] }, { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "attribute_set" ] }, { "type": "string", "enum": [ "mouse_move" ] }, { "type": "string", "enum": [ "wheel" ] }, { "type": "string", "enum": [ "history_back" ] }, { "type": "string", "enum": [ "history_forward" ] }, { "type": "string", "enum": [ "tab_list" ] }, { "type": "string", "enum": [ "tab_activate" ] }, { "type": "string", "enum": [ "script" ] }, { "type": "string", "enum": [ "workflow_call" ] }, { "type": "string", "enum": [ "branch" ] }, { "type": "string", "enum": [ "loop_count" ] }, { "type": "string", "enum": [ "loop_data" ] }, { "type": "string", "enum": [ "loop_elements" ] }, { "type": "string", "enum": [ "element_capture" ] }, { "type": "string", "enum": [ "element_release" ] }, { "type": "string", "enum": [ "loop_while" ] }, { "type": "string", "enum": [ "loop_break" ] }, { "type": "string", "enum": [ "loop_continue" ] }, { "type": "string", "enum": [ "variable_set" ] }, { "type": "string", "enum": [ "global" ] }, { "type": "string", "enum": [ "data_transform" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "service" ] }, { "type": "string", "enum": [ "network" ] } ] }, "data": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "csv_parse" ] }, { "type": "string", "enum": [ "csv_stringify" ] }, { "type": "string", "enum": [ "table_cell" ] }, { "type": "string", "enum": [ "table_set" ] }, { "type": "string", "enum": [ "table_row" ] }, { "type": "string", "enum": [ "table_column" ] }, { "type": "string", "enum": [ "table_append" ] }, { "type": "string", "enum": [ "table_slice" ] }, { "type": "string", "enum": [ "json_parse" ] }, { "type": "string", "enum": [ "json_get" ] }, { "type": "string", "enum": [ "json_keys" ] }, { "type": "string", "enum": [ "list_length" ] }, { "type": "string", "enum": [ "list_join" ] }, { "type": "string", "enum": [ "list_append" ] }, { "type": "string", "enum": [ "list_random" ] }, { "type": "string", "enum": [ "text_split" ] }, { "type": "string", "enum": [ "text_replace" ] }, { "type": "string", "enum": [ "regex_extract" ] }, { "type": "string", "enum": [ "regex_replace" ] }, { "type": "string", "enum": [ "text_trim" ] }, { "type": "string", "enum": [ "text_lower" ] }, { "type": "string", "enum": [ "text_upper" ] }, { "type": "string", "enum": [ "number_add" ] }, { "type": "string", "enum": [ "number_subtract" ] }, { "type": "string", "enum": [ "number_multiply" ] }, { "type": "string", "enum": [ "number_divide" ] }, { "type": "string", "enum": [ "number_remainder" ] }, { "type": "string", "enum": [ "url_parse" ] }, { "type": "string", "enum": [ "url_parameter" ] }, { "type": "string", "enum": [ "random_integer" ] }, { "type": "string", "enum": [ "random_text" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "global": { "type": "object", "required": [ "operation", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "delete" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "page_data": { "anyOf": [ { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "html" ] }, { "type": "string", "enum": [ "links" ] }, { "type": "string", "enum": [ "images" ] }, { "type": "string", "enum": [ "form_values" ] }, { "type": "string", "enum": [ "element_count" ] } ] }, "file": { "type": "object", "required": [ "operation", "format", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "append" ] } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "txt" ] }, { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "csv" ] }, { "type": "string", "enum": [ "xlsx" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "delimiter": { "anyOf": [ { "type": "string", "enum": [ "," ] }, { "type": "string", "enum": [ ";" ] }, { "type": "string", "enum": [ "\t" ] }, { "type": "string", "enum": [ "|" ] } ] }, "sheet": { "type": "string", "minLength": 1, "maxLength": 31 }, "overwrite": { "type": "boolean" } }, "additionalProperties": false }, "service": { "type": "object", "required": [ "kind" ], "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "http" ] }, { "type": "string", "enum": [ "google_sheets" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "network": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "stop" ] } ] }, "url_contains": { "type": "string", "maxLength": 2000 }, "phase": { "anyOf": [ { "type": "string", "enum": [ "all" ] }, { "type": "string", "enum": [ "request" ] }, { "type": "string", "enum": [ "response" ] }, { "type": "string", "enum": [ "error" ] } ] }, "include_headers": { "type": "boolean" }, "include_bodies": { "type": "boolean" }, "max_events": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "additionalProperties": false }, "selector": { "type": "string", "maxLength": 2000 }, "element_ref": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "else_workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "predicate": { "type": "object", "required": [ "variable", "operator" ], "properties": { "variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "operator": { "anyOf": [ { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "not_exists" ] }, { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] }, { "type": "string", "enum": [ "less" ] }, { "type": "string", "enum": [ "less_equal" ] }, { "type": "string", "enum": [ "greater" ] }, { "type": "string", "enum": [ "greater_equal" ] }, { "type": "string", "enum": [ "one_of" ] }, { "type": "string", "enum": [ "not_one_of" ] } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "number" ] } ] } }, "additionalProperties": false }, "data_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "item_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "index_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "loop_start": { "type": "integer", "minimum": 0, "maximum": 9999 }, "max_iterations": { "type": "integer", "minimum": 1, "maximum": 10000 }, "script_variables": { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "maxItems": 64, "uniqueItems": true }, "element_index": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_min": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_max": { "type": "integer", "minimum": 1, "maximum": 100000 }, "tab_match": { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "previous" ] }, { "type": "string", "enum": [ "index" ] } ] }, "tab_compare": { "anyOf": [ { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] } ] }, "tab_wrap": { "type": "boolean" }, "scroll_x": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "scroll_y": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "full_page": { "type": "boolean" }, "screenshot_format": { "anyOf": [ { "type": "string", "enum": [ "png" ] }, { "type": "string", "enum": [ "jpeg" ] } ] }, "screenshot_frame_content": { "type": "boolean" }, "screenshot_output": { "anyOf": [ { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "base64" ] } ] }, "screenshot_quality": { "type": "integer", "minimum": 0, "maximum": 100 }, "screenshot_name": { "type": "string", "maxLength": 100 }, "pointer_x": { "type": "integer", "minimum": 0, "maximum": 100000 }, "pointer_y": { "type": "integer", "minimum": 0, "maximum": 100000 }, "wait_ms": { "type": "integer", "minimum": 0, "maximum": 119000 }, "attribute_name": { "type": "string", "minLength": 1, "maxLength": 256 }, "secret_value": { "type": "boolean" }, "value_missing": { "type": "boolean" }, "cookie_domain": { "type": "string", "maxLength": 253 }, "cookie_name": { "type": "string", "maxLength": 1024 }, "cookie_path": { "type": "string", "maxLength": 2048 }, "cookie_mode": { "anyOf": [ { "type": "string", "enum": [ "merge" ] }, { "type": "string", "enum": [ "replace" ] } ] }, "cookie_output": { "anyOf": [ { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] }, { "type": "string", "enum": [ "value" ] } ] }, "value": { "type": "string", "maxLength": 10000 }, "save_as": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "repeat": { "type": "integer", "minimum": 1, "maximum": 100 }, "retries": { "type": "integer", "minimum": 0, "maximum": 5 }, "timeout_ms": { "type": "integer", "minimum": 100, "maximum": 120000 }, "on_error": { "anyOf": [ { "type": "string", "enum": [ "stop" ] }, { "type": "string", "enum": [ "continue" ] } ] }, "condition": { "type": "object", "required": [ "variable", "equals" ], "properties": { "variable": { "type": "string", "maxLength": 64 }, "equals": { "type": "string", "maxLength": 10000 } }, "additionalProperties": false } }, "additionalProperties": false }, "minItems": 1, "maxItems": 200 }, "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 500, "uniqueItems": true }, "concurrency": { "type": "integer", "minimum": 1, "maximum": 20 }, "close_after": { "type": "boolean" }, "headless": { "type": "boolean" }, "delay_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "input_timing": { "type": "object", "required": [ "key_min_ms", "key_max_ms", "step_jitter_ms" ], "properties": { "key_min_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "key_max_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "step_jitter_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "mouse_min_ms": { "type": "integer", "minimum": 0, "maximum": 5000 }, "mouse_max_ms": { "type": "integer", "minimum": 0, "maximum": 5000 } }, "additionalProperties": false }, "schedule": { "anyOf": [ { "type": "object", "required": [ "next_at", "interval_minutes" ], "properties": { "next_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "interval_minutes": { "type": "integer", "minimum": 0, "maximum": 525600 }, "time_zone": { "type": "string", "minLength": 1, "maxLength": 128 }, "remaining_runs": { "type": "integer", "minimum": 1, "maximum": 100000 }, "end_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "revision": { "type": "string", "minLength": 1, "maxLength": 64 }, "calendar": { "type": "object", "required": [ "frequency", "start_date", "time" ], "properties": { "frequency": { "anyOf": [ { "type": "string", "enum": [ "daily" ] }, { "type": "string", "enum": [ "weekly" ] }, { "type": "string", "enum": [ "monthly" ] }, { "type": "string", "enum": [ "yearly" ] } ] }, "start_date": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "time": { "type": "string", "pattern": "^[0-9]{2}:[0-9]{2}$" }, "weekdays": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 }, "minItems": 1, "maxItems": 7, "uniqueItems": true }, "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "month_day": { "anyOf": [ { "type": "number", "enum": [ -1 ] }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "id": { "type": "string" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "RPA-Ablauf speichern", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "steps", "profile_ids", "concurrency", "close_after", "delay_ms", "schedule" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "group": { "type": "string", "maxLength": 80 }, "description": { "type": "string", "maxLength": 2000 }, "is_template": { "type": "boolean" }, "steps": { "type": "array", "items": { "type": "object", "required": [ "action" ], "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "navigate" ] }, { "type": "string", "enum": [ "click" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string", "enum": [ "key" ] }, { "type": "string", "enum": [ "wait" ] }, { "type": "string", "enum": [ "wait_selector" ] }, { "type": "string", "enum": [ "extract" ] }, { "type": "string", "enum": [ "page_data" ] }, { "type": "string", "enum": [ "tab_open" ] }, { "type": "string", "enum": [ "tab_switch" ] }, { "type": "string", "enum": [ "tab_close" ] }, { "type": "string", "enum": [ "frame_enter" ] }, { "type": "string", "enum": [ "frame_parent" ] }, { "type": "string", "enum": [ "frame_top" ] }, { "type": "string", "enum": [ "reload" ] }, { "type": "string", "enum": [ "hover" ] }, { "type": "string", "enum": [ "double_click" ] }, { "type": "string", "enum": [ "right_click" ] }, { "type": "string", "enum": [ "scroll" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "attribute" ] }, { "type": "string", "enum": [ "screenshot" ] }, { "type": "string", "enum": [ "cookies_get" ] }, { "type": "string", "enum": [ "cookies_set" ] }, { "type": "string", "enum": [ "cookies_delete" ] }, { "type": "string", "enum": [ "focus" ] }, { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "attribute_set" ] }, { "type": "string", "enum": [ "mouse_move" ] }, { "type": "string", "enum": [ "wheel" ] }, { "type": "string", "enum": [ "history_back" ] }, { "type": "string", "enum": [ "history_forward" ] }, { "type": "string", "enum": [ "tab_list" ] }, { "type": "string", "enum": [ "tab_activate" ] }, { "type": "string", "enum": [ "script" ] }, { "type": "string", "enum": [ "workflow_call" ] }, { "type": "string", "enum": [ "branch" ] }, { "type": "string", "enum": [ "loop_count" ] }, { "type": "string", "enum": [ "loop_data" ] }, { "type": "string", "enum": [ "loop_elements" ] }, { "type": "string", "enum": [ "element_capture" ] }, { "type": "string", "enum": [ "element_release" ] }, { "type": "string", "enum": [ "loop_while" ] }, { "type": "string", "enum": [ "loop_break" ] }, { "type": "string", "enum": [ "loop_continue" ] }, { "type": "string", "enum": [ "variable_set" ] }, { "type": "string", "enum": [ "global" ] }, { "type": "string", "enum": [ "data_transform" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "service" ] }, { "type": "string", "enum": [ "network" ] } ] }, "data": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "csv_parse" ] }, { "type": "string", "enum": [ "csv_stringify" ] }, { "type": "string", "enum": [ "table_cell" ] }, { "type": "string", "enum": [ "table_set" ] }, { "type": "string", "enum": [ "table_row" ] }, { "type": "string", "enum": [ "table_column" ] }, { "type": "string", "enum": [ "table_append" ] }, { "type": "string", "enum": [ "table_slice" ] }, { "type": "string", "enum": [ "json_parse" ] }, { "type": "string", "enum": [ "json_get" ] }, { "type": "string", "enum": [ "json_keys" ] }, { "type": "string", "enum": [ "list_length" ] }, { "type": "string", "enum": [ "list_join" ] }, { "type": "string", "enum": [ "list_append" ] }, { "type": "string", "enum": [ "list_random" ] }, { "type": "string", "enum": [ "text_split" ] }, { "type": "string", "enum": [ "text_replace" ] }, { "type": "string", "enum": [ "regex_extract" ] }, { "type": "string", "enum": [ "regex_replace" ] }, { "type": "string", "enum": [ "text_trim" ] }, { "type": "string", "enum": [ "text_lower" ] }, { "type": "string", "enum": [ "text_upper" ] }, { "type": "string", "enum": [ "number_add" ] }, { "type": "string", "enum": [ "number_subtract" ] }, { "type": "string", "enum": [ "number_multiply" ] }, { "type": "string", "enum": [ "number_divide" ] }, { "type": "string", "enum": [ "number_remainder" ] }, { "type": "string", "enum": [ "url_parse" ] }, { "type": "string", "enum": [ "url_parameter" ] }, { "type": "string", "enum": [ "random_integer" ] }, { "type": "string", "enum": [ "random_text" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "global": { "type": "object", "required": [ "operation", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "delete" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "page_data": { "anyOf": [ { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "html" ] }, { "type": "string", "enum": [ "links" ] }, { "type": "string", "enum": [ "images" ] }, { "type": "string", "enum": [ "form_values" ] }, { "type": "string", "enum": [ "element_count" ] } ] }, "file": { "type": "object", "required": [ "operation", "format", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "append" ] } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "txt" ] }, { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "csv" ] }, { "type": "string", "enum": [ "xlsx" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "delimiter": { "anyOf": [ { "type": "string", "enum": [ "," ] }, { "type": "string", "enum": [ ";" ] }, { "type": "string", "enum": [ "\t" ] }, { "type": "string", "enum": [ "|" ] } ] }, "sheet": { "type": "string", "minLength": 1, "maxLength": 31 }, "overwrite": { "type": "boolean" } }, "additionalProperties": false }, "service": { "type": "object", "required": [ "kind" ], "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "http" ] }, { "type": "string", "enum": [ "google_sheets" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "network": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "stop" ] } ] }, "url_contains": { "type": "string", "maxLength": 2000 }, "phase": { "anyOf": [ { "type": "string", "enum": [ "all" ] }, { "type": "string", "enum": [ "request" ] }, { "type": "string", "enum": [ "response" ] }, { "type": "string", "enum": [ "error" ] } ] }, "include_headers": { "type": "boolean" }, "include_bodies": { "type": "boolean" }, "max_events": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "additionalProperties": false }, "selector": { "type": "string", "maxLength": 2000 }, "element_ref": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "else_workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "predicate": { "type": "object", "required": [ "variable", "operator" ], "properties": { "variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "operator": { "anyOf": [ { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "not_exists" ] }, { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] }, { "type": "string", "enum": [ "less" ] }, { "type": "string", "enum": [ "less_equal" ] }, { "type": "string", "enum": [ "greater" ] }, { "type": "string", "enum": [ "greater_equal" ] }, { "type": "string", "enum": [ "one_of" ] }, { "type": "string", "enum": [ "not_one_of" ] } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "number" ] } ] } }, "additionalProperties": false }, "data_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "item_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "index_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "loop_start": { "type": "integer", "minimum": 0, "maximum": 9999 }, "max_iterations": { "type": "integer", "minimum": 1, "maximum": 10000 }, "script_variables": { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "maxItems": 64, "uniqueItems": true }, "element_index": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_min": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_max": { "type": "integer", "minimum": 1, "maximum": 100000 }, "tab_match": { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "previous" ] }, { "type": "string", "enum": [ "index" ] } ] }, "tab_compare": { "anyOf": [ { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] } ] }, "tab_wrap": { "type": "boolean" }, "scroll_x": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "scroll_y": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "full_page": { "type": "boolean" }, "screenshot_format": { "anyOf": [ { "type": "string", "enum": [ "png" ] }, { "type": "string", "enum": [ "jpeg" ] } ] }, "screenshot_frame_content": { "type": "boolean" }, "screenshot_output": { "anyOf": [ { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "base64" ] } ] }, "screenshot_quality": { "type": "integer", "minimum": 0, "maximum": 100 }, "screenshot_name": { "type": "string", "maxLength": 100 }, "pointer_x": { "type": "integer", "minimum": 0, "maximum": 100000 }, "pointer_y": { "type": "integer", "minimum": 0, "maximum": 100000 }, "wait_ms": { "type": "integer", "minimum": 0, "maximum": 119000 }, "attribute_name": { "type": "string", "minLength": 1, "maxLength": 256 }, "secret_value": { "type": "boolean" }, "value_missing": { "type": "boolean" }, "cookie_domain": { "type": "string", "maxLength": 253 }, "cookie_name": { "type": "string", "maxLength": 1024 }, "cookie_path": { "type": "string", "maxLength": 2048 }, "cookie_mode": { "anyOf": [ { "type": "string", "enum": [ "merge" ] }, { "type": "string", "enum": [ "replace" ] } ] }, "cookie_output": { "anyOf": [ { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] }, { "type": "string", "enum": [ "value" ] } ] }, "value": { "type": "string", "maxLength": 10000 }, "save_as": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "repeat": { "type": "integer", "minimum": 1, "maximum": 100 }, "retries": { "type": "integer", "minimum": 0, "maximum": 5 }, "timeout_ms": { "type": "integer", "minimum": 100, "maximum": 120000 }, "on_error": { "anyOf": [ { "type": "string", "enum": [ "stop" ] }, { "type": "string", "enum": [ "continue" ] } ] }, "condition": { "type": "object", "required": [ "variable", "equals" ], "properties": { "variable": { "type": "string", "maxLength": 64 }, "equals": { "type": "string", "maxLength": 10000 } }, "additionalProperties": false } }, "additionalProperties": false }, "minItems": 1, "maxItems": 200 }, "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 500, "uniqueItems": true }, "concurrency": { "type": "integer", "minimum": 1, "maximum": 20 }, "close_after": { "type": "boolean" }, "headless": { "type": "boolean" }, "delay_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "input_timing": { "type": "object", "required": [ "key_min_ms", "key_max_ms", "step_jitter_ms" ], "properties": { "key_min_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "key_max_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "step_jitter_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "mouse_min_ms": { "type": "integer", "minimum": 0, "maximum": 5000 }, "mouse_max_ms": { "type": "integer", "minimum": 0, "maximum": 5000 } }, "additionalProperties": false }, "schedule": { "anyOf": [ { "type": "object", "required": [ "next_at", "interval_minutes" ], "properties": { "next_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "interval_minutes": { "type": "integer", "minimum": 0, "maximum": 525600 }, "time_zone": { "type": "string", "minLength": 1, "maxLength": 128 }, "remaining_runs": { "type": "integer", "minimum": 1, "maximum": 100000 }, "end_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "revision": { "type": "string", "minLength": 1, "maxLength": 64 }, "calendar": { "type": "object", "required": [ "frequency", "start_date", "time" ], "properties": { "frequency": { "anyOf": [ { "type": "string", "enum": [ "daily" ] }, { "type": "string", "enum": [ "weekly" ] }, { "type": "string", "enum": [ "monthly" ] }, { "type": "string", "enum": [ "yearly" ] } ] }, "start_date": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "time": { "type": "string", "pattern": "^[0-9]{2}:[0-9]{2}$" }, "weekdays": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 }, "minItems": 1, "maxItems": 7, "uniqueItems": true }, "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "month_day": { "anyOf": [ { "type": "number", "enum": [ -1 ] }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "x-required-scopes": [ "runtime:control", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "steps", "profile_ids", "concurrency", "close_after", "delay_ms", "schedule", "id" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "group": { "type": "string", "maxLength": 80 }, "description": { "type": "string", "maxLength": 2000 }, "is_template": { "type": "boolean" }, "steps": { "type": "array", "items": { "type": "object", "required": [ "action" ], "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "navigate" ] }, { "type": "string", "enum": [ "click" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string", "enum": [ "key" ] }, { "type": "string", "enum": [ "wait" ] }, { "type": "string", "enum": [ "wait_selector" ] }, { "type": "string", "enum": [ "extract" ] }, { "type": "string", "enum": [ "page_data" ] }, { "type": "string", "enum": [ "tab_open" ] }, { "type": "string", "enum": [ "tab_switch" ] }, { "type": "string", "enum": [ "tab_close" ] }, { "type": "string", "enum": [ "frame_enter" ] }, { "type": "string", "enum": [ "frame_parent" ] }, { "type": "string", "enum": [ "frame_top" ] }, { "type": "string", "enum": [ "reload" ] }, { "type": "string", "enum": [ "hover" ] }, { "type": "string", "enum": [ "double_click" ] }, { "type": "string", "enum": [ "right_click" ] }, { "type": "string", "enum": [ "scroll" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "attribute" ] }, { "type": "string", "enum": [ "screenshot" ] }, { "type": "string", "enum": [ "cookies_get" ] }, { "type": "string", "enum": [ "cookies_set" ] }, { "type": "string", "enum": [ "cookies_delete" ] }, { "type": "string", "enum": [ "focus" ] }, { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "attribute_set" ] }, { "type": "string", "enum": [ "mouse_move" ] }, { "type": "string", "enum": [ "wheel" ] }, { "type": "string", "enum": [ "history_back" ] }, { "type": "string", "enum": [ "history_forward" ] }, { "type": "string", "enum": [ "tab_list" ] }, { "type": "string", "enum": [ "tab_activate" ] }, { "type": "string", "enum": [ "script" ] }, { "type": "string", "enum": [ "workflow_call" ] }, { "type": "string", "enum": [ "branch" ] }, { "type": "string", "enum": [ "loop_count" ] }, { "type": "string", "enum": [ "loop_data" ] }, { "type": "string", "enum": [ "loop_elements" ] }, { "type": "string", "enum": [ "element_capture" ] }, { "type": "string", "enum": [ "element_release" ] }, { "type": "string", "enum": [ "loop_while" ] }, { "type": "string", "enum": [ "loop_break" ] }, { "type": "string", "enum": [ "loop_continue" ] }, { "type": "string", "enum": [ "variable_set" ] }, { "type": "string", "enum": [ "global" ] }, { "type": "string", "enum": [ "data_transform" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "service" ] }, { "type": "string", "enum": [ "network" ] } ] }, "data": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "csv_parse" ] }, { "type": "string", "enum": [ "csv_stringify" ] }, { "type": "string", "enum": [ "table_cell" ] }, { "type": "string", "enum": [ "table_set" ] }, { "type": "string", "enum": [ "table_row" ] }, { "type": "string", "enum": [ "table_column" ] }, { "type": "string", "enum": [ "table_append" ] }, { "type": "string", "enum": [ "table_slice" ] }, { "type": "string", "enum": [ "json_parse" ] }, { "type": "string", "enum": [ "json_get" ] }, { "type": "string", "enum": [ "json_keys" ] }, { "type": "string", "enum": [ "list_length" ] }, { "type": "string", "enum": [ "list_join" ] }, { "type": "string", "enum": [ "list_append" ] }, { "type": "string", "enum": [ "list_random" ] }, { "type": "string", "enum": [ "text_split" ] }, { "type": "string", "enum": [ "text_replace" ] }, { "type": "string", "enum": [ "regex_extract" ] }, { "type": "string", "enum": [ "regex_replace" ] }, { "type": "string", "enum": [ "text_trim" ] }, { "type": "string", "enum": [ "text_lower" ] }, { "type": "string", "enum": [ "text_upper" ] }, { "type": "string", "enum": [ "number_add" ] }, { "type": "string", "enum": [ "number_subtract" ] }, { "type": "string", "enum": [ "number_multiply" ] }, { "type": "string", "enum": [ "number_divide" ] }, { "type": "string", "enum": [ "number_remainder" ] }, { "type": "string", "enum": [ "url_parse" ] }, { "type": "string", "enum": [ "url_parameter" ] }, { "type": "string", "enum": [ "random_integer" ] }, { "type": "string", "enum": [ "random_text" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "global": { "type": "object", "required": [ "operation", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "delete" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "page_data": { "anyOf": [ { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "html" ] }, { "type": "string", "enum": [ "links" ] }, { "type": "string", "enum": [ "images" ] }, { "type": "string", "enum": [ "form_values" ] }, { "type": "string", "enum": [ "element_count" ] } ] }, "file": { "type": "object", "required": [ "operation", "format", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "append" ] } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "txt" ] }, { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "csv" ] }, { "type": "string", "enum": [ "xlsx" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "delimiter": { "anyOf": [ { "type": "string", "enum": [ "," ] }, { "type": "string", "enum": [ ";" ] }, { "type": "string", "enum": [ "\t" ] }, { "type": "string", "enum": [ "|" ] } ] }, "sheet": { "type": "string", "minLength": 1, "maxLength": 31 }, "overwrite": { "type": "boolean" } }, "additionalProperties": false }, "service": { "type": "object", "required": [ "kind" ], "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "http" ] }, { "type": "string", "enum": [ "google_sheets" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "network": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "stop" ] } ] }, "url_contains": { "type": "string", "maxLength": 2000 }, "phase": { "anyOf": [ { "type": "string", "enum": [ "all" ] }, { "type": "string", "enum": [ "request" ] }, { "type": "string", "enum": [ "response" ] }, { "type": "string", "enum": [ "error" ] } ] }, "include_headers": { "type": "boolean" }, "include_bodies": { "type": "boolean" }, "max_events": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "additionalProperties": false }, "selector": { "type": "string", "maxLength": 2000 }, "element_ref": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "else_workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "predicate": { "type": "object", "required": [ "variable", "operator" ], "properties": { "variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "operator": { "anyOf": [ { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "not_exists" ] }, { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] }, { "type": "string", "enum": [ "less" ] }, { "type": "string", "enum": [ "less_equal" ] }, { "type": "string", "enum": [ "greater" ] }, { "type": "string", "enum": [ "greater_equal" ] }, { "type": "string", "enum": [ "one_of" ] }, { "type": "string", "enum": [ "not_one_of" ] } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "number" ] } ] } }, "additionalProperties": false }, "data_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "item_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "index_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "loop_start": { "type": "integer", "minimum": 0, "maximum": 9999 }, "max_iterations": { "type": "integer", "minimum": 1, "maximum": 10000 }, "script_variables": { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "maxItems": 64, "uniqueItems": true }, "element_index": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_min": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_max": { "type": "integer", "minimum": 1, "maximum": 100000 }, "tab_match": { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "previous" ] }, { "type": "string", "enum": [ "index" ] } ] }, "tab_compare": { "anyOf": [ { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] } ] }, "tab_wrap": { "type": "boolean" }, "scroll_x": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "scroll_y": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "full_page": { "type": "boolean" }, "screenshot_format": { "anyOf": [ { "type": "string", "enum": [ "png" ] }, { "type": "string", "enum": [ "jpeg" ] } ] }, "screenshot_frame_content": { "type": "boolean" }, "screenshot_output": { "anyOf": [ { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "base64" ] } ] }, "screenshot_quality": { "type": "integer", "minimum": 0, "maximum": 100 }, "screenshot_name": { "type": "string", "maxLength": 100 }, "pointer_x": { "type": "integer", "minimum": 0, "maximum": 100000 }, "pointer_y": { "type": "integer", "minimum": 0, "maximum": 100000 }, "wait_ms": { "type": "integer", "minimum": 0, "maximum": 119000 }, "attribute_name": { "type": "string", "minLength": 1, "maxLength": 256 }, "secret_value": { "type": "boolean" }, "value_missing": { "type": "boolean" }, "cookie_domain": { "type": "string", "maxLength": 253 }, "cookie_name": { "type": "string", "maxLength": 1024 }, "cookie_path": { "type": "string", "maxLength": 2048 }, "cookie_mode": { "anyOf": [ { "type": "string", "enum": [ "merge" ] }, { "type": "string", "enum": [ "replace" ] } ] }, "cookie_output": { "anyOf": [ { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] }, { "type": "string", "enum": [ "value" ] } ] }, "value": { "type": "string", "maxLength": 10000 }, "save_as": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "repeat": { "type": "integer", "minimum": 1, "maximum": 100 }, "retries": { "type": "integer", "minimum": 0, "maximum": 5 }, "timeout_ms": { "type": "integer", "minimum": 100, "maximum": 120000 }, "on_error": { "anyOf": [ { "type": "string", "enum": [ "stop" ] }, { "type": "string", "enum": [ "continue" ] } ] }, "condition": { "type": "object", "required": [ "variable", "equals" ], "properties": { "variable": { "type": "string", "maxLength": 64 }, "equals": { "type": "string", "maxLength": 10000 } }, "additionalProperties": false } }, "additionalProperties": false }, "minItems": 1, "maxItems": 200 }, "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 500, "uniqueItems": true }, "concurrency": { "type": "integer", "minimum": 1, "maximum": 20 }, "close_after": { "type": "boolean" }, "headless": { "type": "boolean" }, "delay_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "input_timing": { "type": "object", "required": [ "key_min_ms", "key_max_ms", "step_jitter_ms" ], "properties": { "key_min_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "key_max_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "step_jitter_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "mouse_min_ms": { "type": "integer", "minimum": 0, "maximum": 5000 }, "mouse_max_ms": { "type": "integer", "minimum": 0, "maximum": 5000 } }, "additionalProperties": false }, "schedule": { "anyOf": [ { "type": "object", "required": [ "next_at", "interval_minutes" ], "properties": { "next_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "interval_minutes": { "type": "integer", "minimum": 0, "maximum": 525600 }, "time_zone": { "type": "string", "minLength": 1, "maxLength": 128 }, "remaining_runs": { "type": "integer", "minimum": 1, "maximum": 100000 }, "end_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "revision": { "type": "string", "minLength": 1, "maxLength": 64 }, "calendar": { "type": "object", "required": [ "frequency", "start_date", "time" ], "properties": { "frequency": { "anyOf": [ { "type": "string", "enum": [ "daily" ] }, { "type": "string", "enum": [ "weekly" ] }, { "type": "string", "enum": [ "monthly" ] }, { "type": "string", "enum": [ "yearly" ] } ] }, "start_date": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "time": { "type": "string", "pattern": "^[0-9]{2}:[0-9]{2}$" }, "weekdays": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 }, "minItems": 1, "maxItems": 7, "uniqueItems": true }, "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "month_day": { "anyOf": [ { "type": "number", "enum": [ -1 ] }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "id": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/workflows/{id}": { "put": { "summary": "RPA-Ablauf ändern", "tags": [ "Automation" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "steps", "profile_ids", "concurrency", "close_after", "delay_ms", "schedule" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "group": { "type": "string", "maxLength": 80 }, "description": { "type": "string", "maxLength": 2000 }, "is_template": { "type": "boolean" }, "steps": { "type": "array", "items": { "type": "object", "required": [ "action" ], "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "navigate" ] }, { "type": "string", "enum": [ "click" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string", "enum": [ "key" ] }, { "type": "string", "enum": [ "wait" ] }, { "type": "string", "enum": [ "wait_selector" ] }, { "type": "string", "enum": [ "extract" ] }, { "type": "string", "enum": [ "page_data" ] }, { "type": "string", "enum": [ "tab_open" ] }, { "type": "string", "enum": [ "tab_switch" ] }, { "type": "string", "enum": [ "tab_close" ] }, { "type": "string", "enum": [ "frame_enter" ] }, { "type": "string", "enum": [ "frame_parent" ] }, { "type": "string", "enum": [ "frame_top" ] }, { "type": "string", "enum": [ "reload" ] }, { "type": "string", "enum": [ "hover" ] }, { "type": "string", "enum": [ "double_click" ] }, { "type": "string", "enum": [ "right_click" ] }, { "type": "string", "enum": [ "scroll" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "attribute" ] }, { "type": "string", "enum": [ "screenshot" ] }, { "type": "string", "enum": [ "cookies_get" ] }, { "type": "string", "enum": [ "cookies_set" ] }, { "type": "string", "enum": [ "cookies_delete" ] }, { "type": "string", "enum": [ "focus" ] }, { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "attribute_set" ] }, { "type": "string", "enum": [ "mouse_move" ] }, { "type": "string", "enum": [ "wheel" ] }, { "type": "string", "enum": [ "history_back" ] }, { "type": "string", "enum": [ "history_forward" ] }, { "type": "string", "enum": [ "tab_list" ] }, { "type": "string", "enum": [ "tab_activate" ] }, { "type": "string", "enum": [ "script" ] }, { "type": "string", "enum": [ "workflow_call" ] }, { "type": "string", "enum": [ "branch" ] }, { "type": "string", "enum": [ "loop_count" ] }, { "type": "string", "enum": [ "loop_data" ] }, { "type": "string", "enum": [ "loop_elements" ] }, { "type": "string", "enum": [ "element_capture" ] }, { "type": "string", "enum": [ "element_release" ] }, { "type": "string", "enum": [ "loop_while" ] }, { "type": "string", "enum": [ "loop_break" ] }, { "type": "string", "enum": [ "loop_continue" ] }, { "type": "string", "enum": [ "variable_set" ] }, { "type": "string", "enum": [ "global" ] }, { "type": "string", "enum": [ "data_transform" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "service" ] }, { "type": "string", "enum": [ "network" ] } ] }, "data": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "csv_parse" ] }, { "type": "string", "enum": [ "csv_stringify" ] }, { "type": "string", "enum": [ "table_cell" ] }, { "type": "string", "enum": [ "table_set" ] }, { "type": "string", "enum": [ "table_row" ] }, { "type": "string", "enum": [ "table_column" ] }, { "type": "string", "enum": [ "table_append" ] }, { "type": "string", "enum": [ "table_slice" ] }, { "type": "string", "enum": [ "json_parse" ] }, { "type": "string", "enum": [ "json_get" ] }, { "type": "string", "enum": [ "json_keys" ] }, { "type": "string", "enum": [ "list_length" ] }, { "type": "string", "enum": [ "list_join" ] }, { "type": "string", "enum": [ "list_append" ] }, { "type": "string", "enum": [ "list_random" ] }, { "type": "string", "enum": [ "text_split" ] }, { "type": "string", "enum": [ "text_replace" ] }, { "type": "string", "enum": [ "regex_extract" ] }, { "type": "string", "enum": [ "regex_replace" ] }, { "type": "string", "enum": [ "text_trim" ] }, { "type": "string", "enum": [ "text_lower" ] }, { "type": "string", "enum": [ "text_upper" ] }, { "type": "string", "enum": [ "number_add" ] }, { "type": "string", "enum": [ "number_subtract" ] }, { "type": "string", "enum": [ "number_multiply" ] }, { "type": "string", "enum": [ "number_divide" ] }, { "type": "string", "enum": [ "number_remainder" ] }, { "type": "string", "enum": [ "url_parse" ] }, { "type": "string", "enum": [ "url_parameter" ] }, { "type": "string", "enum": [ "random_integer" ] }, { "type": "string", "enum": [ "random_text" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "global": { "type": "object", "required": [ "operation", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "delete" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "page_data": { "anyOf": [ { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "html" ] }, { "type": "string", "enum": [ "links" ] }, { "type": "string", "enum": [ "images" ] }, { "type": "string", "enum": [ "form_values" ] }, { "type": "string", "enum": [ "element_count" ] } ] }, "file": { "type": "object", "required": [ "operation", "format", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "append" ] } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "txt" ] }, { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "csv" ] }, { "type": "string", "enum": [ "xlsx" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "delimiter": { "anyOf": [ { "type": "string", "enum": [ "," ] }, { "type": "string", "enum": [ ";" ] }, { "type": "string", "enum": [ "\t" ] }, { "type": "string", "enum": [ "|" ] } ] }, "sheet": { "type": "string", "minLength": 1, "maxLength": 31 }, "overwrite": { "type": "boolean" } }, "additionalProperties": false }, "service": { "type": "object", "required": [ "kind" ], "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "http" ] }, { "type": "string", "enum": [ "google_sheets" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "network": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "stop" ] } ] }, "url_contains": { "type": "string", "maxLength": 2000 }, "phase": { "anyOf": [ { "type": "string", "enum": [ "all" ] }, { "type": "string", "enum": [ "request" ] }, { "type": "string", "enum": [ "response" ] }, { "type": "string", "enum": [ "error" ] } ] }, "include_headers": { "type": "boolean" }, "include_bodies": { "type": "boolean" }, "max_events": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "additionalProperties": false }, "selector": { "type": "string", "maxLength": 2000 }, "element_ref": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "else_workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "predicate": { "type": "object", "required": [ "variable", "operator" ], "properties": { "variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "operator": { "anyOf": [ { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "not_exists" ] }, { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] }, { "type": "string", "enum": [ "less" ] }, { "type": "string", "enum": [ "less_equal" ] }, { "type": "string", "enum": [ "greater" ] }, { "type": "string", "enum": [ "greater_equal" ] }, { "type": "string", "enum": [ "one_of" ] }, { "type": "string", "enum": [ "not_one_of" ] } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "number" ] } ] } }, "additionalProperties": false }, "data_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "item_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "index_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "loop_start": { "type": "integer", "minimum": 0, "maximum": 9999 }, "max_iterations": { "type": "integer", "minimum": 1, "maximum": 10000 }, "script_variables": { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "maxItems": 64, "uniqueItems": true }, "element_index": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_min": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_max": { "type": "integer", "minimum": 1, "maximum": 100000 }, "tab_match": { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "previous" ] }, { "type": "string", "enum": [ "index" ] } ] }, "tab_compare": { "anyOf": [ { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] } ] }, "tab_wrap": { "type": "boolean" }, "scroll_x": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "scroll_y": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "full_page": { "type": "boolean" }, "screenshot_format": { "anyOf": [ { "type": "string", "enum": [ "png" ] }, { "type": "string", "enum": [ "jpeg" ] } ] }, "screenshot_frame_content": { "type": "boolean" }, "screenshot_output": { "anyOf": [ { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "base64" ] } ] }, "screenshot_quality": { "type": "integer", "minimum": 0, "maximum": 100 }, "screenshot_name": { "type": "string", "maxLength": 100 }, "pointer_x": { "type": "integer", "minimum": 0, "maximum": 100000 }, "pointer_y": { "type": "integer", "minimum": 0, "maximum": 100000 }, "wait_ms": { "type": "integer", "minimum": 0, "maximum": 119000 }, "attribute_name": { "type": "string", "minLength": 1, "maxLength": 256 }, "secret_value": { "type": "boolean" }, "value_missing": { "type": "boolean" }, "cookie_domain": { "type": "string", "maxLength": 253 }, "cookie_name": { "type": "string", "maxLength": 1024 }, "cookie_path": { "type": "string", "maxLength": 2048 }, "cookie_mode": { "anyOf": [ { "type": "string", "enum": [ "merge" ] }, { "type": "string", "enum": [ "replace" ] } ] }, "cookie_output": { "anyOf": [ { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] }, { "type": "string", "enum": [ "value" ] } ] }, "value": { "type": "string", "maxLength": 10000 }, "save_as": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "repeat": { "type": "integer", "minimum": 1, "maximum": 100 }, "retries": { "type": "integer", "minimum": 0, "maximum": 5 }, "timeout_ms": { "type": "integer", "minimum": 100, "maximum": 120000 }, "on_error": { "anyOf": [ { "type": "string", "enum": [ "stop" ] }, { "type": "string", "enum": [ "continue" ] } ] }, "condition": { "type": "object", "required": [ "variable", "equals" ], "properties": { "variable": { "type": "string", "maxLength": 64 }, "equals": { "type": "string", "maxLength": 10000 } }, "additionalProperties": false } }, "additionalProperties": false }, "minItems": 1, "maxItems": 200 }, "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 500, "uniqueItems": true }, "concurrency": { "type": "integer", "minimum": 1, "maximum": 20 }, "close_after": { "type": "boolean" }, "headless": { "type": "boolean" }, "delay_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "input_timing": { "type": "object", "required": [ "key_min_ms", "key_max_ms", "step_jitter_ms" ], "properties": { "key_min_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "key_max_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "step_jitter_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "mouse_min_ms": { "type": "integer", "minimum": 0, "maximum": 5000 }, "mouse_max_ms": { "type": "integer", "minimum": 0, "maximum": 5000 } }, "additionalProperties": false }, "schedule": { "anyOf": [ { "type": "object", "required": [ "next_at", "interval_minutes" ], "properties": { "next_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "interval_minutes": { "type": "integer", "minimum": 0, "maximum": 525600 }, "time_zone": { "type": "string", "minLength": 1, "maxLength": 128 }, "remaining_runs": { "type": "integer", "minimum": 1, "maximum": 100000 }, "end_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "revision": { "type": "string", "minLength": 1, "maxLength": 64 }, "calendar": { "type": "object", "required": [ "frequency", "start_date", "time" ], "properties": { "frequency": { "anyOf": [ { "type": "string", "enum": [ "daily" ] }, { "type": "string", "enum": [ "weekly" ] }, { "type": "string", "enum": [ "monthly" ] }, { "type": "string", "enum": [ "yearly" ] } ] }, "start_date": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "time": { "type": "string", "pattern": "^[0-9]{2}:[0-9]{2}$" }, "weekdays": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 }, "minItems": 1, "maxItems": 7, "uniqueItems": true }, "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "month_day": { "anyOf": [ { "type": "number", "enum": [ -1 ] }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "runtime:control", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "steps", "profile_ids", "concurrency", "close_after", "delay_ms", "schedule", "id" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "group": { "type": "string", "maxLength": 80 }, "description": { "type": "string", "maxLength": 2000 }, "is_template": { "type": "boolean" }, "steps": { "type": "array", "items": { "type": "object", "required": [ "action" ], "properties": { "action": { "anyOf": [ { "type": "string", "enum": [ "navigate" ] }, { "type": "string", "enum": [ "click" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string", "enum": [ "key" ] }, { "type": "string", "enum": [ "wait" ] }, { "type": "string", "enum": [ "wait_selector" ] }, { "type": "string", "enum": [ "extract" ] }, { "type": "string", "enum": [ "page_data" ] }, { "type": "string", "enum": [ "tab_open" ] }, { "type": "string", "enum": [ "tab_switch" ] }, { "type": "string", "enum": [ "tab_close" ] }, { "type": "string", "enum": [ "frame_enter" ] }, { "type": "string", "enum": [ "frame_parent" ] }, { "type": "string", "enum": [ "frame_top" ] }, { "type": "string", "enum": [ "reload" ] }, { "type": "string", "enum": [ "hover" ] }, { "type": "string", "enum": [ "double_click" ] }, { "type": "string", "enum": [ "right_click" ] }, { "type": "string", "enum": [ "scroll" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "attribute" ] }, { "type": "string", "enum": [ "screenshot" ] }, { "type": "string", "enum": [ "cookies_get" ] }, { "type": "string", "enum": [ "cookies_set" ] }, { "type": "string", "enum": [ "cookies_delete" ] }, { "type": "string", "enum": [ "focus" ] }, { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "attribute_set" ] }, { "type": "string", "enum": [ "mouse_move" ] }, { "type": "string", "enum": [ "wheel" ] }, { "type": "string", "enum": [ "history_back" ] }, { "type": "string", "enum": [ "history_forward" ] }, { "type": "string", "enum": [ "tab_list" ] }, { "type": "string", "enum": [ "tab_activate" ] }, { "type": "string", "enum": [ "script" ] }, { "type": "string", "enum": [ "workflow_call" ] }, { "type": "string", "enum": [ "branch" ] }, { "type": "string", "enum": [ "loop_count" ] }, { "type": "string", "enum": [ "loop_data" ] }, { "type": "string", "enum": [ "loop_elements" ] }, { "type": "string", "enum": [ "element_capture" ] }, { "type": "string", "enum": [ "element_release" ] }, { "type": "string", "enum": [ "loop_while" ] }, { "type": "string", "enum": [ "loop_break" ] }, { "type": "string", "enum": [ "loop_continue" ] }, { "type": "string", "enum": [ "variable_set" ] }, { "type": "string", "enum": [ "global" ] }, { "type": "string", "enum": [ "data_transform" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "service" ] }, { "type": "string", "enum": [ "network" ] } ] }, "data": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "csv_parse" ] }, { "type": "string", "enum": [ "csv_stringify" ] }, { "type": "string", "enum": [ "table_cell" ] }, { "type": "string", "enum": [ "table_set" ] }, { "type": "string", "enum": [ "table_row" ] }, { "type": "string", "enum": [ "table_column" ] }, { "type": "string", "enum": [ "table_append" ] }, { "type": "string", "enum": [ "table_slice" ] }, { "type": "string", "enum": [ "json_parse" ] }, { "type": "string", "enum": [ "json_get" ] }, { "type": "string", "enum": [ "json_keys" ] }, { "type": "string", "enum": [ "list_length" ] }, { "type": "string", "enum": [ "list_join" ] }, { "type": "string", "enum": [ "list_append" ] }, { "type": "string", "enum": [ "list_random" ] }, { "type": "string", "enum": [ "text_split" ] }, { "type": "string", "enum": [ "text_replace" ] }, { "type": "string", "enum": [ "regex_extract" ] }, { "type": "string", "enum": [ "regex_replace" ] }, { "type": "string", "enum": [ "text_trim" ] }, { "type": "string", "enum": [ "text_lower" ] }, { "type": "string", "enum": [ "text_upper" ] }, { "type": "string", "enum": [ "number_add" ] }, { "type": "string", "enum": [ "number_subtract" ] }, { "type": "string", "enum": [ "number_multiply" ] }, { "type": "string", "enum": [ "number_divide" ] }, { "type": "string", "enum": [ "number_remainder" ] }, { "type": "string", "enum": [ "url_parse" ] }, { "type": "string", "enum": [ "url_parameter" ] }, { "type": "string", "enum": [ "random_integer" ] }, { "type": "string", "enum": [ "random_text" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "global": { "type": "object", "required": [ "operation", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "delete" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "expected_revision": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "additionalProperties": false }, "page_data": { "anyOf": [ { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "html" ] }, { "type": "string", "enum": [ "links" ] }, { "type": "string", "enum": [ "images" ] }, { "type": "string", "enum": [ "form_values" ] }, { "type": "string", "enum": [ "element_count" ] } ] }, "file": { "type": "object", "required": [ "operation", "format", "name" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "write" ] }, { "type": "string", "enum": [ "append" ] } ] }, "format": { "anyOf": [ { "type": "string", "enum": [ "txt" ] }, { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "csv" ] }, { "type": "string", "enum": [ "xlsx" ] } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "delimiter": { "anyOf": [ { "type": "string", "enum": [ "," ] }, { "type": "string", "enum": [ ";" ] }, { "type": "string", "enum": [ "\t" ] }, { "type": "string", "enum": [ "|" ] } ] }, "sheet": { "type": "string", "minLength": 1, "maxLength": 31 }, "overwrite": { "type": "boolean" } }, "additionalProperties": false }, "service": { "type": "object", "required": [ "kind" ], "properties": { "kind": { "anyOf": [ { "type": "string", "enum": [ "http" ] }, { "type": "string", "enum": [ "google_sheets" ] } ] }, "source_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" } }, "additionalProperties": false }, "network": { "type": "object", "required": [ "operation" ], "properties": { "operation": { "anyOf": [ { "type": "string", "enum": [ "start" ] }, { "type": "string", "enum": [ "read" ] }, { "type": "string", "enum": [ "stop" ] } ] }, "url_contains": { "type": "string", "maxLength": 2000 }, "phase": { "anyOf": [ { "type": "string", "enum": [ "all" ] }, { "type": "string", "enum": [ "request" ] }, { "type": "string", "enum": [ "response" ] }, { "type": "string", "enum": [ "error" ] } ] }, "include_headers": { "type": "boolean" }, "include_bodies": { "type": "boolean" }, "max_events": { "type": "integer", "minimum": 1, "maximum": 1000 } }, "additionalProperties": false }, "selector": { "type": "string", "maxLength": 2000 }, "element_ref": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "else_workflow_id": { "type": "string", "pattern": "^[a-zA-Z0-9_-]{1,64}$" }, "predicate": { "type": "object", "required": [ "variable", "operator" ], "properties": { "variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "operator": { "anyOf": [ { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "not_exists" ] }, { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] }, { "type": "string", "enum": [ "less" ] }, { "type": "string", "enum": [ "less_equal" ] }, { "type": "string", "enum": [ "greater" ] }, { "type": "string", "enum": [ "greater_equal" ] }, { "type": "string", "enum": [ "one_of" ] }, { "type": "string", "enum": [ "not_one_of" ] } ] }, "type": { "anyOf": [ { "type": "string", "enum": [ "text" ] }, { "type": "string", "enum": [ "number" ] } ] } }, "additionalProperties": false }, "data_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "item_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "index_variable": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "loop_start": { "type": "integer", "minimum": 0, "maximum": 9999 }, "max_iterations": { "type": "integer", "minimum": 1, "maximum": 10000 }, "script_variables": { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "maxItems": 64, "uniqueItems": true }, "element_index": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_min": { "type": "integer", "minimum": 1, "maximum": 100000 }, "element_random_max": { "type": "integer", "minimum": 1, "maximum": 100000 }, "tab_match": { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "url" ] }, { "type": "string", "enum": [ "title" ] }, { "type": "string", "enum": [ "next" ] }, { "type": "string", "enum": [ "previous" ] }, { "type": "string", "enum": [ "index" ] } ] }, "tab_compare": { "anyOf": [ { "type": "string", "enum": [ "equals" ] }, { "type": "string", "enum": [ "not_equals" ] }, { "type": "string", "enum": [ "contains" ] }, { "type": "string", "enum": [ "not_contains" ] }, { "type": "string", "enum": [ "starts_with" ] }, { "type": "string", "enum": [ "ends_with" ] } ] }, "tab_wrap": { "type": "boolean" }, "scroll_x": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "scroll_y": { "type": "integer", "minimum": -100000, "maximum": 100000 }, "full_page": { "type": "boolean" }, "screenshot_format": { "anyOf": [ { "type": "string", "enum": [ "png" ] }, { "type": "string", "enum": [ "jpeg" ] } ] }, "screenshot_frame_content": { "type": "boolean" }, "screenshot_output": { "anyOf": [ { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "base64" ] } ] }, "screenshot_quality": { "type": "integer", "minimum": 0, "maximum": 100 }, "screenshot_name": { "type": "string", "maxLength": 100 }, "pointer_x": { "type": "integer", "minimum": 0, "maximum": 100000 }, "pointer_y": { "type": "integer", "minimum": 0, "maximum": 100000 }, "wait_ms": { "type": "integer", "minimum": 0, "maximum": 119000 }, "attribute_name": { "type": "string", "minLength": 1, "maxLength": 256 }, "secret_value": { "type": "boolean" }, "value_missing": { "type": "boolean" }, "cookie_domain": { "type": "string", "maxLength": 253 }, "cookie_name": { "type": "string", "maxLength": 1024 }, "cookie_path": { "type": "string", "maxLength": 2048 }, "cookie_mode": { "anyOf": [ { "type": "string", "enum": [ "merge" ] }, { "type": "string", "enum": [ "replace" ] } ] }, "cookie_output": { "anyOf": [ { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] }, { "type": "string", "enum": [ "value" ] } ] }, "value": { "type": "string", "maxLength": 10000 }, "save_as": { "type": "string", "pattern": "^[A-Za-z_][A-Za-z0-9_]{0,63}$" }, "repeat": { "type": "integer", "minimum": 1, "maximum": 100 }, "retries": { "type": "integer", "minimum": 0, "maximum": 5 }, "timeout_ms": { "type": "integer", "minimum": 100, "maximum": 120000 }, "on_error": { "anyOf": [ { "type": "string", "enum": [ "stop" ] }, { "type": "string", "enum": [ "continue" ] } ] }, "condition": { "type": "object", "required": [ "variable", "equals" ], "properties": { "variable": { "type": "string", "maxLength": 64 }, "equals": { "type": "string", "maxLength": 10000 } }, "additionalProperties": false } }, "additionalProperties": false }, "minItems": 1, "maxItems": 200 }, "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 500, "uniqueItems": true }, "concurrency": { "type": "integer", "minimum": 1, "maximum": 20 }, "close_after": { "type": "boolean" }, "headless": { "type": "boolean" }, "delay_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "input_timing": { "type": "object", "required": [ "key_min_ms", "key_max_ms", "step_jitter_ms" ], "properties": { "key_min_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "key_max_ms": { "type": "integer", "minimum": 0, "maximum": 2000 }, "step_jitter_ms": { "type": "integer", "minimum": 0, "maximum": 30000 }, "mouse_min_ms": { "type": "integer", "minimum": 0, "maximum": 5000 }, "mouse_max_ms": { "type": "integer", "minimum": 0, "maximum": 5000 } }, "additionalProperties": false }, "schedule": { "anyOf": [ { "type": "object", "required": [ "next_at", "interval_minutes" ], "properties": { "next_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "interval_minutes": { "type": "integer", "minimum": 0, "maximum": 525600 }, "time_zone": { "type": "string", "minLength": 1, "maxLength": 128 }, "remaining_runs": { "type": "integer", "minimum": 1, "maximum": 100000 }, "end_at": { "type": "integer", "minimum": 0, "maximum": 253402300799999 }, "revision": { "type": "string", "minLength": 1, "maxLength": 64 }, "calendar": { "type": "object", "required": [ "frequency", "start_date", "time" ], "properties": { "frequency": { "anyOf": [ { "type": "string", "enum": [ "daily" ] }, { "type": "string", "enum": [ "weekly" ] }, { "type": "string", "enum": [ "monthly" ] }, { "type": "string", "enum": [ "yearly" ] } ] }, "start_date": { "type": "string", "pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$" }, "time": { "type": "string", "pattern": "^[0-9]{2}:[0-9]{2}$" }, "weekdays": { "type": "array", "items": { "type": "integer", "minimum": 1, "maximum": 7 }, "minItems": 1, "maxItems": 7, "uniqueItems": true }, "month": { "type": "integer", "minimum": 1, "maximum": 12 }, "month_day": { "anyOf": [ { "type": "number", "enum": [ -1 ] }, { "type": "integer", "minimum": 1, "maximum": 31 } ] } }, "additionalProperties": false } }, "additionalProperties": false }, { "type": "null" } ] }, "id": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "RPA-Ablauf löschen", "tags": [ "Automation" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "runtime:control", "rpa:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/workflows/{id}/run": { "post": { "summary": "RPA-Aufgabe starten", "tags": [ "Automation" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "runtime:control", "rpa:run" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "workflow_id", "name", "state", "started_at", "ended_at", "results" ], "properties": { "id": { "type": "string" }, "workflow_id": { "type": "string" }, "name": { "type": "string" }, "state": { "anyOf": [ { "type": "string", "enum": [ "running" ] }, { "type": "string", "enum": [ "completed" ] }, { "type": "string", "enum": [ "failed" ] }, { "type": "string", "enum": [ "cancelled" ] }, { "type": "string", "enum": [ "interrupted" ] } ] }, "started_at": { "type": "integer" }, "ended_at": { "type": [ "integer", "null" ] }, "results": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "state", "step", "error", "variables" ], "properties": { "profile_id": { "type": "string" }, "state": { "anyOf": [ { "type": "string", "enum": [ "queued" ] }, { "type": "string", "enum": [ "running" ] }, { "type": "string", "enum": [ "completed" ] }, { "type": "string", "enum": [ "failed" ] }, { "type": "string", "enum": [ "cancelled" ] } ] }, "step": { "type": "integer" }, "step_path": { "type": "array", "items": { "type": "integer" } }, "diagnostics": { "type": "array", "items": { "type": "object", "required": [ "workflow_id", "path", "action", "repeat", "attempt", "started_at", "duration_ms", "state" ], "properties": { "workflow_id": { "type": "string" }, "path": { "type": "array", "items": { "type": "integer" } }, "action": { "anyOf": [ { "type": "string", "enum": [ "navigate" ] }, { "type": "string", "enum": [ "click" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string", "enum": [ "key" ] }, { "type": "string", "enum": [ "wait" ] }, { "type": "string", "enum": [ "wait_selector" ] }, { "type": "string", "enum": [ "extract" ] }, { "type": "string", "enum": [ "page_data" ] }, { "type": "string", "enum": [ "tab_open" ] }, { "type": "string", "enum": [ "tab_switch" ] }, { "type": "string", "enum": [ "tab_close" ] }, { "type": "string", "enum": [ "frame_enter" ] }, { "type": "string", "enum": [ "frame_parent" ] }, { "type": "string", "enum": [ "frame_top" ] }, { "type": "string", "enum": [ "reload" ] }, { "type": "string", "enum": [ "hover" ] }, { "type": "string", "enum": [ "double_click" ] }, { "type": "string", "enum": [ "right_click" ] }, { "type": "string", "enum": [ "scroll" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "attribute" ] }, { "type": "string", "enum": [ "screenshot" ] }, { "type": "string", "enum": [ "cookies_get" ] }, { "type": "string", "enum": [ "cookies_set" ] }, { "type": "string", "enum": [ "cookies_delete" ] }, { "type": "string", "enum": [ "focus" ] }, { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "attribute_set" ] }, { "type": "string", "enum": [ "mouse_move" ] }, { "type": "string", "enum": [ "wheel" ] }, { "type": "string", "enum": [ "history_back" ] }, { "type": "string", "enum": [ "history_forward" ] }, { "type": "string", "enum": [ "tab_list" ] }, { "type": "string", "enum": [ "tab_activate" ] }, { "type": "string", "enum": [ "script" ] }, { "type": "string", "enum": [ "workflow_call" ] }, { "type": "string", "enum": [ "branch" ] }, { "type": "string", "enum": [ "loop_count" ] }, { "type": "string", "enum": [ "loop_data" ] }, { "type": "string", "enum": [ "loop_elements" ] }, { "type": "string", "enum": [ "element_capture" ] }, { "type": "string", "enum": [ "element_release" ] }, { "type": "string", "enum": [ "loop_while" ] }, { "type": "string", "enum": [ "loop_break" ] }, { "type": "string", "enum": [ "loop_continue" ] }, { "type": "string", "enum": [ "variable_set" ] }, { "type": "string", "enum": [ "global" ] }, { "type": "string", "enum": [ "data_transform" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "service" ] }, { "type": "string", "enum": [ "network" ] } ] }, "repeat": { "type": "integer" }, "attempt": { "type": "integer" }, "started_at": { "type": "integer" }, "duration_ms": { "type": "integer" }, "state": { "anyOf": [ { "type": "string", "enum": [ "completed" ] }, { "type": "string", "enum": [ "failed" ] }, { "type": "string", "enum": [ "cancelled" ] }, { "type": "string", "enum": [ "control" ] } ] }, "error_code": { "type": "string" } } } }, "diagnostics_dropped": { "type": "integer" }, "error": { "type": [ "string", "null" ] }, "variables": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/runs": { "get": { "summary": "RPA-Ausführungen und Ergebnisse", "tags": [ "Automation" ], "x-required-scopes": [ "runtime:control", "rpa:run" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "workflow_id", "name", "state", "started_at", "ended_at", "results" ], "properties": { "id": { "type": "string" }, "workflow_id": { "type": "string" }, "name": { "type": "string" }, "state": { "anyOf": [ { "type": "string", "enum": [ "running" ] }, { "type": "string", "enum": [ "completed" ] }, { "type": "string", "enum": [ "failed" ] }, { "type": "string", "enum": [ "cancelled" ] }, { "type": "string", "enum": [ "interrupted" ] } ] }, "started_at": { "type": "integer" }, "ended_at": { "type": [ "integer", "null" ] }, "results": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "state", "step", "error", "variables" ], "properties": { "profile_id": { "type": "string" }, "state": { "anyOf": [ { "type": "string", "enum": [ "queued" ] }, { "type": "string", "enum": [ "running" ] }, { "type": "string", "enum": [ "completed" ] }, { "type": "string", "enum": [ "failed" ] }, { "type": "string", "enum": [ "cancelled" ] } ] }, "step": { "type": "integer" }, "step_path": { "type": "array", "items": { "type": "integer" } }, "diagnostics": { "type": "array", "items": { "type": "object", "required": [ "workflow_id", "path", "action", "repeat", "attempt", "started_at", "duration_ms", "state" ], "properties": { "workflow_id": { "type": "string" }, "path": { "type": "array", "items": { "type": "integer" } }, "action": { "anyOf": [ { "type": "string", "enum": [ "navigate" ] }, { "type": "string", "enum": [ "click" ] }, { "type": "string", "enum": [ "type" ] }, { "type": "string", "enum": [ "key" ] }, { "type": "string", "enum": [ "wait" ] }, { "type": "string", "enum": [ "wait_selector" ] }, { "type": "string", "enum": [ "extract" ] }, { "type": "string", "enum": [ "page_data" ] }, { "type": "string", "enum": [ "tab_open" ] }, { "type": "string", "enum": [ "tab_switch" ] }, { "type": "string", "enum": [ "tab_close" ] }, { "type": "string", "enum": [ "frame_enter" ] }, { "type": "string", "enum": [ "frame_parent" ] }, { "type": "string", "enum": [ "frame_top" ] }, { "type": "string", "enum": [ "reload" ] }, { "type": "string", "enum": [ "hover" ] }, { "type": "string", "enum": [ "double_click" ] }, { "type": "string", "enum": [ "right_click" ] }, { "type": "string", "enum": [ "scroll" ] }, { "type": "string", "enum": [ "select" ] }, { "type": "string", "enum": [ "attribute" ] }, { "type": "string", "enum": [ "screenshot" ] }, { "type": "string", "enum": [ "cookies_get" ] }, { "type": "string", "enum": [ "cookies_set" ] }, { "type": "string", "enum": [ "cookies_delete" ] }, { "type": "string", "enum": [ "focus" ] }, { "type": "string", "enum": [ "exists" ] }, { "type": "string", "enum": [ "attribute_set" ] }, { "type": "string", "enum": [ "mouse_move" ] }, { "type": "string", "enum": [ "wheel" ] }, { "type": "string", "enum": [ "history_back" ] }, { "type": "string", "enum": [ "history_forward" ] }, { "type": "string", "enum": [ "tab_list" ] }, { "type": "string", "enum": [ "tab_activate" ] }, { "type": "string", "enum": [ "script" ] }, { "type": "string", "enum": [ "workflow_call" ] }, { "type": "string", "enum": [ "branch" ] }, { "type": "string", "enum": [ "loop_count" ] }, { "type": "string", "enum": [ "loop_data" ] }, { "type": "string", "enum": [ "loop_elements" ] }, { "type": "string", "enum": [ "element_capture" ] }, { "type": "string", "enum": [ "element_release" ] }, { "type": "string", "enum": [ "loop_while" ] }, { "type": "string", "enum": [ "loop_break" ] }, { "type": "string", "enum": [ "loop_continue" ] }, { "type": "string", "enum": [ "variable_set" ] }, { "type": "string", "enum": [ "global" ] }, { "type": "string", "enum": [ "data_transform" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "service" ] }, { "type": "string", "enum": [ "network" ] } ] }, "repeat": { "type": "integer" }, "attempt": { "type": "integer" }, "started_at": { "type": "integer" }, "duration_ms": { "type": "integer" }, "state": { "anyOf": [ { "type": "string", "enum": [ "completed" ] }, { "type": "string", "enum": [ "failed" ] }, { "type": "string", "enum": [ "cancelled" ] }, { "type": "string", "enum": [ "control" ] } ] }, "error_code": { "type": "string" } } } }, "diagnostics_dropped": { "type": "integer" }, "error": { "type": [ "string", "null" ] }, "variables": { "type": "object", "additionalProperties": { "type": "string" } } } } } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/automation/runs/{id}/cancel": { "post": { "summary": "RPA-Aufgabe abbrechen", "tags": [ "Automation" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "runtime:control", "rpa:run" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/conflicts": { "get": { "summary": "Aktuelle Synchronisierungskonflikte anzeigen", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "kind", "name", "token", "local", "cloud", "can_keep_local" ], "properties": { "id": { "type": "string" }, "kind": { "anyOf": [ { "type": "string", "enum": [ "group" ] }, { "type": "string", "enum": [ "trash" ] } ] }, "name": { "type": "string" }, "token": { "type": "string" }, "local": { "type": "string" }, "cloud": { "type": "string" }, "can_keep_local": { "type": "boolean" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/conflicts/resolve": { "post": { "summary": "Angezeigten Synchronisierungskonflikt auflösen", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "token", "choice" ], "properties": { "token": { "type": "string", "minLength": 64, "maxLength": 64 }, "choice": { "anyOf": [ { "type": "string", "enum": [ "local" ] }, { "type": "string", "enum": [ "cloud" ] } ] } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/synchronize": { "post": { "summary": "Automatischen Cloud-Profilabgleich jetzt ausführen", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "connected", "local_connection", "cloud_team_id", "profile_sync", "key_sync", "hosting", "server_url", "links", "group_sync", "busy", "cross_team_transfers", "transfers" ], "properties": { "connected": { "type": "boolean" }, "local_connection": { "type": "boolean" }, "cloud_team_id": { "type": [ "string", "null" ] }, "profile_sync": { "type": "object", "required": [ "running", "last_synced", "error" ], "properties": { "running": { "type": "boolean" }, "last_synced": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } }, "key_sync": { "type": "object", "required": [ "running", "checked", "updated", "last_synced", "error" ], "properties": { "running": { "type": "boolean" }, "checked": { "type": "integer" }, "updated": { "type": "integer" }, "last_synced": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } }, "hosting": { "type": "boolean" }, "server_url": { "type": [ "string", "null" ] }, "links": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "remote_id", "version", "error" ], "properties": { "profile_id": { "type": "string" }, "remote_id": { "type": "string" }, "version": { "type": "integer" }, "error": { "type": [ "string", "null" ] }, "warning": { "type": [ "string", "null" ] }, "scope": { "anyOf": [ { "type": "string", "enum": [ "profile" ] }, { "type": "string", "enum": [ "cookies" ] }, { "type": "string", "enum": [ "browser" ] } ] }, "dirty": { "type": "boolean" }, "auto_blocked": { "type": "boolean" }, "synced_seq": { "type": "integer" }, "synced_stamp": { "type": "string" } } } }, "group_sync": { "type": "array", "items": { "type": "object", "required": [ "group_id", "remote_group_id", "mode" ], "properties": { "group_id": { "type": "string" }, "remote_group_id": { "type": "string" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "cookies" ] }, { "type": "string", "enum": [ "browser" ] } ] } } } }, "busy": { "type": "array", "items": { "type": "string" } }, "cross_team_transfers": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "target_team", "mode", "completed" ], "properties": { "profile_id": { "type": "string" }, "target_team": { "type": "string" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "transfer" ] }, { "type": "string", "enum": [ "share" ] } ] }, "completed": { "type": "boolean" } } } }, "transfers": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "phase", "started_at", "updated_at" ], "properties": { "profile_id": { "type": "string" }, "phase": { "anyOf": [ { "type": "string", "enum": [ "preparing" ] }, { "type": "string", "enum": [ "uploading" ] }, { "type": "string", "enum": [ "downloading" ] }, { "type": "string", "enum": [ "applying" ] } ] }, "started_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/group-sync/{id}": { "put": { "summary": "Automatischen Cookie- oder Browserdatenabgleich einer lokalen Gruppe einstellen", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "null" }, { "type": "object", "required": [ "remote_group_id", "mode" ], "properties": { "remote_group_id": { "type": "string", "minLength": 1, "maxLength": 64 }, "mode": { "anyOf": [ { "type": "string", "enum": [ "cookies" ] }, { "type": "string", "enum": [ "browser" ] } ] } }, "additionalProperties": false } ] } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles/{id}": { "delete": { "summary": "Team-Freigabe einschließlich aller Serverversionen löschen", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "pending_bytes" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "pending_bytes": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles/{id}/versions/{version}": { "delete": { "summary": "Alte Serverversion einer Team-Freigabe löschen", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "path", "name": "version", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "pending_bytes" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "pending_bytes": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/hosted/config": { "get": { "summary": "Freigabe der lokalen Browserausführung anzeigen", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled", "profile_ids", "max_sessions" ], "properties": { "enabled": { "type": "boolean" }, "profile_ids": { "type": "array", "items": { "type": "string" } }, "max_sessions": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Lokale Profile zur Browserausführung auf dem Teamhost freigeben", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled", "profile_ids", "max_sessions" ], "properties": { "enabled": { "type": "boolean" }, "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 500, "uniqueItems": true }, "max_sessions": { "type": "integer", "minimum": 1, "maximum": 20 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled", "profile_ids", "max_sessions" ], "properties": { "enabled": { "type": "boolean" }, "profile_ids": { "type": "array", "items": { "type": "string" } }, "max_sessions": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/hosted/profiles": { "get": { "summary": "Ausführbare Profile und Sitzungen auf dem Teamhost", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled", "max_sessions", "items" ], "properties": { "enabled": { "type": "boolean" }, "max_sessions": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "session" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "session": { "anyOf": [ { "type": "object", "required": [ "remote_id", "member_id", "member_name", "state", "browser" ], "properties": { "remote_id": { "type": "string" }, "member_id": { "type": "string" }, "member_name": { "type": "string" }, "state": { "anyOf": [ { "type": "string", "enum": [ "starting" ] }, { "type": "string", "enum": [ "running" ] }, { "type": "string", "enum": [ "stopping" ] } ] }, "browser": { "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": [ "string", "null" ] }, "kernel": { "type": "object", "required": [ "engine", "version", "build", "source" ], "properties": { "engine": { "type": "string" }, "version": { "type": "string" }, "build": { "type": "string" }, "source": { "type": "string" } } }, "relay_port": { "type": [ "integer", "null" ] }, "exit_ip": { "type": [ "string", "null" ] }, "proxy_country": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "languages": { "type": "array", "items": { "type": "string" } }, "started_at": { "type": "integer" } } }, { "type": "null" } ] } } }, { "type": "null" } ] } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/hosted/profiles/{id}/start": { "post": { "summary": "Freigegebenen Browser auf dem lokalen Teamhost starten", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "remote_id", "member_id", "member_name", "state", "browser" ], "properties": { "remote_id": { "type": "string" }, "member_id": { "type": "string" }, "member_name": { "type": "string" }, "state": { "anyOf": [ { "type": "string", "enum": [ "starting" ] }, { "type": "string", "enum": [ "running" ] }, { "type": "string", "enum": [ "stopping" ] } ] }, "browser": { "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": [ "string", "null" ] }, "kernel": { "type": "object", "required": [ "engine", "version", "build", "source" ], "properties": { "engine": { "type": "string" }, "version": { "type": "string" }, "build": { "type": "string" }, "source": { "type": "string" } } }, "relay_port": { "type": [ "integer", "null" ] }, "exit_ip": { "type": [ "string", "null" ] }, "proxy_country": { "type": [ "string", "null" ] }, "timezone": { "type": [ "string", "null" ] }, "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" } } } } } } }, "/api/v1/team/hosted/profiles/{id}/stop": { "post": { "summary": "Eigene Host-Sitzung beenden", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profile-groups": { "get": { "summary": "Zugängliche Team-Profilgruppen auflisten", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "member_ids", "profiles" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "member_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "profiles": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Team-Profilgruppe erstellen", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "member_ids" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "member_ids": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 100, "uniqueItems": true } ] } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "member_ids", "profiles" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "member_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "profiles": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profile-groups/{id}": { "put": { "summary": "Team-Profilgruppe ändern", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "member_ids" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "member_ids": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 100, "uniqueItems": true } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "member_ids", "profiles" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "member_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "profiles": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Nicht verwendete Team-Profilgruppe löschen", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/permission-groups": { "get": { "summary": "Team-Berechtigungsgruppen auflisten", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "permissions", "members" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "profiles:read" ] }, { "type": "string", "enum": [ "profiles:create" ] }, { "type": "string", "enum": [ "profiles:publish" ] }, { "type": "string", "enum": [ "profiles:hosted" ] }, { "type": "string", "enum": [ "profiles:delete" ] }, { "type": "string", "enum": [ "profiles:history_delete" ] }, { "type": "string", "enum": [ "workflows:share" ] }, { "type": "string", "enum": [ "members:manage" ] }, { "type": "string", "enum": [ "vaults:read" ] }, { "type": "string", "enum": [ "vaults:publish" ] }, { "type": "string", "enum": [ "vaults:delete" ] } ] } }, "members": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Team-Berechtigungsgruppe erstellen", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "permissions" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "permissions": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "profiles:read" ] }, { "type": "string", "enum": [ "profiles:create" ] }, { "type": "string", "enum": [ "profiles:publish" ] }, { "type": "string", "enum": [ "profiles:hosted" ] }, { "type": "string", "enum": [ "profiles:delete" ] }, { "type": "string", "enum": [ "profiles:history_delete" ] }, { "type": "string", "enum": [ "workflows:share" ] }, { "type": "string", "enum": [ "members:manage" ] }, { "type": "string", "enum": [ "vaults:read" ] }, { "type": "string", "enum": [ "vaults:publish" ] }, { "type": "string", "enum": [ "vaults:delete" ] } ] }, "maxItems": 11, "uniqueItems": true } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "permissions", "members" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "profiles:read" ] }, { "type": "string", "enum": [ "profiles:create" ] }, { "type": "string", "enum": [ "profiles:publish" ] }, { "type": "string", "enum": [ "profiles:hosted" ] }, { "type": "string", "enum": [ "profiles:delete" ] }, { "type": "string", "enum": [ "profiles:history_delete" ] }, { "type": "string", "enum": [ "workflows:share" ] }, { "type": "string", "enum": [ "members:manage" ] }, { "type": "string", "enum": [ "vaults:read" ] }, { "type": "string", "enum": [ "vaults:publish" ] }, { "type": "string", "enum": [ "vaults:delete" ] } ] } }, "members": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/permission-groups/{id}": { "put": { "summary": "Team-Berechtigungsgruppe ändern", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "permissions" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "permissions": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "profiles:read" ] }, { "type": "string", "enum": [ "profiles:create" ] }, { "type": "string", "enum": [ "profiles:publish" ] }, { "type": "string", "enum": [ "profiles:hosted" ] }, { "type": "string", "enum": [ "profiles:delete" ] }, { "type": "string", "enum": [ "profiles:history_delete" ] }, { "type": "string", "enum": [ "workflows:share" ] }, { "type": "string", "enum": [ "members:manage" ] }, { "type": "string", "enum": [ "vaults:read" ] }, { "type": "string", "enum": [ "vaults:publish" ] }, { "type": "string", "enum": [ "vaults:delete" ] } ] }, "maxItems": 11, "uniqueItems": true } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "permissions", "members" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "profiles:read" ] }, { "type": "string", "enum": [ "profiles:create" ] }, { "type": "string", "enum": [ "profiles:publish" ] }, { "type": "string", "enum": [ "profiles:hosted" ] }, { "type": "string", "enum": [ "profiles:delete" ] }, { "type": "string", "enum": [ "profiles:history_delete" ] }, { "type": "string", "enum": [ "workflows:share" ] }, { "type": "string", "enum": [ "members:manage" ] }, { "type": "string", "enum": [ "vaults:read" ] }, { "type": "string", "enum": [ "vaults:publish" ] }, { "type": "string", "enum": [ "vaults:delete" ] } ] } }, "members": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Nicht zugewiesene Team-Berechtigungsgruppe löschen", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/members/{id}/permission-group": { "put": { "summary": "Berechtigungsgruppe einem Teammitglied zuweisen", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "group_id" ], "properties": { "group_id": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 64 } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "group_id" ], "properties": { "group_id": { "type": [ "string", "null" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles/{id}/access": { "get": { "summary": "Empfängerauswahl einer Team-Freigabe", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "member_ids", "group_id" ], "properties": { "member_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "group_id": { "type": [ "string", "null" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Zugriff auf eine Team-Freigabe beschränken", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "member_ids": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 100, "uniqueItems": true } ] }, "group_id": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 64 } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "member_ids", "group_id" ], "properties": { "member_ids": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "group_id": { "type": [ "string", "null" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/members/{id}/role": { "put": { "summary": "Team-Rolle ändern", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "role" ], "properties": { "role": { "anyOf": [ { "type": "string", "enum": [ "admin" ] }, { "type": "string", "enum": [ "editor" ] }, { "type": "string", "enum": [ "viewer" ] } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "role", "public_key" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "anyOf": [ { "type": "string", "enum": [ "owner" ] }, { "type": "string", "enum": [ "admin" ] }, { "type": "string", "enum": [ "editor" ] }, { "type": "string", "enum": [ "viewer" ] } ] }, "public_key": { "type": "string" }, "principal_id": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles/{id}/versions": { "delete": { "summary": "Frühere Cloud-Versionen löschen und aktuellen Stand behalten", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "query", "name": "base_version", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "pending_bytes" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] }, "pending_bytes": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "get": { "summary": "Zugängliche Versionen einer Team-Freigabe", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "query", "name": "before", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "next_before" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "group_id", "version", "size", "updated_at", "name", "scope", "kernel", "synced_by" ], "properties": { "id": { "type": "string" }, "group_id": { "type": [ "string", "null" ] }, "version": { "type": "integer" }, "size": { "type": "integer" }, "updated_at": { "type": "integer" }, "name": { "type": "string" }, "scope": { "anyOf": [ { "type": "string", "enum": [ "profile" ] }, { "type": "string", "enum": [ "cookies" ] }, { "type": "string", "enum": [ "browser" ] } ] }, "kernel": { "type": [ "string", "null" ] }, "synced_by": { "type": [ "string", "null" ] } } } }, "next_before": { "type": [ "integer", "null" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles/{id}/versions/{version}/restore": { "post": { "summary": "Frühere Cloud-Version im bestehenden Profil wiederherstellen", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "profile_id", "row_version" ], "properties": { "profile_id": { "type": "string", "minLength": 1, "maxLength": 64 }, "row_version": { "type": "integer", "minimum": 1 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "path", "name": "version", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "profile_id", "version", "published", "error" ], "properties": { "profile_id": { "type": "string" }, "version": { "type": "integer" }, "published": { "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" } } } } } } }, "/api/v1/team/profiles/{id}/versions/{version}/download": { "post": { "summary": "Frühere Team-Version als unabhängige lokale Kopie laden", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "in": "path", "name": "version", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "profile_id", "version" ], "properties": { "profile_id": { "type": "string" }, "version": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team": { "get": { "summary": "Team- und Synchronisierungsstatus", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "connected", "local_connection", "cloud_team_id", "profile_sync", "key_sync", "hosting", "server_url", "links", "group_sync", "busy", "cross_team_transfers", "transfers" ], "properties": { "connected": { "type": "boolean" }, "local_connection": { "type": "boolean" }, "cloud_team_id": { "type": [ "string", "null" ] }, "profile_sync": { "type": "object", "required": [ "running", "last_synced", "error" ], "properties": { "running": { "type": "boolean" }, "last_synced": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } }, "key_sync": { "type": "object", "required": [ "running", "checked", "updated", "last_synced", "error" ], "properties": { "running": { "type": "boolean" }, "checked": { "type": "integer" }, "updated": { "type": "integer" }, "last_synced": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } }, "hosting": { "type": "boolean" }, "server_url": { "type": [ "string", "null" ] }, "links": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "remote_id", "version", "error" ], "properties": { "profile_id": { "type": "string" }, "remote_id": { "type": "string" }, "version": { "type": "integer" }, "error": { "type": [ "string", "null" ] }, "warning": { "type": [ "string", "null" ] }, "scope": { "anyOf": [ { "type": "string", "enum": [ "profile" ] }, { "type": "string", "enum": [ "cookies" ] }, { "type": "string", "enum": [ "browser" ] } ] }, "dirty": { "type": "boolean" }, "auto_blocked": { "type": "boolean" }, "synced_seq": { "type": "integer" }, "synced_stamp": { "type": "string" } } } }, "group_sync": { "type": "array", "items": { "type": "object", "required": [ "group_id", "remote_group_id", "mode" ], "properties": { "group_id": { "type": "string" }, "remote_group_id": { "type": "string" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "cookies" ] }, { "type": "string", "enum": [ "browser" ] } ] } } } }, "busy": { "type": "array", "items": { "type": "string" } }, "cross_team_transfers": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "target_team", "mode", "completed" ], "properties": { "profile_id": { "type": "string" }, "target_team": { "type": "string" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "transfer" ] }, { "type": "string", "enum": [ "share" ] } ] }, "completed": { "type": "boolean" } } } }, "transfers": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "phase", "started_at", "updated_at" ], "properties": { "profile_id": { "type": "string" }, "phase": { "anyOf": [ { "type": "string", "enum": [ "preparing" ] }, { "type": "string", "enum": [ "uploading" ] }, { "type": "string", "enum": [ "downloading" ] }, { "type": "string", "enum": [ "applying" ] } ] }, "started_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/info": { "get": { "summary": "Team-Mitgliedschaft und Speicherlimit", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "member", "quota", "used", "accounting" ], "properties": { "member": { "type": "object", "required": [ "id", "name", "role", "public_key", "permissions", "permission_group_id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "anyOf": [ { "type": "string", "enum": [ "owner" ] }, { "type": "string", "enum": [ "admin" ] }, { "type": "string", "enum": [ "editor" ] }, { "type": "string", "enum": [ "viewer" ] } ] }, "public_key": { "type": "string" }, "principal_id": { "type": "string" }, "permissions": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "profiles:read" ] }, { "type": "string", "enum": [ "profiles:create" ] }, { "type": "string", "enum": [ "profiles:publish" ] }, { "type": "string", "enum": [ "profiles:hosted" ] }, { "type": "string", "enum": [ "profiles:delete" ] }, { "type": "string", "enum": [ "profiles:history_delete" ] }, { "type": "string", "enum": [ "workflows:share" ] }, { "type": "string", "enum": [ "members:manage" ] }, { "type": "string", "enum": [ "vaults:read" ] }, { "type": "string", "enum": [ "vaults:publish" ] }, { "type": "string", "enum": [ "vaults:delete" ] } ] } }, "permission_group_id": { "type": [ "string", "null" ] } } }, "quota": { "type": "integer" }, "used": { "type": "integer" }, "accounting": { "anyOf": [ { "type": "object", "required": [ "pending", "error" ], "properties": { "pending": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } }, { "type": "null" } ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/members": { "get": { "summary": "Team-Mitglieder", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "role", "public_key", "permissions", "permission_group_id" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "anyOf": [ { "type": "string", "enum": [ "owner" ] }, { "type": "string", "enum": [ "admin" ] }, { "type": "string", "enum": [ "editor" ] }, { "type": "string", "enum": [ "viewer" ] } ] }, "public_key": { "type": "string" }, "principal_id": { "type": "string" }, "permissions": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "profiles:read" ] }, { "type": "string", "enum": [ "profiles:create" ] }, { "type": "string", "enum": [ "profiles:publish" ] }, { "type": "string", "enum": [ "profiles:hosted" ] }, { "type": "string", "enum": [ "profiles:delete" ] }, { "type": "string", "enum": [ "profiles:history_delete" ] }, { "type": "string", "enum": [ "workflows:share" ] }, { "type": "string", "enum": [ "members:manage" ] }, { "type": "string", "enum": [ "vaults:read" ] }, { "type": "string", "enum": [ "vaults:publish" ] }, { "type": "string", "enum": [ "vaults:delete" ] } ] } }, "permission_group_id": { "type": [ "string", "null" ] } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles": { "get": { "summary": "Für dieses Mitglied verschlüsselte Profile", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "group_id", "version", "size", "updated_at", "name", "scope" ], "properties": { "id": { "type": "string" }, "group_id": { "type": [ "string", "null" ] }, "version": { "type": "integer" }, "size": { "type": "integer" }, "updated_at": { "type": "integer" }, "name": { "type": "string" }, "scope": { "anyOf": [ { "type": "string", "enum": [ "profile" ] }, { "type": "string", "enum": [ "cookies" ] }, { "type": "string", "enum": [ "browser" ] } ] } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/cloud/connect": { "post": { "summary": "Cloud-Abgleich mit dem angemeldeten Kontoteam verbinden", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "connected", "local_connection", "cloud_team_id", "profile_sync", "key_sync", "hosting", "server_url", "links", "group_sync", "busy", "cross_team_transfers", "transfers" ], "properties": { "connected": { "type": "boolean" }, "local_connection": { "type": "boolean" }, "cloud_team_id": { "type": [ "string", "null" ] }, "profile_sync": { "type": "object", "required": [ "running", "last_synced", "error" ], "properties": { "running": { "type": "boolean" }, "last_synced": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } }, "key_sync": { "type": "object", "required": [ "running", "checked", "updated", "last_synced", "error" ], "properties": { "running": { "type": "boolean" }, "checked": { "type": "integer" }, "updated": { "type": "integer" }, "last_synced": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } }, "hosting": { "type": "boolean" }, "server_url": { "type": [ "string", "null" ] }, "links": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "remote_id", "version", "error" ], "properties": { "profile_id": { "type": "string" }, "remote_id": { "type": "string" }, "version": { "type": "integer" }, "error": { "type": [ "string", "null" ] }, "warning": { "type": [ "string", "null" ] }, "scope": { "anyOf": [ { "type": "string", "enum": [ "profile" ] }, { "type": "string", "enum": [ "cookies" ] }, { "type": "string", "enum": [ "browser" ] } ] }, "dirty": { "type": "boolean" }, "auto_blocked": { "type": "boolean" }, "synced_seq": { "type": "integer" }, "synced_stamp": { "type": "string" } } } }, "group_sync": { "type": "array", "items": { "type": "object", "required": [ "group_id", "remote_group_id", "mode" ], "properties": { "group_id": { "type": "string" }, "remote_group_id": { "type": "string" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "cookies" ] }, { "type": "string", "enum": [ "browser" ] } ] } } } }, "busy": { "type": "array", "items": { "type": "string" } }, "cross_team_transfers": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "target_team", "mode", "completed" ], "properties": { "profile_id": { "type": "string" }, "target_team": { "type": "string" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "transfer" ] }, { "type": "string", "enum": [ "share" ] } ] }, "completed": { "type": "boolean" } } } }, "transfers": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "phase", "started_at", "updated_at" ], "properties": { "profile_id": { "type": "string" }, "phase": { "anyOf": [ { "type": "string", "enum": [ "preparing" ] }, { "type": "string", "enum": [ "uploading" ] }, { "type": "string", "enum": [ "downloading" ] }, { "type": "string", "enum": [ "applying" ] } ] }, "started_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/host": { "post": { "summary": "Lokalen Teamdienst starten", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "connected", "local_connection", "cloud_team_id", "profile_sync", "key_sync", "hosting", "server_url", "links", "group_sync", "busy", "cross_team_transfers", "transfers" ], "properties": { "connected": { "type": "boolean" }, "local_connection": { "type": "boolean" }, "cloud_team_id": { "type": [ "string", "null" ] }, "profile_sync": { "type": "object", "required": [ "running", "last_synced", "error" ], "properties": { "running": { "type": "boolean" }, "last_synced": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } }, "key_sync": { "type": "object", "required": [ "running", "checked", "updated", "last_synced", "error" ], "properties": { "running": { "type": "boolean" }, "checked": { "type": "integer" }, "updated": { "type": "integer" }, "last_synced": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } }, "hosting": { "type": "boolean" }, "server_url": { "type": [ "string", "null" ] }, "links": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "remote_id", "version", "error" ], "properties": { "profile_id": { "type": "string" }, "remote_id": { "type": "string" }, "version": { "type": "integer" }, "error": { "type": [ "string", "null" ] }, "warning": { "type": [ "string", "null" ] }, "scope": { "anyOf": [ { "type": "string", "enum": [ "profile" ] }, { "type": "string", "enum": [ "cookies" ] }, { "type": "string", "enum": [ "browser" ] } ] }, "dirty": { "type": "boolean" }, "auto_blocked": { "type": "boolean" }, "synced_seq": { "type": "integer" }, "synced_stamp": { "type": "string" } } } }, "group_sync": { "type": "array", "items": { "type": "object", "required": [ "group_id", "remote_group_id", "mode" ], "properties": { "group_id": { "type": "string" }, "remote_group_id": { "type": "string" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "cookies" ] }, { "type": "string", "enum": [ "browser" ] } ] } } } }, "busy": { "type": "array", "items": { "type": "string" } }, "cross_team_transfers": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "target_team", "mode", "completed" ], "properties": { "profile_id": { "type": "string" }, "target_team": { "type": "string" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "transfer" ] }, { "type": "string", "enum": [ "share" ] } ] }, "completed": { "type": "boolean" } } } }, "transfers": { "type": "array", "items": { "type": "object", "required": [ "profile_id", "phase", "started_at", "updated_at" ], "properties": { "profile_id": { "type": "string" }, "phase": { "anyOf": [ { "type": "string", "enum": [ "preparing" ] }, { "type": "string", "enum": [ "uploading" ] }, { "type": "string", "enum": [ "downloading" ] }, { "type": "string", "enum": [ "applying" ] } ] }, "started_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/host/stop": { "post": { "summary": "Lokalen Teamdienst stoppen", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/invitations": { "post": { "summary": "Einmalige Team-Einladung erstellen", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "role" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "role": { "anyOf": [ { "type": "string", "enum": [ "admin" ] }, { "type": "string", "enum": [ "editor" ] }, { "type": "string", "enum": [ "viewer" ] } ] } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "invitation_code", "expires_at" ], "properties": { "invitation_code": { "type": "string" }, "expires_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/join": { "post": { "summary": "Lokaler Team-Einladung beitreten", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "invitation_code" ], "properties": { "invitation_code": { "type": "string", "minLength": 1, "maxLength": 4096 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/disconnect": { "post": { "summary": "Team-Zugang auf diesem Gerät trennen", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/members/{id}": { "delete": { "summary": "Team-Zugang widerrufen", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles/{id}/transfer/cancel": { "post": { "summary": "Noch nicht übernommene Teamübertragung abbrechen", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles/{id}/transfer/keep-local": { "post": { "summary": "Bestätigte Teamübertragung abschließen und lokale Kopie behalten", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles/{id}/transfer": { "post": { "summary": "Profil in ein anderes Kontoteam übertragen oder teilen", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "target_team_id", "mode", "password" ], "properties": { "target_team_id": { "type": "string", "pattern": "^team_[A-Za-z0-9_-]{1,128}$", "example": "team_example" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "transfer" ] }, { "type": "string", "enum": [ "share" ] } ] }, "password": { "type": "string", "maxLength": 1024 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "mode" ], "properties": { "id": { "type": "string" }, "mode": { "anyOf": [ { "type": "string", "enum": [ "transfer" ] }, { "type": "string", "enum": [ "share" ] } ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles/{id}/publish": { "post": { "summary": "Geschlossenes Profil verschlüsselt im Team veröffentlichen", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "member_ids": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "maxItems": 100, "uniqueItems": true } ] }, "group_id": { "anyOf": [ { "type": "null" }, { "type": "string", "minLength": 1, "maxLength": 64 } ] } } } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "version" ], "properties": { "id": { "type": "string" }, "version": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles/{id}/download": { "post": { "summary": "Freigabe als neues lokales Profil laden", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "profile_id", "version" ], "properties": { "profile_id": { "type": "string" }, "version": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/profiles/{id}/unlink": { "post": { "summary": "Lokales Profil von der Team-Freigabe lösen", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/group-vaults": { "get": { "summary": "Zugängliche verschlüsselte Team-Gruppentresore", "tags": [ "Team" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "group_id", "version", "size", "updated_at", "member_id" ], "properties": { "group_id": { "type": "string" }, "version": { "type": "integer" }, "size": { "type": "integer" }, "updated_at": { "type": "integer" }, "member_id": { "type": "string" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/group-vaults/{id}/recipients": { "get": { "summary": "Aktuelle Version und Empfänger vor Veröffentlichung eines Gruppentresors", "tags": [ "Team" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "base_version", "items" ], "properties": { "base_version": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "role", "public_key" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "role": { "anyOf": [ { "type": "string", "enum": [ "owner" ] }, { "type": "string", "enum": [ "admin" ] }, { "type": "string", "enum": [ "editor" ] }, { "type": "string", "enum": [ "viewer" ] } ] }, "public_key": { "type": "string" }, "principal_id": { "type": "string" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/group-vaults/{id}/publish": { "post": { "summary": "Lokalen Gruppentresor ausdrücklich für die ausgewählten Teamempfänger verschlüsseln", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "local_group_id", "base_version", "confirm", "recipient_ids" ], "properties": { "local_group_id": { "type": "string" }, "base_version": { "type": "integer", "minimum": 0, "maximum": 9007199254740990 }, "confirm": { "type": "boolean", "enum": [ true ] }, "recipient_ids": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 100, "uniqueItems": true } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin", "profiles:read", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "group_id", "version", "size", "updated_at", "member_id" ], "properties": { "group_id": { "type": "string" }, "version": { "type": "integer" }, "size": { "type": "integer" }, "updated_at": { "type": "integer" }, "member_id": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/group-vaults/{id}/import": { "post": { "summary": "Team-Gruppentresor in eine lokale Gruppe importieren", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "local_group_id", "version", "update_existing", "confirm" ], "properties": { "local_group_id": { "type": "string" }, "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740990 }, "update_existing": { "type": "boolean" }, "confirm": { "type": "boolean", "enum": [ true ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin", "profiles:write", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "created", "updated", "skipped", "version" ], "properties": { "created": { "type": "integer" }, "updated": { "type": "integer" }, "skipped": { "type": "integer" }, "version": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/team/group-vaults/{id}/remove": { "post": { "summary": "Veröffentlichten Gruppentresor entfernen; lokale Kopien behalten", "tags": [ "Team" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "version", "confirm" ], "properties": { "version": { "type": "integer", "minimum": 0, "maximum": 9007199254740990 }, "confirm": { "type": "boolean", "enum": [ true ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok" ], "properties": { "ok": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tokens": { "get": { "summary": "API-Tokens auflisten (ohne Klartext)", "tags": [ "Tokens" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "kind", "token_hint", "scopes", "created_at", "last_used_at", "expires_at", "revoked_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "token_hint": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "integer" }, "last_used_at": { "type": [ "null", "integer" ] }, "expires_at": { "type": [ "null", "integer" ] }, "revoked_at": { "type": [ "null", "integer" ] } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "API-Token erzeugen; der Klartext wird nur in dieser Antwort geliefert", "tags": [ "Tokens" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "kind": { "anyOf": [ { "type": "string", "enum": [ "native" ] }, { "type": "string", "enum": [ "mcp" ] }, { "type": "string", "enum": [ "compat" ] } ] }, "scope_set": { "anyOf": [ { "type": "string", "enum": [ "full" ] }, { "type": "string", "enum": [ "scripts" ] }, { "type": "string", "enum": [ "mcp" ] } ] }, "scopes": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "profiles:read" ] }, { "type": "string", "enum": [ "profiles:write" ] }, { "type": "string", "enum": [ "profiles:delete" ] }, { "type": "string", "enum": [ "runtime:control" ] }, { "type": "string", "enum": [ "proxies:read" ] }, { "type": "string", "enum": [ "proxies:write" ] }, { "type": "string", "enum": [ "secrets:read" ] }, { "type": "string", "enum": [ "secrets:totp" ] }, { "type": "string", "enum": [ "cookies:read" ] }, { "type": "string", "enum": [ "cookies:write" ] }, { "type": "string", "enum": [ "extensions:write" ] }, { "type": "string", "enum": [ "kernels:manage" ] }, { "type": "string", "enum": [ "trash:manage" ] }, { "type": "string", "enum": [ "rpa:run" ] }, { "type": "string", "enum": [ "rpa:write" ] }, { "type": "string", "enum": [ "sync:control" ] }, { "type": "string", "enum": [ "settings:write" ] }, { "type": "string", "enum": [ "audit:read" ] }, { "type": "string", "enum": [ "admin" ] } ] }, "minItems": 1, "uniqueItems": true }, "expires_at": { "type": [ "integer", "null" ], "minimum": 0 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "token", "info" ], "properties": { "token": { "type": "string" }, "info": { "type": "object", "required": [ "id", "name", "kind", "token_hint", "scopes", "created_at", "last_used_at", "expires_at", "revoked_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "token_hint": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "integer" }, "last_used_at": { "type": [ "null", "integer" ] }, "expires_at": { "type": [ "null", "integer" ] }, "revoked_at": { "type": [ "null", "integer" ] } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tokens/{id}": { "delete": { "summary": "API-Token widerrufen", "tags": [ "Tokens" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "kind", "token_hint", "scopes", "created_at", "last_used_at", "expires_at", "revoked_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "kind": { "type": "string" }, "token_hint": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "integer" }, "last_used_at": { "type": [ "null", "integer" ] }, "expires_at": { "type": [ "null", "integer" ] }, "revoked_at": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault": { "get": { "summary": "Zustand des Tresors", "tags": [ "Tresor" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "state", "mode", "auto_lock_minutes", "reason", "method", "active_key_id", "rotation_due", "recovery_key_set" ], "properties": { "state": { "type": "string" }, "mode": { "type": "string" }, "auto_lock_minutes": { "type": "integer" }, "reason": { "type": [ "null", "string" ] }, "method": { "type": "string" }, "active_key_id": { "type": "string" }, "rotation_due": { "type": "boolean" }, "recovery_key_set": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/password": { "put": { "summary": "Masterpasswort einrichten oder ändern", "tags": [ "Tresor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string", "minLength": 12, "maxLength": 1024 }, "current_password": { "type": "string", "maxLength": 1024 }, "mode": { "anyOf": [ { "type": "string", "enum": [ "password" ] }, { "type": "string", "enum": [ "password+dpapi" ] } ] } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "password" ] }, { "type": "string", "enum": [ "password+dpapi" ] } ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/password/remove": { "post": { "summary": "Masterpasswort entfernen und Windows-Entsperrung verwenden", "tags": [ "Tresor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "current_password" ], "properties": { "current_password": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "type": "string", "enum": [ "dpapi" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/unlock": { "post": { "summary": "Tresor mit Masterpasswort entsperren", "tags": [ "Tresor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "state" ], "properties": { "state": { "type": "string", "enum": [ "unlocked" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/lock": { "post": { "summary": "Tresor sperren, wenn alle Profile und Profilaktionen beendet sind", "tags": [ "Tresor" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "state" ], "properties": { "state": { "type": "string", "enum": [ "locked" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/activity": { "post": { "summary": "Bedienaktivität für die automatische Tresorsperre melden", "tags": [ "Tresor" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "recorded" ], "properties": { "recorded": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/settings": { "put": { "summary": "Automatische Sperre nach Inaktivität einstellen; null Minuten deaktiviert sie", "tags": [ "Tresor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "auto_lock_minutes" ], "properties": { "auto_lock_minutes": { "type": "integer", "minimum": 0, "maximum": 1440 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "auto_lock_minutes" ], "properties": { "auto_lock_minutes": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/recovery-key": { "post": { "summary": "Wiederherstellungsschlüssel erzeugen; erst nach Bestätigung aktiv", "tags": [ "Tresor" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "recovery_key", "expires_at" ], "properties": { "recovery_key": { "type": "string" }, "expires_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/recovery-key/confirm": { "post": { "summary": "Wiederherstellungsschlüssel mit den letzten acht Zeichen bestätigen", "tags": [ "Tresor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "suffix" ], "properties": { "suffix": { "type": "string", "minLength": 8, "maxLength": 16 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "recovery_key_set" ], "properties": { "recovery_key_set": { "type": "boolean", "enum": [ true ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/recover": { "post": { "summary": "Tresor mit Wiederherstellungsschlüssel für den aktuellen Windows-Benutzer entsperren", "tags": [ "Tresor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "recovery_key" ], "properties": { "recovery_key": { "type": "string", "minLength": 52, "maxLength": 128 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "state" ], "properties": { "state": { "type": "string", "enum": [ "unlocked" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/missing": { "get": { "summary": "Nach dem Zurücksetzen des Tresors noch fehlende Geheimnisse (Proxys, Konten, eigene Proxys)", "tags": [ "Tresor" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "group_accounts", "reset_at", "proxies", "accounts", "profiles" ], "properties": { "group_accounts": { "type": "array", "items": { "type": "object", "required": [ "id", "group_id", "group_name", "name" ], "properties": { "id": { "type": "string" }, "group_id": { "type": "string" }, "group_name": { "type": "string" }, "name": { "type": "string" } } } }, "reset_at": { "type": [ "null", "integer" ] }, "proxies": { "type": "array", "items": { "type": "object", "required": [ "id", "label" ], "properties": { "id": { "type": "string" }, "label": { "type": "string" } } } }, "accounts": { "type": "array", "items": { "type": "object", "required": [ "id", "profile_id", "profile_no", "platform_url", "username" ], "properties": { "id": { "type": "string" }, "profile_id": { "type": "string" }, "profile_no": { "type": "integer" }, "platform_url": { "type": "string" }, "username": { "type": [ "null", "string" ] } } } }, "profiles": { "type": "array", "items": { "type": "object", "required": [ "id", "no", "name" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "name": { "type": "string" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/reset": { "post": { "summary": "Defekten Tresor neu anlegen: nicht mehr lesbare Geheimnisse werden entfernt und als fehlend gemeldet; die alte vault.json bleibt als Kopie erhalten", "tags": [ "Tresor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "confirm" ], "properties": { "confirm": { "type": "boolean", "enum": [ true ] } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "removed", "proxies", "accounts", "profiles" ], "properties": { "removed": { "type": "integer" }, "proxies": { "type": "integer" }, "accounts": { "type": "integer" }, "profiles": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/restore-secrets": { "post": { "summary": "Fehlende Geheimnisse aus einem .adbbackup-Vollbackup oder .adbprofile-Paket wiederherstellen (Proxys über Protokoll/Host/Port/Benutzer, Konten über Plattform und Benutzer)", "tags": [ "Tresor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "path", "password" ], "properties": { "path": { "type": "string", "minLength": 4, "maxLength": 1024 }, "password": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "proxies", "accounts", "profiles" ], "properties": { "proxies": { "type": "integer" }, "accounts": { "type": "integer" }, "profiles": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/vault/rotate": { "post": { "summary": "Tresorschlüssel erneuern und alle Geheimnisse neu verschlüsseln", "tags": [ "Tresor" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "rotated", "active_key_id" ], "properties": { "rotated": { "type": "integer" }, "active_key_id": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles": { "get": { "summary": "Profile suchen, filtern, sortieren und seitenweise abrufen", "tags": [ "Profile" ], "parameters": [ { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "page", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "maxLength": 512 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "ids", "required": false, "description": "Kommagetrennte Profil-IDs" }, { "schema": { "type": "string" }, "in": "query", "name": "group_id", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "tag_ids", "required": false, "description": "Kommagetrennte Tag-IDs" }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "any" ] }, { "type": "string", "enum": [ "all" ] } ] }, "in": "query", "name": "tag_mode", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "exclude_tag_ids", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "status_id", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "chromium" ] }, { "type": "string", "enum": [ "firefox" ] } ] }, "in": "query", "name": "engine", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "windows" ] }, { "type": "string", "enum": [ "macos" ] }, { "type": "string", "enum": [ "linux" ] }, { "type": "string", "enum": [ "android" ] }, { "type": "string", "enum": [ "ios" ] } ] }, "in": "query", "name": "os", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "stopped" ] }, { "type": "string", "enum": [ "starting" ] }, { "type": "string", "enum": [ "running" ] }, { "type": "string", "enum": [ "stopping" ] }, { "type": "string", "enum": [ "crashed" ] }, { "type": "string", "enum": [ "locked" ] } ] }, "in": "query", "name": "runtime_state", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "pinned", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "proxy_id", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "no" ] }, { "type": "string", "enum": [ "custom_no" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "created_at" ] }, { "type": "string", "enum": [ "updated_at" ] }, { "type": "string", "enum": [ "last_opened_at" ] } ] }, "in": "query", "name": "sort", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "asc" ] }, { "type": "string", "enum": [ "desc" ] } ] }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "pinned_first", "required": false } ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "total", "page", "limit", "next_cursor" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "no", "compat_user_id", "custom_no", "folder_key", "name", "notes", "group", "tags", "status", "pinned", "color", "engine", "engine_version", "engine_auto_update", "engine_build_last_used", "os", "os_version", "user_agent", "fingerprint", "proxy", "ip_checker", "browser_options", "net", "start_mode", "start_urls", "homepage", "launch_args", "extension_set_id", "storage_options", "clear_on_close", "cache_dir_override", "source", "imported_from", "runtime_state", "accounts_count", "created_at", "created_by", "updated_at", "updated_by", "last_opened_at", "last_closed_at", "last_exit_ip", "last_exit_country", "row_version" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "compat_user_id": { "type": "string" }, "custom_no": { "type": [ "null", "string" ] }, "folder_key": { "type": "string" }, "name": { "type": "string" }, "notes": { "type": [ "null", "string" ] }, "group": { "anyOf": [ { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "color" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } } }, "status": { "anyOf": [ { "type": "object", "required": [ "id", "name", "color" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "color": { "type": [ "null", "string" ] }, "engine": { "type": "string" }, "engine_version": { "type": "string" }, "engine_auto_update": { "type": "boolean" }, "engine_build_last_used": { "type": [ "null", "string" ] }, "os": { "type": "string" }, "os_version": { "type": [ "null", "string" ] }, "user_agent": { "type": [ "null", "string" ] }, "fingerprint": { "type": "object", "required": [ "id", "schema", "overrides", "seeds" ], "properties": { "id": { "type": "string" }, "schema": { "type": "integer" }, "overrides": { "type": "object", "additionalProperties": {} }, "seeds": { "type": "object", "required": [ "identity", "canvas", "webgl", "audio", "clientRects" ], "properties": { "identity": { "type": "integer" }, "canvas": { "type": "integer" }, "webgl": { "type": "integer" }, "audio": { "type": "integer" }, "clientRects": { "type": "integer" } } } } }, "proxy": { "type": "object", "required": [ "mode", "proxy_id", "inline" ], "properties": { "mode": { "type": "string" }, "proxy_id": { "type": [ "null", "string" ] }, "inline": { "anyOf": [ { "type": "object", "required": [ "protocol", "host", "port", "username", "password_set", "ssh_key_set" ], "properties": { "protocol": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "string", "null" ] }, "password_set": { "type": "boolean" }, "ssh_key_set": { "type": "boolean" }, "ssh_host_key": { "type": [ "string", "null" ] } } }, { "type": "null" } ] } } }, "ip_checker": { "type": [ "null", "string" ] }, "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": { "type": "string" }, "start_urls": { "type": "array", "items": { "type": "string" } }, "homepage": { "type": [ "null", "string" ] }, "launch_args": { "type": "array", "items": { "type": "string" } }, "extension_set_id": { "type": [ "null", "string" ] }, "storage_options": { "type": "object", "additionalProperties": { "type": "boolean" } }, "clear_on_close": { "type": "object", "additionalProperties": { "type": "boolean" } }, "cache_dir_override": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "imported_from": { "type": [ "null", "string" ] }, "runtime_state": { "type": "string" }, "accounts_count": { "type": "integer" }, "created_at": { "type": "integer" }, "created_by": { "type": "string" }, "updated_at": { "type": "integer" }, "updated_by": { "type": "string" }, "last_opened_at": { "type": [ "null", "integer" ] }, "last_closed_at": { "type": [ "null", "integer" ] }, "last_exit_ip": { "type": [ "null", "string" ] }, "last_exit_country": { "type": [ "null", "string" ] }, "row_version": { "type": "integer" } } } }, "total": { "type": "integer" }, "page": { "type": "integer" }, "limit": { "type": "integer" }, "next_cursor": { "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": { "summary": "Profil anlegen", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "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" ] }, "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" } }, "cache_dir_override": { "type": [ "string", "null" ], "maxLength": 512 }, "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 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "no", "compat_user_id", "custom_no", "folder_key", "name", "notes", "group", "tags", "status", "pinned", "color", "engine", "engine_version", "engine_auto_update", "engine_build_last_used", "os", "os_version", "user_agent", "fingerprint", "proxy", "ip_checker", "browser_options", "net", "start_mode", "start_urls", "homepage", "launch_args", "extension_set_id", "storage_options", "clear_on_close", "cache_dir_override", "source", "imported_from", "runtime_state", "accounts_count", "created_at", "created_by", "updated_at", "updated_by", "last_opened_at", "last_closed_at", "last_exit_ip", "last_exit_country", "row_version" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "compat_user_id": { "type": "string" }, "custom_no": { "type": [ "null", "string" ] }, "folder_key": { "type": "string" }, "name": { "type": "string" }, "notes": { "type": [ "null", "string" ] }, "group": { "anyOf": [ { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "color" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } } }, "status": { "anyOf": [ { "type": "object", "required": [ "id", "name", "color" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "color": { "type": [ "null", "string" ] }, "engine": { "type": "string" }, "engine_version": { "type": "string" }, "engine_auto_update": { "type": "boolean" }, "engine_build_last_used": { "type": [ "null", "string" ] }, "os": { "type": "string" }, "os_version": { "type": [ "null", "string" ] }, "user_agent": { "type": [ "null", "string" ] }, "fingerprint": { "type": "object", "required": [ "id", "schema", "overrides", "seeds" ], "properties": { "id": { "type": "string" }, "schema": { "type": "integer" }, "overrides": { "type": "object", "additionalProperties": {} }, "seeds": { "type": "object", "required": [ "identity", "canvas", "webgl", "audio", "clientRects" ], "properties": { "identity": { "type": "integer" }, "canvas": { "type": "integer" }, "webgl": { "type": "integer" }, "audio": { "type": "integer" }, "clientRects": { "type": "integer" } } } } }, "proxy": { "type": "object", "required": [ "mode", "proxy_id", "inline" ], "properties": { "mode": { "type": "string" }, "proxy_id": { "type": [ "null", "string" ] }, "inline": { "anyOf": [ { "type": "object", "required": [ "protocol", "host", "port", "username", "password_set", "ssh_key_set" ], "properties": { "protocol": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "string", "null" ] }, "password_set": { "type": "boolean" }, "ssh_key_set": { "type": "boolean" }, "ssh_host_key": { "type": [ "string", "null" ] } } }, { "type": "null" } ] } } }, "ip_checker": { "type": [ "null", "string" ] }, "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": { "type": "string" }, "start_urls": { "type": "array", "items": { "type": "string" } }, "homepage": { "type": [ "null", "string" ] }, "launch_args": { "type": "array", "items": { "type": "string" } }, "extension_set_id": { "type": [ "null", "string" ] }, "storage_options": { "type": "object", "additionalProperties": { "type": "boolean" } }, "clear_on_close": { "type": "object", "additionalProperties": { "type": "boolean" } }, "cache_dir_override": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "imported_from": { "type": [ "null", "string" ] }, "runtime_state": { "type": "string" }, "accounts_count": { "type": "integer" }, "created_at": { "type": "integer" }, "created_by": { "type": "string" }, "updated_at": { "type": "integer" }, "updated_by": { "type": "string" }, "last_opened_at": { "type": [ "null", "integer" ] }, "last_closed_at": { "type": [ "null", "integer" ] }, "last_exit_ip": { "type": [ "null", "string" ] }, "last_exit_country": { "type": [ "null", "string" ] }, "row_version": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/batch": { "post": { "summary": "Mehrere Profile anlegen; Ergebnis je Eintrag", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "profiles" ], "properties": { "profiles": { "type": "array", "items": { "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" ] }, "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" } }, "cache_dir_override": { "type": [ "string", "null" ], "maxLength": 512 }, "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 } }, "additionalProperties": false }, "minItems": 1, "maxItems": 1000 }, "balance_gpu": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "summary": "Mehrere Profile bearbeiten; nur angegebene Felder werden geändert", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "patch" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "patch": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "notes": { "type": [ "string", "null" ], "maxLength": 5000, "description": "Changed notes may contain up to 400 Unicode code points. Unchanged existing notes are preserved." }, "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" ] }, "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" } }, "cache_dir_override": { "type": [ "string", "null" ], "maxLength": 512 }, "regenerate_fingerprint": { "type": "boolean" }, "notes_append": { "type": "string", "maxLength": 400 }, "custom_no_sequence": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "increment" ] }, { "type": "string", "enum": [ "decrement" ] }, { "type": "string", "enum": [ "constant" ] }, { "type": "string", "enum": [ "random" ] } ] }, "start": { "type": "integer", "minimum": -1000000000, "maximum": 1000000000 }, "step": { "type": "integer", "minimum": 1, "maximum": 1000000 }, "prefix": { "type": "string", "maxLength": 32 }, "pad": { "type": "integer", "minimum": 0, "maximum": 12 } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/quick-create": { "post": { "summary": "Mehrere Profile nach Anzahl anlegen: Namensschema mit {NR}, {N}, {DATUM}, {LOGIN}, {ZUFALL:6}; eigener Fingerprint je Profil", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "count" ], "properties": { "count": { "type": "integer", "minimum": 1, "maximum": 500 }, "balance_gpu": { "type": "boolean" }, "name_pattern": { "type": "string", "minLength": 1, "maxLength": 100 }, "template_id": { "type": "string", "minLength": 1, "maxLength": 64 }, "template": { "type": "object", "properties": { "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 }, "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": {} }, "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" } }, "cache_dir_override": { "type": [ "string", "null" ], "maxLength": 512 }, "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 }, "imported_from": { "type": [ "string", "null" ], "maxLength": 64 } }, "additionalProperties": false }, "proxy": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "one" ] }, { "type": "string", "enum": [ "sequential" ] }, { "type": "string", "enum": [ "random" ] } ] }, "proxy_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 5000 }, "only_unused": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/batch/assign-group": { "post": { "summary": "Profile einer Gruppe zuordnen", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "group_id" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "group_id": { "type": "string" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/batch/assign-tags": { "post": { "summary": "Tags hinzufügen, entfernen oder ersetzen", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "tag_ids", "mode" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "tag_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 30 }, "mode": { "anyOf": [ { "type": "string", "enum": [ "add" ] }, { "type": "string", "enum": [ "remove" ] }, { "type": "string", "enum": [ "replace" ] } ] } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/by-no/{no}": { "get": { "summary": "Profil über die fortlaufende Nummer abrufen", "tags": [ "Profile" ], "parameters": [ { "schema": { "type": "integer", "minimum": 1 }, "in": "path", "name": "no", "required": true } ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "no", "compat_user_id", "custom_no", "folder_key", "name", "notes", "group", "tags", "status", "pinned", "color", "engine", "engine_version", "engine_auto_update", "engine_build_last_used", "os", "os_version", "user_agent", "fingerprint", "proxy", "ip_checker", "browser_options", "net", "start_mode", "start_urls", "homepage", "launch_args", "extension_set_id", "storage_options", "clear_on_close", "cache_dir_override", "source", "imported_from", "runtime_state", "accounts_count", "created_at", "created_by", "updated_at", "updated_by", "last_opened_at", "last_closed_at", "last_exit_ip", "last_exit_country", "row_version" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "compat_user_id": { "type": "string" }, "custom_no": { "type": [ "null", "string" ] }, "folder_key": { "type": "string" }, "name": { "type": "string" }, "notes": { "type": [ "null", "string" ] }, "group": { "anyOf": [ { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "color" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } } }, "status": { "anyOf": [ { "type": "object", "required": [ "id", "name", "color" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "color": { "type": [ "null", "string" ] }, "engine": { "type": "string" }, "engine_version": { "type": "string" }, "engine_auto_update": { "type": "boolean" }, "engine_build_last_used": { "type": [ "null", "string" ] }, "os": { "type": "string" }, "os_version": { "type": [ "null", "string" ] }, "user_agent": { "type": [ "null", "string" ] }, "fingerprint": { "type": "object", "required": [ "id", "schema", "overrides", "seeds" ], "properties": { "id": { "type": "string" }, "schema": { "type": "integer" }, "overrides": { "type": "object", "additionalProperties": {} }, "seeds": { "type": "object", "required": [ "identity", "canvas", "webgl", "audio", "clientRects" ], "properties": { "identity": { "type": "integer" }, "canvas": { "type": "integer" }, "webgl": { "type": "integer" }, "audio": { "type": "integer" }, "clientRects": { "type": "integer" } } } } }, "proxy": { "type": "object", "required": [ "mode", "proxy_id", "inline" ], "properties": { "mode": { "type": "string" }, "proxy_id": { "type": [ "null", "string" ] }, "inline": { "anyOf": [ { "type": "object", "required": [ "protocol", "host", "port", "username", "password_set", "ssh_key_set" ], "properties": { "protocol": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "string", "null" ] }, "password_set": { "type": "boolean" }, "ssh_key_set": { "type": "boolean" }, "ssh_host_key": { "type": [ "string", "null" ] } } }, { "type": "null" } ] } } }, "ip_checker": { "type": [ "null", "string" ] }, "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": { "type": "string" }, "start_urls": { "type": "array", "items": { "type": "string" } }, "homepage": { "type": [ "null", "string" ] }, "launch_args": { "type": "array", "items": { "type": "string" } }, "extension_set_id": { "type": [ "null", "string" ] }, "storage_options": { "type": "object", "additionalProperties": { "type": "boolean" } }, "clear_on_close": { "type": "object", "additionalProperties": { "type": "boolean" } }, "cache_dir_override": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "imported_from": { "type": [ "null", "string" ] }, "runtime_state": { "type": "string" }, "accounts_count": { "type": "integer" }, "created_at": { "type": "integer" }, "created_by": { "type": "string" }, "updated_at": { "type": "integer" }, "updated_by": { "type": "string" }, "last_opened_at": { "type": [ "null", "integer" ] }, "last_closed_at": { "type": [ "null", "integer" ] }, "last_exit_ip": { "type": [ "null", "string" ] }, "last_exit_country": { "type": [ "null", "string" ] }, "row_version": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}": { "get": { "summary": "Profil mit Konten (Passwörter maskiert) abrufen", "tags": [ "Profile" ], "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": { "allOf": [ { "type": "object", "required": [ "id", "no", "compat_user_id", "custom_no", "folder_key", "name", "notes", "group", "tags", "status", "pinned", "color", "engine", "engine_version", "engine_auto_update", "engine_build_last_used", "os", "os_version", "user_agent", "fingerprint", "proxy", "ip_checker", "browser_options", "net", "start_mode", "start_urls", "homepage", "launch_args", "extension_set_id", "storage_options", "clear_on_close", "cache_dir_override", "source", "imported_from", "runtime_state", "accounts_count", "created_at", "created_by", "updated_at", "updated_by", "last_opened_at", "last_closed_at", "last_exit_ip", "last_exit_country", "row_version" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "compat_user_id": { "type": "string" }, "custom_no": { "type": [ "null", "string" ] }, "folder_key": { "type": "string" }, "name": { "type": "string" }, "notes": { "type": [ "null", "string" ] }, "group": { "anyOf": [ { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "color" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } } }, "status": { "anyOf": [ { "type": "object", "required": [ "id", "name", "color" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "color": { "type": [ "null", "string" ] }, "engine": { "type": "string" }, "engine_version": { "type": "string" }, "engine_auto_update": { "type": "boolean" }, "engine_build_last_used": { "type": [ "null", "string" ] }, "os": { "type": "string" }, "os_version": { "type": [ "null", "string" ] }, "user_agent": { "type": [ "null", "string" ] }, "fingerprint": { "type": "object", "required": [ "id", "schema", "overrides", "seeds" ], "properties": { "id": { "type": "string" }, "schema": { "type": "integer" }, "overrides": { "type": "object", "additionalProperties": {} }, "seeds": { "type": "object", "required": [ "identity", "canvas", "webgl", "audio", "clientRects" ], "properties": { "identity": { "type": "integer" }, "canvas": { "type": "integer" }, "webgl": { "type": "integer" }, "audio": { "type": "integer" }, "clientRects": { "type": "integer" } } } } }, "proxy": { "type": "object", "required": [ "mode", "proxy_id", "inline" ], "properties": { "mode": { "type": "string" }, "proxy_id": { "type": [ "null", "string" ] }, "inline": { "anyOf": [ { "type": "object", "required": [ "protocol", "host", "port", "username", "password_set", "ssh_key_set" ], "properties": { "protocol": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "string", "null" ] }, "password_set": { "type": "boolean" }, "ssh_key_set": { "type": "boolean" }, "ssh_host_key": { "type": [ "string", "null" ] } } }, { "type": "null" } ] } } }, "ip_checker": { "type": [ "null", "string" ] }, "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": { "type": "string" }, "start_urls": { "type": "array", "items": { "type": "string" } }, "homepage": { "type": [ "null", "string" ] }, "launch_args": { "type": "array", "items": { "type": "string" } }, "extension_set_id": { "type": [ "null", "string" ] }, "storage_options": { "type": "object", "additionalProperties": { "type": "boolean" } }, "clear_on_close": { "type": "object", "additionalProperties": { "type": "boolean" } }, "cache_dir_override": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "imported_from": { "type": [ "null", "string" ] }, "runtime_state": { "type": "string" }, "accounts_count": { "type": "integer" }, "created_at": { "type": "integer" }, "created_by": { "type": "string" }, "updated_at": { "type": "integer" }, "updated_by": { "type": "string" }, "last_opened_at": { "type": [ "null", "integer" ] }, "last_closed_at": { "type": [ "null", "integer" ] }, "last_exit_ip": { "type": [ "null", "string" ] }, "last_exit_country": { "type": [ "null", "string" ] }, "row_version": { "type": "integer" } } }, { "type": "object", "required": [ "accounts" ], "properties": { "accounts": { "type": "array", "items": { "type": "object", "required": [ "id", "profile_id", "platform_url", "username", "password_set", "totp_set", "notes", "sort_order", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "profile_id": { "type": "string" }, "platform_url": { "type": "string" }, "username": { "type": [ "null", "string" ] }, "password_set": { "type": "boolean" }, "totp_set": { "type": "boolean" }, "notes": { "type": [ "null", "string" ] }, "sort_order": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } } ] } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "summary": "Profil bearbeiten; Kern und Betriebssystem sind nach der Anlage fest", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 100 }, "notes": { "type": [ "string", "null" ], "maxLength": 5000, "description": "Changed notes may contain up to 400 Unicode code points. Unchanged existing notes are preserved." }, "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" ] }, "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" } }, "cache_dir_override": { "type": [ "string", "null" ], "maxLength": 512 }, "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 }, "row_version": { "type": "integer", "minimum": 1 }, "regenerate_fingerprint": { "type": "boolean" } }, "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": [ "id", "no", "compat_user_id", "custom_no", "folder_key", "name", "notes", "group", "tags", "status", "pinned", "color", "engine", "engine_version", "engine_auto_update", "engine_build_last_used", "os", "os_version", "user_agent", "fingerprint", "proxy", "ip_checker", "browser_options", "net", "start_mode", "start_urls", "homepage", "launch_args", "extension_set_id", "storage_options", "clear_on_close", "cache_dir_override", "source", "imported_from", "runtime_state", "accounts_count", "created_at", "created_by", "updated_at", "updated_by", "last_opened_at", "last_closed_at", "last_exit_ip", "last_exit_country", "row_version" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "compat_user_id": { "type": "string" }, "custom_no": { "type": [ "null", "string" ] }, "folder_key": { "type": "string" }, "name": { "type": "string" }, "notes": { "type": [ "null", "string" ] }, "group": { "anyOf": [ { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, { "type": "null" } ] }, "tags": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "color" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } } }, "status": { "anyOf": [ { "type": "object", "required": [ "id", "name", "color" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" } } }, { "type": "null" } ] }, "pinned": { "type": "boolean" }, "color": { "type": [ "null", "string" ] }, "engine": { "type": "string" }, "engine_version": { "type": "string" }, "engine_auto_update": { "type": "boolean" }, "engine_build_last_used": { "type": [ "null", "string" ] }, "os": { "type": "string" }, "os_version": { "type": [ "null", "string" ] }, "user_agent": { "type": [ "null", "string" ] }, "fingerprint": { "type": "object", "required": [ "id", "schema", "overrides", "seeds" ], "properties": { "id": { "type": "string" }, "schema": { "type": "integer" }, "overrides": { "type": "object", "additionalProperties": {} }, "seeds": { "type": "object", "required": [ "identity", "canvas", "webgl", "audio", "clientRects" ], "properties": { "identity": { "type": "integer" }, "canvas": { "type": "integer" }, "webgl": { "type": "integer" }, "audio": { "type": "integer" }, "clientRects": { "type": "integer" } } } } }, "proxy": { "type": "object", "required": [ "mode", "proxy_id", "inline" ], "properties": { "mode": { "type": "string" }, "proxy_id": { "type": [ "null", "string" ] }, "inline": { "anyOf": [ { "type": "object", "required": [ "protocol", "host", "port", "username", "password_set", "ssh_key_set" ], "properties": { "protocol": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "string", "null" ] }, "password_set": { "type": "boolean" }, "ssh_key_set": { "type": "boolean" }, "ssh_host_key": { "type": [ "string", "null" ] } } }, { "type": "null" } ] } } }, "ip_checker": { "type": [ "null", "string" ] }, "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": { "type": "string" }, "start_urls": { "type": "array", "items": { "type": "string" } }, "homepage": { "type": [ "null", "string" ] }, "launch_args": { "type": "array", "items": { "type": "string" } }, "extension_set_id": { "type": [ "null", "string" ] }, "storage_options": { "type": "object", "additionalProperties": { "type": "boolean" } }, "clear_on_close": { "type": "object", "additionalProperties": { "type": "boolean" } }, "cache_dir_override": { "type": [ "null", "string" ] }, "source": { "type": [ "null", "string" ] }, "imported_from": { "type": [ "null", "string" ] }, "runtime_state": { "type": "string" }, "accounts_count": { "type": "integer" }, "created_at": { "type": "integer" }, "created_by": { "type": "string" }, "updated_at": { "type": "integer" }, "updated_by": { "type": "string" }, "last_opened_at": { "type": [ "null", "integer" ] }, "last_closed_at": { "type": [ "null", "integer" ] }, "last_exit_ip": { "type": [ "null", "string" ] }, "last_exit_country": { "type": [ "null", "string" ] }, "row_version": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Profil in den Papierkorb legen; permanent=true löscht sofort endgültig (zusätzlich trash:manage)", "tags": [ "Papierkorb" ], "parameters": [ { "schema": { "type": "boolean" }, "in": "query", "name": "permanent", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:delete" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "state" ], "properties": { "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" } } } } } } }, "/api/v1/profiles/{id}/accounts": { "get": { "summary": "Plattformkonten eines Profils (Passwörter maskiert)", "tags": [ "Konten" ], "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": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "profile_id", "platform_url", "username", "password_set", "totp_set", "notes", "sort_order", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "profile_id": { "type": "string" }, "platform_url": { "type": "string" }, "username": { "type": [ "null", "string" ] }, "password_set": { "type": "boolean" }, "totp_set": { "type": "boolean" }, "notes": { "type": [ "null", "string" ] }, "sort_order": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_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": { "summary": "Plattformkonto anlegen", "tags": [ "Konten" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "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 } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:write" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "profile_id", "platform_url", "username", "password_set", "totp_set", "notes", "sort_order", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "profile_id": { "type": "string" }, "platform_url": { "type": "string" }, "username": { "type": [ "null", "string" ] }, "password_set": { "type": "boolean" }, "totp_set": { "type": "boolean" }, "notes": { "type": [ "null", "string" ] }, "sort_order": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/accounts/{accountId}": { "patch": { "summary": "Plattformkonto ändern; password/totp_secret null entfernt den Wert", "tags": [ "Konten" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "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 } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "accountId", "required": true } ], "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "profile_id", "platform_url", "username", "password_set", "totp_set", "notes", "sort_order", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "profile_id": { "type": "string" }, "platform_url": { "type": "string" }, "username": { "type": [ "null", "string" ] }, "password_set": { "type": "boolean" }, "totp_set": { "type": "boolean" }, "notes": { "type": [ "null", "string" ] }, "sort_order": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Plattformkonto löschen", "tags": [ "Konten" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "accountId", "required": true } ], "x-required-scopes": [ "profiles:write" ], "responses": { "204": { "description": "No content." }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/accounts/{accountId}/password": { "get": { "summary": "Passwort im Klartext abrufen (wird protokolliert)", "tags": [ "Konten" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "accountId", "required": true } ], "x-required-scopes": [ "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/accounts/{accountId}/totp": { "get": { "summary": "Aktuellen 2FA-Code erzeugen", "tags": [ "Konten" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "accountId", "required": true } ], "x-required-scopes": [ "secrets:totp" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "remaining_s" ], "properties": { "code": { "type": "string" }, "remaining_s": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/encryption": { "get": { "summary": "Zustand der Verschlüsselung ruhender Profildaten", "tags": [ "Profile" ], "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": [ "enabled", "phase", "error", "busy" ], "properties": { "enabled": { "type": "boolean" }, "phase": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "busy": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Verschlüsselung ruhender Profildaten ändern", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" } }, "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": [ "enabled", "phase", "error", "busy" ], "properties": { "enabled": { "type": "boolean" }, "phase": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "busy": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/encryption/rotate": { "post": { "summary": "Profilschlüssel erneuern und ruhende Dateien ohne Klartextkopie neu verschlüsseln", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "confirm" ], "properties": { "confirm": { "type": "boolean", "enum": [ true ] } }, "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": [ "enabled", "phase", "error", "busy" ], "properties": { "enabled": { "type": "boolean" }, "phase": { "type": "string" }, "error": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "busy": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/groups": { "get": { "summary": "Gruppen mit Profilanzahl", "tags": [ "Gruppen" ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "accounts_enabled", "account_count", "browser_defaults", "id", "name", "remark", "color", "sort_order", "is_default", "pinned", "compat_group_id", "profile_count", "created_at", "updated_at", "row_version" ], "properties": { "accounts_enabled": { "type": "boolean" }, "account_count": { "type": "integer" }, "browser_defaults": { "type": "object", "properties": { "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 }, "startup": { "type": "object", "required": [ "mode", "urls" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "new_tab" ] }, { "type": "string", "enum": [ "last_tabs" ] }, { "type": "string", "enum": [ "urls" ] }, { "type": "string", "enum": [ "last_and_urls" ] } ] }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 20 } }, "additionalProperties": false }, "launch_args": { "type": "object", "properties": { "chromium": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 }, "firefox": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 } }, "additionalProperties": false }, "extension_sets": { "type": "object", "properties": { "chromium": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "firefox": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] } }, "additionalProperties": false }, "bookmarks": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "folder" ], "properties": { "title": { "type": "string", "maxLength": 512 }, "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "folder": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] } }, "additionalProperties": false }, "maxItems": 1000 } }, "additionalProperties": false }, "id": { "type": "string" }, "name": { "type": "string" }, "remark": { "type": [ "null", "string" ] }, "color": { "type": [ "null", "string" ] }, "sort_order": { "type": "integer" }, "is_default": { "type": "boolean" }, "pinned": { "type": "boolean" }, "compat_group_id": { "type": [ "null", "string" ] }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "row_version": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Gruppe anlegen", "tags": [ "Gruppen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "accounts_enabled": { "type": "boolean" }, "browser_defaults": { "type": "object", "properties": { "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 }, "startup": { "type": "object", "required": [ "mode", "urls" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "new_tab" ] }, { "type": "string", "enum": [ "last_tabs" ] }, { "type": "string", "enum": [ "urls" ] }, { "type": "string", "enum": [ "last_and_urls" ] } ] }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 20 } }, "additionalProperties": false }, "launch_args": { "type": "object", "properties": { "chromium": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 }, "firefox": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 } }, "additionalProperties": false }, "extension_sets": { "type": "object", "properties": { "chromium": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "firefox": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] } }, "additionalProperties": false }, "bookmarks": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "folder" ], "properties": { "title": { "type": "string", "maxLength": 512 }, "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "folder": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] } }, "additionalProperties": false }, "maxItems": 1000 } }, "additionalProperties": false }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "remark": { "type": [ "string", "null" ], "maxLength": 1000 }, "color": { "type": [ "string", "null" ], "maxLength": 32 }, "sort_order": { "type": "integer" }, "pinned": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "accounts_enabled", "account_count", "browser_defaults", "id", "name", "remark", "color", "sort_order", "is_default", "pinned", "compat_group_id", "profile_count", "created_at", "updated_at", "row_version" ], "properties": { "accounts_enabled": { "type": "boolean" }, "account_count": { "type": "integer" }, "browser_defaults": { "type": "object", "properties": { "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 }, "startup": { "type": "object", "required": [ "mode", "urls" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "new_tab" ] }, { "type": "string", "enum": [ "last_tabs" ] }, { "type": "string", "enum": [ "urls" ] }, { "type": "string", "enum": [ "last_and_urls" ] } ] }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 20 } }, "additionalProperties": false }, "launch_args": { "type": "object", "properties": { "chromium": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 }, "firefox": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 } }, "additionalProperties": false }, "extension_sets": { "type": "object", "properties": { "chromium": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "firefox": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] } }, "additionalProperties": false }, "bookmarks": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "folder" ], "properties": { "title": { "type": "string", "maxLength": 512 }, "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "folder": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] } }, "additionalProperties": false }, "maxItems": 1000 } }, "additionalProperties": false }, "id": { "type": "string" }, "name": { "type": "string" }, "remark": { "type": [ "null", "string" ] }, "color": { "type": [ "null", "string" ] }, "sort_order": { "type": "integer" }, "is_default": { "type": "boolean" }, "pinned": { "type": "boolean" }, "compat_group_id": { "type": [ "null", "string" ] }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "row_version": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/groups/order": { "put": { "summary": "Reihenfolge aller Gruppen speichern", "tags": [ "Gruppen" ], "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": 20000, "uniqueItems": true } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "accounts_enabled", "account_count", "browser_defaults", "id", "name", "remark", "color", "sort_order", "is_default", "pinned", "compat_group_id", "profile_count", "created_at", "updated_at", "row_version" ], "properties": { "accounts_enabled": { "type": "boolean" }, "account_count": { "type": "integer" }, "browser_defaults": { "type": "object", "properties": { "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 }, "startup": { "type": "object", "required": [ "mode", "urls" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "new_tab" ] }, { "type": "string", "enum": [ "last_tabs" ] }, { "type": "string", "enum": [ "urls" ] }, { "type": "string", "enum": [ "last_and_urls" ] } ] }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 20 } }, "additionalProperties": false }, "launch_args": { "type": "object", "properties": { "chromium": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 }, "firefox": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 } }, "additionalProperties": false }, "extension_sets": { "type": "object", "properties": { "chromium": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "firefox": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] } }, "additionalProperties": false }, "bookmarks": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "folder" ], "properties": { "title": { "type": "string", "maxLength": 512 }, "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "folder": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] } }, "additionalProperties": false }, "maxItems": 1000 } }, "additionalProperties": false }, "id": { "type": "string" }, "name": { "type": "string" }, "remark": { "type": [ "null", "string" ] }, "color": { "type": [ "null", "string" ] }, "sort_order": { "type": "integer" }, "is_default": { "type": "boolean" }, "pinned": { "type": "boolean" }, "compat_group_id": { "type": [ "null", "string" ] }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "row_version": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/groups/{id}": { "get": { "summary": "Gruppe abrufen", "tags": [ "Gruppen" ], "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": [ "accounts_enabled", "account_count", "browser_defaults", "id", "name", "remark", "color", "sort_order", "is_default", "pinned", "compat_group_id", "profile_count", "created_at", "updated_at", "row_version" ], "properties": { "accounts_enabled": { "type": "boolean" }, "account_count": { "type": "integer" }, "browser_defaults": { "type": "object", "properties": { "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 }, "startup": { "type": "object", "required": [ "mode", "urls" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "new_tab" ] }, { "type": "string", "enum": [ "last_tabs" ] }, { "type": "string", "enum": [ "urls" ] }, { "type": "string", "enum": [ "last_and_urls" ] } ] }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 20 } }, "additionalProperties": false }, "launch_args": { "type": "object", "properties": { "chromium": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 }, "firefox": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 } }, "additionalProperties": false }, "extension_sets": { "type": "object", "properties": { "chromium": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "firefox": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] } }, "additionalProperties": false }, "bookmarks": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "folder" ], "properties": { "title": { "type": "string", "maxLength": 512 }, "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "folder": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] } }, "additionalProperties": false }, "maxItems": 1000 } }, "additionalProperties": false }, "id": { "type": "string" }, "name": { "type": "string" }, "remark": { "type": [ "null", "string" ] }, "color": { "type": [ "null", "string" ] }, "sort_order": { "type": "integer" }, "is_default": { "type": "boolean" }, "pinned": { "type": "boolean" }, "compat_group_id": { "type": [ "null", "string" ] }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "row_version": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "summary": "Gruppe ändern", "tags": [ "Gruppen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accounts_enabled": { "type": "boolean" }, "browser_defaults": { "type": "object", "properties": { "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 }, "startup": { "type": "object", "required": [ "mode", "urls" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "new_tab" ] }, { "type": "string", "enum": [ "last_tabs" ] }, { "type": "string", "enum": [ "urls" ] }, { "type": "string", "enum": [ "last_and_urls" ] } ] }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 20 } }, "additionalProperties": false }, "launch_args": { "type": "object", "properties": { "chromium": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 }, "firefox": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 } }, "additionalProperties": false }, "extension_sets": { "type": "object", "properties": { "chromium": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "firefox": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] } }, "additionalProperties": false }, "bookmarks": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "folder" ], "properties": { "title": { "type": "string", "maxLength": 512 }, "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "folder": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] } }, "additionalProperties": false }, "maxItems": 1000 } }, "additionalProperties": false }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "remark": { "type": [ "string", "null" ], "maxLength": 1000 }, "color": { "type": [ "string", "null" ], "maxLength": 32 }, "sort_order": { "type": "integer" }, "pinned": { "type": "boolean" } }, "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": [ "accounts_enabled", "account_count", "browser_defaults", "id", "name", "remark", "color", "sort_order", "is_default", "pinned", "compat_group_id", "profile_count", "created_at", "updated_at", "row_version" ], "properties": { "accounts_enabled": { "type": "boolean" }, "account_count": { "type": "integer" }, "browser_defaults": { "type": "object", "properties": { "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 }, "startup": { "type": "object", "required": [ "mode", "urls" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "new_tab" ] }, { "type": "string", "enum": [ "last_tabs" ] }, { "type": "string", "enum": [ "urls" ] }, { "type": "string", "enum": [ "last_and_urls" ] } ] }, "urls": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 20 } }, "additionalProperties": false }, "launch_args": { "type": "object", "properties": { "chromium": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 }, "firefox": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "maxItems": 100 } }, "additionalProperties": false }, "extension_sets": { "type": "object", "properties": { "chromium": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] }, "firefox": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 100 }, { "type": "null" } ] } }, "additionalProperties": false }, "bookmarks": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "folder" ], "properties": { "title": { "type": "string", "maxLength": 512 }, "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "folder": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] } }, "additionalProperties": false }, "maxItems": 1000 } }, "additionalProperties": false }, "id": { "type": "string" }, "name": { "type": "string" }, "remark": { "type": [ "null", "string" ] }, "color": { "type": [ "null", "string" ] }, "sort_order": { "type": "integer" }, "is_default": { "type": "boolean" }, "pinned": { "type": "boolean" }, "compat_group_id": { "type": [ "null", "string" ] }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "row_version": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Gruppe löschen; Profile werden verschoben oder in den Papierkorb gelegt, nie endgültig gelöscht", "tags": [ "Gruppen" ], "parameters": [ { "schema": { "anyOf": [ { "type": "string", "enum": [ "move_to_default" ] }, { "type": "string", "enum": [ "move_to_group" ] }, { "type": "string", "enum": [ "trash_profiles" ] } ] }, "in": "query", "name": "mode", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "target_group_id", "required": false }, { "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": [ "moved", "trashed" ], "properties": { "moved": { "type": "integer" }, "trashed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tags": { "get": { "summary": "Tags mit Profilanzahl", "tags": [ "Tags" ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "color", "profile_count", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_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": { "summary": "Tag anlegen", "tags": [ "Tags" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "color": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "darkBlue" ] }, { "type": "string", "enum": [ "blue" ] }, { "type": "string", "enum": [ "purple" ] }, { "type": "string", "enum": [ "red" ] }, { "type": "string", "enum": [ "yellow" ] }, { "type": "string", "enum": [ "orange" ] }, { "type": "string", "enum": [ "green" ] }, { "type": "string", "enum": [ "lightGreen" ] } ] }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "color", "profile_count", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/tags/{id}": { "patch": { "summary": "Tag ändern", "tags": [ "Tags" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "color": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "darkBlue" ] }, { "type": "string", "enum": [ "blue" ] }, { "type": "string", "enum": [ "purple" ] }, { "type": "string", "enum": [ "red" ] }, { "type": "string", "enum": [ "yellow" ] }, { "type": "string", "enum": [ "orange" ] }, { "type": "string", "enum": [ "green" ] }, { "type": "string", "enum": [ "lightGreen" ] } ] }, { "type": "null" } ] } }, "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": [ "id", "name", "color", "profile_count", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Tag löschen; Zuordnungen werden entfernt", "tags": [ "Tags" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:write" ], "responses": { "204": { "description": "No content." }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/statuses": { "get": { "summary": "Frei definierbare Status", "tags": [ "Status" ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "color", "sort_order", "is_system", "profile_count", "created_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "sort_order": { "type": "integer" }, "is_system": { "type": "boolean" }, "profile_count": { "type": "integer" }, "created_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": { "summary": "Status anlegen", "tags": [ "Status" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "color" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 }, "sort_order": { "type": "integer" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "color", "sort_order", "is_system", "profile_count", "created_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "sort_order": { "type": "integer" }, "is_system": { "type": "boolean" }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/statuses/{id}": { "patch": { "summary": "Status ändern", "tags": [ "Status" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 50 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 }, "sort_order": { "type": "integer" } }, "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": [ "id", "name", "color", "sort_order", "is_system", "profile_count", "created_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "color": { "type": "string" }, "sort_order": { "type": "integer" }, "is_system": { "type": "boolean" }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Status löschen", "tags": [ "Status" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:write" ], "responses": { "204": { "description": "No content." }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/groups/{id}/accounts": { "get": { "summary": "Gemeinsame Konten einer Gruppe ohne Geheimnisse", "tags": [ "Gruppenkonten" ], "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": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "group_id", "name", "platform_url", "username", "password_set", "totp_set", "notes", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "group_id": { "type": "string" }, "name": { "type": "string" }, "platform_url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "password_set": { "type": "boolean" }, "totp_set": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "number" }, "updated_at": { "type": "number" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Gemeinsames Gruppenkonto anlegen", "tags": [ "Gruppenkonten" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "platform_url" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "platform_url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "username": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "password": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] }, "totp_secret": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:write" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "group_id", "name", "platform_url", "username", "password_set", "totp_set", "notes", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "group_id": { "type": "string" }, "name": { "type": "string" }, "platform_url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "password_set": { "type": "boolean" }, "totp_set": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "number" }, "updated_at": { "type": "number" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/groups/{id}/accounts/{accountId}": { "patch": { "summary": "Gemeinsames Gruppenkonto ändern", "tags": [ "Gruppenkonten" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "platform_url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "username": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "password": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] }, "totp_secret": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "accountId", "required": true } ], "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "group_id", "name", "platform_url", "username", "password_set", "totp_set", "notes", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "group_id": { "type": "string" }, "name": { "type": "string" }, "platform_url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "password_set": { "type": "boolean" }, "totp_set": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "number" }, "updated_at": { "type": "number" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Gemeinsames Gruppenkonto und seine Geheimnisse entfernen", "tags": [ "Gruppenkonten" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "accountId", "required": true } ], "x-required-scopes": [ "profiles:write" ], "responses": { "204": { "description": "No content." }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/groups/{id}/accounts/{accountId}/password": { "get": { "summary": "Gruppenkonto-Passwort protokolliert abrufen", "tags": [ "Gruppenkonten" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "accountId", "required": true } ], "x-required-scopes": [ "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/groups/{id}/accounts/{accountId}/totp": { "get": { "summary": "2FA-Code eines Gruppenkontos abrufen", "tags": [ "Gruppenkonten" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "accountId", "required": true } ], "x-required-scopes": [ "secrets:totp" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "remaining_s" ], "properties": { "code": { "type": "string" }, "remaining_s": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/groups/{id}/accounts/import": { "post": { "summary": "Gruppenkonten importieren; bestehende Namen mit identischer Adresse und Benutzer bleiben erhalten", "tags": [ "Gruppenkonten" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "name", "platform_url" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "platform_url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "username": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "password": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] }, "totp_secret": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] } }, "additionalProperties": false }, "maxItems": 500 } }, "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": [ "created", "skipped" ], "properties": { "created": { "type": "integer" }, "skipped": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/groups/{id}/accounts/export": { "post": { "summary": "Gruppenkonten einschließlich Passwörtern und TOTP-Schlüsseln exportieren", "tags": [ "Gruppenkonten" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:read", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "format", "version", "items" ], "properties": { "format": { "type": "string", "enum": [ "adbr-group-accounts" ] }, "version": { "type": "number", "enum": [ 1 ] }, "items": { "type": "array", "items": { "type": "object", "required": [ "name", "platform_url" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "platform_url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "username": { "anyOf": [ { "type": "string", "maxLength": 256 }, { "type": "null" } ] }, "password": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] }, "totp_secret": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] }, "notes": { "anyOf": [ { "type": "string", "maxLength": 1024 }, { "type": "null" } ] } }, "additionalProperties": false } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/group-accounts": { "get": { "summary": "Für ein Profil freigegebene Gruppenkonten", "tags": [ "Gruppenkonten" ], "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": [ "group_id", "items" ], "properties": { "group_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "group_id", "name", "platform_url", "username", "password_set", "totp_set", "notes", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "group_id": { "type": "string" }, "name": { "type": "string" }, "platform_url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "password_set": { "type": "boolean" }, "totp_set": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "number" }, "updated_at": { "type": "number" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/group-accounts/{accountId}/password": { "get": { "summary": "Passwort eines aktuell freigegebenen Gruppenkontos abrufen", "tags": [ "Gruppenkonten" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "accountId", "required": true } ], "x-required-scopes": [ "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/group-accounts/{accountId}/totp": { "get": { "summary": "2FA-Code eines aktuell freigegebenen Gruppenkontos abrufen", "tags": [ "Gruppenkonten" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "accountId", "required": true } ], "x-required-scopes": [ "secrets:totp" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "code", "remaining_s" ], "properties": { "code": { "type": "string" }, "remaining_s": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/browser-accounts/tabs": { "get": { "summary": "Geöffnete HTTP-/HTTPS-Tabs für Gruppenkonten", "tags": [ "Gruppenkonten" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:read", "runtime:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "origin" ], "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "origin": { "type": "string" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/browser-accounts/tabs/{target}/frames": { "get": { "summary": "HTTP-/HTTPS-Dokumente des ausgewählten Tabs", "tags": [ "Gruppenkonten" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "in": "path", "name": "target", "required": true } ], "x-required-scopes": [ "profiles:read", "runtime:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "top_origin", "items" ], "properties": { "top_origin": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "id", "parent_id", "origin", "depth" ], "properties": { "id": { "type": "string" }, "parent_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "origin": { "type": "string" }, "depth": { "type": "number" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/browser-accounts/inspect": { "post": { "summary": "Anmeldefelder ohne Werte erfassen; Auswahl zwei Minuten gültig", "tags": [ "Gruppenkonten" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "target_id", "origin" ], "properties": { "target_id": { "type": "string", "minLength": 1, "maxLength": 200 }, "origin": { "type": "string", "maxLength": 2048 }, "frame_id": { "type": "string", "minLength": 1, "maxLength": 200 }, "top_origin": { "type": "string", "maxLength": 2048 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:read", "runtime:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ticket", "origin", "top_origin", "frame_id", "group_id", "expires_at", "fields" ], "properties": { "ticket": { "type": "string" }, "origin": { "type": "string" }, "top_origin": { "type": "string" }, "frame_id": { "type": "string" }, "group_id": { "type": "string" }, "expires_at": { "type": "number" }, "fields": { "type": "array", "items": { "type": "object", "required": [ "id", "label", "type", "autocomplete" ], "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string" }, "autocomplete": { "type": "string" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/browser-accounts/{ticket}": { "delete": { "summary": "Temporäre Feldauswahl schließen", "tags": [ "Gruppenkonten" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "ticket", "required": true } ], "x-required-scopes": [ "profiles:read", "runtime:control" ], "responses": { "204": { "description": "No content." }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/browser-accounts/fill": { "post": { "summary": "Ausgewählte Anmeldefelder mit einem passenden Gruppenkonto ausfüllen", "tags": [ "Gruppenkonten" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ticket", "username_field", "password_field", "account_id" ], "properties": { "ticket": { "type": "string", "format": "uuid" }, "username_field": { "anyOf": [ { "type": "string", "maxLength": 10 }, { "type": "null" } ] }, "password_field": { "type": "string", "minLength": 1, "maxLength": 10 }, "account_id": { "type": "string" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:read", "runtime:control", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "filled" ], "properties": { "filled": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/browser-accounts/capture": { "post": { "summary": "Ausgewählte Anmeldefelder ausdrücklich im Gruppentresor speichern", "tags": [ "Gruppenkonten" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ticket", "username_field", "password_field", "name" ], "properties": { "ticket": { "type": "string", "format": "uuid" }, "username_field": { "anyOf": [ { "type": "string", "maxLength": 10 }, { "type": "null" } ] }, "password_field": { "type": "string", "minLength": 1, "maxLength": 10 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "account_id": { "type": "string" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:read", "profiles:write", "runtime:control", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "group_id", "name", "platform_url", "username", "password_set", "totp_set", "notes", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "group_id": { "type": "string" }, "name": { "type": "string" }, "platform_url": { "type": "string" }, "username": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "password_set": { "type": "boolean" }, "totp_set": { "type": "boolean" }, "notes": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "number" }, "updated_at": { "type": "number" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/groups/{id}/browser-vault": { "get": { "summary": "Lokale Freigabe der Browser-Tresorerweiterung", "tags": [ "Gruppenkonten" ], "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": [ "enabled" ], "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Browser-Tresorerweiterung für diese Gruppe auf diesem Gerät freigeben", "tags": [ "Gruppenkonten" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean" } }, "additionalProperties": false } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/batch/delete": { "post": { "summary": "Mehrere Profile in den Papierkorb legen; Ergebnis je Profil", "tags": [ "Papierkorb" ], "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 }, "permanent": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:delete" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/trash": { "get": { "summary": "Profile im Papierkorb mit Löschzeitpunkt, Ablauf und Restzeit", "tags": [ "Papierkorb" ], "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "cursor", "required": false }, { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "string", "maxLength": 20 }, "in": "query", "name": "delete_source", "required": false } ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "total", "total_size_bytes", "retention_days", "next_cursor" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "no", "name", "folder_key", "engine", "origin_group", "tags", "deleted_at", "deleted_by", "delete_source", "purge_after", "purge_hold", "size_bytes", "state", "remaining_ms", "proxy_in_trash", "purge_error" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "name": { "type": "string" }, "folder_key": { "type": "string" }, "engine": { "type": "string" }, "origin_group": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] } } }, "tags": { "type": "array", "items": { "type": "string" } }, "deleted_at": { "type": "integer" }, "deleted_by": { "type": [ "null", "string" ] }, "delete_source": { "type": [ "null", "string" ] }, "purge_after": { "type": [ "null", "integer" ] }, "purge_hold": { "type": "boolean" }, "size_bytes": { "type": [ "null", "integer" ] }, "state": { "type": "string" }, "remaining_ms": { "type": [ "null", "integer" ] }, "proxy_in_trash": { "type": "boolean" }, "purge_error": { "type": [ "null", "string" ] } } } }, "total": { "type": "integer" }, "total_size_bytes": { "type": "integer" }, "retention_days": { "type": "integer" }, "next_cursor": { "type": [ "null", "string" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/trash/restore": { "post": { "summary": "Profile wiederherstellen (Ursprungsgruppe, Namenskonflikt mit Zusatz)", "tags": [ "Papierkorb" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "profile_ids" ], "properties": { "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "restore_proxies": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "trash:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/trash/backup-coverage": { "post": { "summary": "Profilinhalt vorhandener Datenbanksicherungen und entschlüsselbarer Vollbackups im Zielordner prüfen; unprüfbare Dateien separat zählen", "tags": [ "Papierkorb" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "profile_ids" ], "properties": { "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "db_backups", "full_backups", "unchecked", "profiles", "oldest_at" ], "properties": { "db_backups": { "type": "integer" }, "full_backups": { "type": "integer" }, "unchecked": { "type": "integer" }, "profiles": { "type": "array", "items": { "type": "object", "required": [ "id", "db_backups", "full_backups" ], "properties": { "id": { "type": "string" }, "db_backups": { "type": "integer" }, "full_backups": { "type": "integer" } } } }, "oldest_at": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/trash/purge": { "post": { "summary": "Ausgewählte Profile endgültig löschen", "tags": [ "Papierkorb" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "profile_ids" ], "properties": { "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "trash:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/trash/{id}": { "delete": { "summary": "Einen Eintrag endgültig löschen", "tags": [ "Papierkorb" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "trash:manage" ], "responses": { "204": { "description": "No content." }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "summary": "Endlöschung aussetzen oder fortsetzen", "tags": [ "Papierkorb" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "purge_hold" ], "properties": { "purge_hold": { "type": "boolean" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "trash:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "no", "name", "folder_key", "engine", "origin_group", "tags", "deleted_at", "deleted_by", "delete_source", "purge_after", "purge_hold", "size_bytes", "state", "remaining_ms", "proxy_in_trash", "purge_error" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "name": { "type": "string" }, "folder_key": { "type": "string" }, "engine": { "type": "string" }, "origin_group": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] } } }, "tags": { "type": "array", "items": { "type": "string" } }, "deleted_at": { "type": "integer" }, "deleted_by": { "type": [ "null", "string" ] }, "delete_source": { "type": [ "null", "string" ] }, "purge_after": { "type": [ "null", "integer" ] }, "purge_hold": { "type": "boolean" }, "size_bytes": { "type": [ "null", "integer" ] }, "state": { "type": "string" }, "remaining_ms": { "type": [ "null", "integer" ] }, "proxy_in_trash": { "type": "boolean" }, "purge_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" } } } } } } }, "/api/v1/trash/empty": { "post": { "summary": "Papierkorb leeren; confirm_count muss der tatsächlichen Anzahl entsprechen", "tags": [ "Papierkorb" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "confirm_count" ], "properties": { "confirm_count": { "type": "integer", "minimum": 0 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "trash:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/trash/resume-purge": { "post": { "summary": "Nach Prüfung der Systemzeit die angehaltene Endlöschung fortsetzen", "tags": [ "Papierkorb" ], "x-required-scopes": [ "trash:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "retention_days", "purge_interval_hours", "purge_paused", "purge_paused_due", "next_purge_run_at" ], "properties": { "retention_days": { "type": "integer" }, "purge_interval_hours": { "type": "integer" }, "purge_paused": { "type": "boolean" }, "purge_paused_due": { "type": "integer" }, "next_purge_run_at": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/settings/trash": { "get": { "summary": "Einstellungen des Papierkorbs", "tags": [ "Papierkorb" ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "retention_days", "purge_interval_hours", "purge_paused", "purge_paused_due", "next_purge_run_at" ], "properties": { "retention_days": { "type": "integer" }, "purge_interval_hours": { "type": "integer" }, "purge_paused": { "type": "boolean" }, "purge_paused_due": { "type": "integer" }, "next_purge_run_at": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Aufbewahrungsfrist ändern (0–365 Tage); wirkt rückwirkend auf alle Einträge", "tags": [ "Papierkorb" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "retention_days" ], "properties": { "retention_days": { "type": "integer", "minimum": 0, "maximum": 365 }, "confirm_shorten": { "type": "boolean" }, "confirm_immediate": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "settings:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "retention_days", "affected", "purge_not_before" ], "properties": { "retention_days": { "type": "integer" }, "affected": { "type": "integer" }, "purge_not_before": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxy-groups": { "get": { "summary": "Proxygruppen einschließlich Default auflisten", "tags": [ "Proxys" ], "x-required-scopes": [ "proxies:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "proxy_count", "created_at", "updated_at", "is_default" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "proxy_count": { "type": "integer" }, "created_at": { "type": [ "null", "integer" ] }, "updated_at": { "type": [ "null", "integer" ] }, "is_default": { "type": "boolean" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Proxygruppe anlegen", "tags": [ "Proxys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "proxies:write" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "proxy_count", "created_at", "updated_at", "is_default" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "proxy_count": { "type": "integer" }, "created_at": { "type": [ "null", "integer" ] }, "updated_at": { "type": [ "null", "integer" ] }, "is_default": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxy-groups/{id}": { "patch": { "summary": "Proxygruppe umbenennen", "tags": [ "Proxys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "proxies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "proxy_count", "created_at", "updated_at", "is_default" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "proxy_count": { "type": "integer" }, "created_at": { "type": [ "null", "integer" ] }, "updated_at": { "type": [ "null", "integer" ] }, "is_default": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Proxygruppe löschen und enthaltene Proxys nach Default verschieben", "tags": [ "Proxys" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "proxies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "moved" ], "properties": { "moved": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/batch/group": { "post": { "summary": "Ausgewählte Proxys einer Gruppe zuordnen", "tags": [ "Proxys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "group_id" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "group_id": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 64 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "proxies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/sticky": { "post": { "summary": "Proxys aus einer Benutzervorlage mit je einer eigenen dauerhaft gespeicherten Session erstellen; Platzhalter {session}, {country}, {index}", "tags": [ "Proxys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "proxy", "username_template", "count" ], "properties": { "proxy": { "type": "object", "required": [ "protocol", "host", "port" ], "properties": { "group_id": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 64 }, "ssh_private_key": { "type": [ "string", "null" ], "maxLength": 65536 }, "ssh_key_passphrase": { "type": [ "string", "null" ], "maxLength": 1024 }, "name": { "type": [ "string", "null" ], "maxLength": 100 }, "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 }, "change_ip_url": { "type": [ "string", "null" ], "maxLength": 2048 }, "change_ip_cooldown_s": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 86400 }, "provider": { "type": [ "string", "null" ], "maxLength": 32 }, "provider_params": { "type": "object", "additionalProperties": { "type": "string" } }, "ip_checker": { "type": [ "string", "null" ], "maxLength": 32 }, "remark": { "type": [ "string", "null" ], "maxLength": 1000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50 }, "maxItems": 30 } }, "additionalProperties": false }, "username_template": { "type": "string", "minLength": 1, "maxLength": 512 }, "count": { "type": "integer", "minimum": 1, "maximum": 500 }, "country": { "type": "string", "maxLength": 2 }, "session_prefix": { "type": "string", "maxLength": 24 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "proxies:write" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "group_id", "ssh_key_set", "id", "compat_proxy_id", "name", "protocol", "host", "port", "username", "password_set", "change_ip_url", "change_ip_cooldown_s", "provider", "provider_params", "ip_checker", "remark", "tags", "last_check", "last_check_at", "profile_count", "created_at", "updated_at", "row_version", "deleted_at", "purge_after" ], "properties": { "group_id": { "type": [ "null", "string" ] }, "ssh_key_set": { "type": "boolean" }, "id": { "type": "string" }, "compat_proxy_id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "protocol": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "null", "string" ] }, "password_set": { "type": "boolean" }, "change_ip_url": { "type": [ "null", "string" ] }, "change_ip_cooldown_s": { "type": [ "null", "integer" ] }, "provider": { "type": [ "null", "string" ] }, "provider_params": { "type": "object", "additionalProperties": { "type": "string" } }, "ip_checker": { "type": [ "null", "string" ] }, "remark": { "type": [ "null", "string" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "last_check": { "anyOf": [ { "type": "object", "required": [ "ok", "checked_at", "error_class", "error_code", "protocol_detected", "ipv4", "ipv6", "country", "region", "city", "postal_code", "latitude", "longitude", "accuracy_km", "timezone", "utc_offset", "languages", "asn", "as_org", "latency_ms", "geo_source", "duplicate_profiles" ], "properties": { "ok": { "type": "boolean" }, "checked_at": { "type": "integer" }, "error_class": { "type": [ "null", "string" ] }, "error_code": { "type": [ "null", "string" ] }, "protocol_detected": { "type": [ "null", "string" ] }, "ipv4": { "type": [ "null", "string" ] }, "ipv6": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postal_code": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ] }, "longitude": { "type": [ "null", "number" ] }, "accuracy_km": { "type": [ "null", "number" ] }, "timezone": { "type": [ "null", "string" ] }, "utc_offset": { "type": [ "null", "string" ] }, "languages": { "type": "array", "items": { "type": "string" } }, "asn": { "type": [ "null", "integer" ] }, "as_org": { "type": [ "null", "string" ] }, "latency_ms": { "type": "object", "required": [ "tcp", "handshake", "first_byte" ], "properties": { "tcp": { "type": [ "null", "number" ] }, "handshake": { "type": [ "null", "number" ] }, "first_byte": { "type": [ "null", "number" ] } } }, "geo_source": { "type": [ "null", "string" ] }, "duplicate_profiles": { "type": "integer" } } }, { "type": "null" } ] }, "last_check_at": { "type": [ "null", "integer" ] }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "row_version": { "type": "integer" }, "deleted_at": { "type": [ "null", "integer" ] }, "purge_after": { "type": [ "null", "integer" ] } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies": { "get": { "summary": "Proxys auflisten (Passwörter maskiert)", "tags": [ "Proxys" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "query", "name": "group_id", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "unverified" ] }, { "type": "string", "enum": [ "passed" ] }, { "type": "string", "enum": [ "failed" ] } ] }, "in": "query", "name": "check_status", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "dsn" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "created_at" ] }, { "type": "string", "enum": [ "last_check_at" ] }, { "type": "string", "enum": [ "profile_count" ] } ] }, "in": "query", "name": "sort", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "asc" ] }, { "type": "string", "enum": [ "desc" ] } ] }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "search", "required": false }, { "schema": { "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" ] } ] }, "in": "query", "name": "protocol", "required": false }, { "schema": { "type": "string", "maxLength": 50 }, "in": "query", "name": "tag", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "unused", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "trash", "required": false }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "page", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false } ], "x-required-scopes": [ "proxies:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "total", "page", "limit" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "group_id", "ssh_key_set", "id", "compat_proxy_id", "name", "protocol", "host", "port", "username", "password_set", "change_ip_url", "change_ip_cooldown_s", "provider", "provider_params", "ip_checker", "remark", "tags", "last_check", "last_check_at", "profile_count", "created_at", "updated_at", "row_version", "deleted_at", "purge_after" ], "properties": { "group_id": { "type": [ "null", "string" ] }, "ssh_key_set": { "type": "boolean" }, "id": { "type": "string" }, "compat_proxy_id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "protocol": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "null", "string" ] }, "password_set": { "type": "boolean" }, "change_ip_url": { "type": [ "null", "string" ] }, "change_ip_cooldown_s": { "type": [ "null", "integer" ] }, "provider": { "type": [ "null", "string" ] }, "provider_params": { "type": "object", "additionalProperties": { "type": "string" } }, "ip_checker": { "type": [ "null", "string" ] }, "remark": { "type": [ "null", "string" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "last_check": { "anyOf": [ { "type": "object", "required": [ "ok", "checked_at", "error_class", "error_code", "protocol_detected", "ipv4", "ipv6", "country", "region", "city", "postal_code", "latitude", "longitude", "accuracy_km", "timezone", "utc_offset", "languages", "asn", "as_org", "latency_ms", "geo_source", "duplicate_profiles" ], "properties": { "ok": { "type": "boolean" }, "checked_at": { "type": "integer" }, "error_class": { "type": [ "null", "string" ] }, "error_code": { "type": [ "null", "string" ] }, "protocol_detected": { "type": [ "null", "string" ] }, "ipv4": { "type": [ "null", "string" ] }, "ipv6": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postal_code": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ] }, "longitude": { "type": [ "null", "number" ] }, "accuracy_km": { "type": [ "null", "number" ] }, "timezone": { "type": [ "null", "string" ] }, "utc_offset": { "type": [ "null", "string" ] }, "languages": { "type": "array", "items": { "type": "string" } }, "asn": { "type": [ "null", "integer" ] }, "as_org": { "type": [ "null", "string" ] }, "latency_ms": { "type": "object", "required": [ "tcp", "handshake", "first_byte" ], "properties": { "tcp": { "type": [ "null", "number" ] }, "handshake": { "type": [ "null", "number" ] }, "first_byte": { "type": [ "null", "number" ] } } }, "geo_source": { "type": [ "null", "string" ] }, "duplicate_profiles": { "type": "integer" } } }, { "type": "null" } ] }, "last_check_at": { "type": [ "null", "integer" ] }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "row_version": { "type": "integer" }, "deleted_at": { "type": [ "null", "integer" ] }, "purge_after": { "type": [ "null", "integer" ] } } } }, "total": { "type": "integer" }, "page": { "type": "integer" }, "limit": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Proxy anlegen", "tags": [ "Proxys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "protocol", "host", "port" ], "properties": { "group_id": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 64 }, "ssh_private_key": { "type": [ "string", "null" ], "maxLength": 65536 }, "ssh_key_passphrase": { "type": [ "string", "null" ], "maxLength": 1024 }, "name": { "type": [ "string", "null" ], "maxLength": 100 }, "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 }, "change_ip_url": { "type": [ "string", "null" ], "maxLength": 2048 }, "change_ip_cooldown_s": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 86400 }, "provider": { "type": [ "string", "null" ], "maxLength": 32 }, "provider_params": { "type": "object", "additionalProperties": { "type": "string" } }, "ip_checker": { "type": [ "string", "null" ], "maxLength": 32 }, "remark": { "type": [ "string", "null" ], "maxLength": 1000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50 }, "maxItems": 30 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "proxies:write" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "group_id", "ssh_key_set", "id", "compat_proxy_id", "name", "protocol", "host", "port", "username", "password_set", "change_ip_url", "change_ip_cooldown_s", "provider", "provider_params", "ip_checker", "remark", "tags", "last_check", "last_check_at", "profile_count", "created_at", "updated_at", "row_version", "deleted_at", "purge_after" ], "properties": { "group_id": { "type": [ "null", "string" ] }, "ssh_key_set": { "type": "boolean" }, "id": { "type": "string" }, "compat_proxy_id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "protocol": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "null", "string" ] }, "password_set": { "type": "boolean" }, "change_ip_url": { "type": [ "null", "string" ] }, "change_ip_cooldown_s": { "type": [ "null", "integer" ] }, "provider": { "type": [ "null", "string" ] }, "provider_params": { "type": "object", "additionalProperties": { "type": "string" } }, "ip_checker": { "type": [ "null", "string" ] }, "remark": { "type": [ "null", "string" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "last_check": { "anyOf": [ { "type": "object", "required": [ "ok", "checked_at", "error_class", "error_code", "protocol_detected", "ipv4", "ipv6", "country", "region", "city", "postal_code", "latitude", "longitude", "accuracy_km", "timezone", "utc_offset", "languages", "asn", "as_org", "latency_ms", "geo_source", "duplicate_profiles" ], "properties": { "ok": { "type": "boolean" }, "checked_at": { "type": "integer" }, "error_class": { "type": [ "null", "string" ] }, "error_code": { "type": [ "null", "string" ] }, "protocol_detected": { "type": [ "null", "string" ] }, "ipv4": { "type": [ "null", "string" ] }, "ipv6": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postal_code": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ] }, "longitude": { "type": [ "null", "number" ] }, "accuracy_km": { "type": [ "null", "number" ] }, "timezone": { "type": [ "null", "string" ] }, "utc_offset": { "type": [ "null", "string" ] }, "languages": { "type": "array", "items": { "type": "string" } }, "asn": { "type": [ "null", "integer" ] }, "as_org": { "type": [ "null", "string" ] }, "latency_ms": { "type": "object", "required": [ "tcp", "handshake", "first_byte" ], "properties": { "tcp": { "type": [ "null", "number" ] }, "handshake": { "type": [ "null", "number" ] }, "first_byte": { "type": [ "null", "number" ] } } }, "geo_source": { "type": [ "null", "string" ] }, "duplicate_profiles": { "type": "integer" } } }, { "type": "null" } ] }, "last_check_at": { "type": [ "null", "integer" ] }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "row_version": { "type": "integer" }, "deleted_at": { "type": [ "null", "integer" ] }, "purge_after": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/parse": { "post": { "summary": "Proxy-Zeilen erkennen und als Vorschau zurückgeben (ohne Speichern, ohne Passwörter)", "tags": [ "Proxys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "maxLength": 5000000 }, "default_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" ] } ] }, "columns": { "type": "array", "items": { "type": "string", "maxLength": 40 }, "maxItems": 20 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "proxies:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "lines" ], "properties": { "lines": { "type": "array", "items": { "type": "object", "required": [ "line", "status", "error", "warnings", "duplicate_of", "proxy", "alternatives" ], "properties": { "line": { "type": "integer" }, "status": { "type": "string" }, "error": { "type": [ "null", "string" ] }, "warnings": { "type": "array", "items": { "type": "string" } }, "duplicate_of": { "type": [ "null", "string" ] }, "proxy": { "anyOf": [ { "type": "object", "required": [ "protocol", "protocol_source", "host", "port", "username", "password_present", "name", "remark", "change_ip_url", "provider", "provider_params", "pattern" ], "properties": { "protocol": { "type": "string" }, "protocol_source": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "null", "string" ] }, "password_present": { "type": "boolean" }, "name": { "type": [ "null", "string" ] }, "remark": { "type": [ "null", "string" ] }, "change_ip_url": { "type": [ "null", "string" ] }, "provider": { "type": [ "null", "string" ] }, "provider_params": { "type": "object", "additionalProperties": { "type": "string" } }, "pattern": { "type": "string" } } }, { "type": "null" } ] }, "alternatives": { "type": "array", "items": { "type": "object", "required": [ "protocol", "protocol_source", "host", "port", "username", "password_present", "name", "remark", "change_ip_url", "provider", "provider_params", "pattern" ], "properties": { "protocol": { "type": "string" }, "protocol_source": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "null", "string" ] }, "password_present": { "type": "boolean" }, "name": { "type": [ "null", "string" ] }, "remark": { "type": [ "null", "string" ] }, "change_ip_url": { "type": [ "null", "string" ] }, "provider": { "type": [ "null", "string" ] }, "provider_params": { "type": "object", "additionalProperties": { "type": "string" } }, "pattern": { "type": "string" } } } } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/import": { "post": { "summary": "Proxy-Zeilen importieren; Ergebnis je Zeile, nichts wird still verworfen", "tags": [ "Proxys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "maxLength": 5000000 }, "default_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" ] } ] }, "columns": { "type": "array", "items": { "type": "string", "maxLength": 40 }, "maxItems": 20 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50 }, "maxItems": 30 }, "group_id": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 64 }, "ip_checker": { "type": [ "string", "null" ], "maxLength": 32 }, "skip_duplicates": { "type": "boolean" }, "accept_ambiguous": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "proxies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "lines", "created", "duplicates", "ambiguous", "invalid" ], "properties": { "lines": { "type": "array", "items": { "type": "object", "required": [ "line", "status", "id", "existing_id", "error", "warnings" ], "properties": { "line": { "type": "integer" }, "status": { "type": "string" }, "id": { "type": [ "null", "string" ] }, "existing_id": { "type": [ "null", "string" ] }, "error": { "type": [ "null", "string" ] }, "warnings": { "type": "array", "items": { "type": "string" } } } } }, "created": { "type": "integer" }, "duplicates": { "type": "integer" }, "ambiguous": { "type": "integer" }, "invalid": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/batch/delete": { "post": { "summary": "Proxys in den Papierkorb legen; zugeordnete Profile behalten die Zuordnung oder erhalten einen Ersatz", "tags": [ "Proxys" ], "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 }, "reassign_to": { "type": "string" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "proxies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/restore": { "post": { "summary": "Proxys aus dem Papierkorb wiederherstellen", "tags": [ "Proxys" ], "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 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "proxies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/purge": { "post": { "summary": "Proxys aus dem Papierkorb sofort endgültig löschen (nur ohne zugeordnete Profile, auch keine im Papierkorb)", "tags": [ "Proxys" ], "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 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "trash:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/{id}": { "get": { "summary": "Proxy abrufen", "tags": [ "Proxys" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "proxies:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "group_id", "ssh_key_set", "id", "compat_proxy_id", "name", "protocol", "host", "port", "username", "password_set", "change_ip_url", "change_ip_cooldown_s", "provider", "provider_params", "ip_checker", "remark", "tags", "last_check", "last_check_at", "profile_count", "created_at", "updated_at", "row_version", "deleted_at", "purge_after" ], "properties": { "group_id": { "type": [ "null", "string" ] }, "ssh_key_set": { "type": "boolean" }, "id": { "type": "string" }, "compat_proxy_id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "protocol": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "null", "string" ] }, "password_set": { "type": "boolean" }, "change_ip_url": { "type": [ "null", "string" ] }, "change_ip_cooldown_s": { "type": [ "null", "integer" ] }, "provider": { "type": [ "null", "string" ] }, "provider_params": { "type": "object", "additionalProperties": { "type": "string" } }, "ip_checker": { "type": [ "null", "string" ] }, "remark": { "type": [ "null", "string" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "last_check": { "anyOf": [ { "type": "object", "required": [ "ok", "checked_at", "error_class", "error_code", "protocol_detected", "ipv4", "ipv6", "country", "region", "city", "postal_code", "latitude", "longitude", "accuracy_km", "timezone", "utc_offset", "languages", "asn", "as_org", "latency_ms", "geo_source", "duplicate_profiles" ], "properties": { "ok": { "type": "boolean" }, "checked_at": { "type": "integer" }, "error_class": { "type": [ "null", "string" ] }, "error_code": { "type": [ "null", "string" ] }, "protocol_detected": { "type": [ "null", "string" ] }, "ipv4": { "type": [ "null", "string" ] }, "ipv6": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postal_code": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ] }, "longitude": { "type": [ "null", "number" ] }, "accuracy_km": { "type": [ "null", "number" ] }, "timezone": { "type": [ "null", "string" ] }, "utc_offset": { "type": [ "null", "string" ] }, "languages": { "type": "array", "items": { "type": "string" } }, "asn": { "type": [ "null", "integer" ] }, "as_org": { "type": [ "null", "string" ] }, "latency_ms": { "type": "object", "required": [ "tcp", "handshake", "first_byte" ], "properties": { "tcp": { "type": [ "null", "number" ] }, "handshake": { "type": [ "null", "number" ] }, "first_byte": { "type": [ "null", "number" ] } } }, "geo_source": { "type": [ "null", "string" ] }, "duplicate_profiles": { "type": "integer" } } }, { "type": "null" } ] }, "last_check_at": { "type": [ "null", "integer" ] }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "row_version": { "type": "integer" }, "deleted_at": { "type": [ "null", "integer" ] }, "purge_after": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "patch": { "summary": "Proxy ändern; password null entfernt das Passwort", "tags": [ "Proxys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "group_id": { "type": [ "string", "null" ], "minLength": 1, "maxLength": 64 }, "ssh_private_key": { "type": [ "string", "null" ], "maxLength": 65536 }, "ssh_key_passphrase": { "type": [ "string", "null" ], "maxLength": 1024 }, "name": { "type": [ "string", "null" ], "maxLength": 100 }, "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 }, "change_ip_url": { "type": [ "string", "null" ], "maxLength": 2048 }, "change_ip_cooldown_s": { "type": [ "integer", "null" ], "minimum": 0, "maximum": 86400 }, "provider": { "type": [ "string", "null" ], "maxLength": 32 }, "provider_params": { "type": "object", "additionalProperties": { "type": "string" } }, "ip_checker": { "type": [ "string", "null" ], "maxLength": 32 }, "remark": { "type": [ "string", "null" ], "maxLength": 1000 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50 }, "maxItems": 30 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "proxies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "group_id", "ssh_key_set", "id", "compat_proxy_id", "name", "protocol", "host", "port", "username", "password_set", "change_ip_url", "change_ip_cooldown_s", "provider", "provider_params", "ip_checker", "remark", "tags", "last_check", "last_check_at", "profile_count", "created_at", "updated_at", "row_version", "deleted_at", "purge_after" ], "properties": { "group_id": { "type": [ "null", "string" ] }, "ssh_key_set": { "type": "boolean" }, "id": { "type": "string" }, "compat_proxy_id": { "type": [ "null", "string" ] }, "name": { "type": [ "null", "string" ] }, "protocol": { "type": "string" }, "host": { "type": "string" }, "port": { "type": "integer" }, "username": { "type": [ "null", "string" ] }, "password_set": { "type": "boolean" }, "change_ip_url": { "type": [ "null", "string" ] }, "change_ip_cooldown_s": { "type": [ "null", "integer" ] }, "provider": { "type": [ "null", "string" ] }, "provider_params": { "type": "object", "additionalProperties": { "type": "string" } }, "ip_checker": { "type": [ "null", "string" ] }, "remark": { "type": [ "null", "string" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "last_check": { "anyOf": [ { "type": "object", "required": [ "ok", "checked_at", "error_class", "error_code", "protocol_detected", "ipv4", "ipv6", "country", "region", "city", "postal_code", "latitude", "longitude", "accuracy_km", "timezone", "utc_offset", "languages", "asn", "as_org", "latency_ms", "geo_source", "duplicate_profiles" ], "properties": { "ok": { "type": "boolean" }, "checked_at": { "type": "integer" }, "error_class": { "type": [ "null", "string" ] }, "error_code": { "type": [ "null", "string" ] }, "protocol_detected": { "type": [ "null", "string" ] }, "ipv4": { "type": [ "null", "string" ] }, "ipv6": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postal_code": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ] }, "longitude": { "type": [ "null", "number" ] }, "accuracy_km": { "type": [ "null", "number" ] }, "timezone": { "type": [ "null", "string" ] }, "utc_offset": { "type": [ "null", "string" ] }, "languages": { "type": "array", "items": { "type": "string" } }, "asn": { "type": [ "null", "integer" ] }, "as_org": { "type": [ "null", "string" ] }, "latency_ms": { "type": "object", "required": [ "tcp", "handshake", "first_byte" ], "properties": { "tcp": { "type": [ "null", "number" ] }, "handshake": { "type": [ "null", "number" ] }, "first_byte": { "type": [ "null", "number" ] } } }, "geo_source": { "type": [ "null", "string" ] }, "duplicate_profiles": { "type": "integer" } } }, { "type": "null" } ] }, "last_check_at": { "type": [ "null", "integer" ] }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" }, "row_version": { "type": "integer" }, "deleted_at": { "type": [ "null", "integer" ] }, "purge_after": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Proxy in den Papierkorb legen", "tags": [ "Proxys" ], "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "reassign_to", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "proxies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/{id}/change-ip": { "post": { "summary": "Change-IP-URL aufrufen; verify=true misst die Ausgangs-IP davor und danach. changed bestätigt den URL-Aufruf, ip_changed den gemessenen Wechsel (null: nicht bestätigt)", "tags": [ "Proxys" ], "parameters": [ { "schema": { "type": "boolean" }, "in": "query", "name": "verify", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "proxies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "changed", "ip_changed", "before_ip", "after_ip", "http_status", "attempts", "next_allowed_at" ], "properties": { "changed": { "type": "boolean" }, "ip_changed": { "type": [ "null", "boolean" ] }, "before_ip": { "type": [ "null", "string" ] }, "after_ip": { "type": [ "null", "string" ] }, "http_status": { "type": "integer" }, "attempts": { "type": "integer" }, "next_allowed_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/{id}/password": { "get": { "summary": "Proxy-Passwort im Klartext abrufen (wird protokolliert)", "tags": [ "Proxys" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "password" ], "properties": { "password": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/batch/assign-proxy": { "post": { "summary": "Proxys zuweisen: ein Proxy für alle, der Reihe nach oder zufällig, optional nur unbenutzte", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "mode" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "mode": { "anyOf": [ { "type": "string", "enum": [ "one" ] }, { "type": "string", "enum": [ "sequential" ] }, { "type": "string", "enum": [ "random" ] } ] }, "proxy_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 5000 }, "only_unused": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/proxy/test": { "post": { "summary": "Gespeicherte Profilverbindung ohne Browserstart prüfen; Ausgangs-IP und Land bei unveränderter Konfiguration speichern", "tags": [ "Profile" ], "parameters": [ { "schema": { "type": "string", "maxLength": 32 }, "in": "query", "name": "ip_checker", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "detect_protocol", "required": false, "description": "HTTP, HTTPS oder SOCKS5 mit gespeicherten Zugangsdaten erkennen; nur Vorschau, ohne Konfiguration oder Messstand zu ändern." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:write", "proxies:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "checked_at", "error_class", "error_code", "protocol_detected", "ipv4", "ipv6", "country", "region", "city", "postal_code", "latitude", "longitude", "accuracy_km", "timezone", "utc_offset", "languages", "asn", "as_org", "latency_ms", "geo_source", "duplicate_profiles" ], "properties": { "ok": { "type": "boolean" }, "checked_at": { "type": "integer" }, "error_class": { "type": [ "null", "string" ] }, "error_code": { "type": [ "null", "string" ] }, "protocol_detected": { "type": [ "null", "string" ] }, "ipv4": { "type": [ "null", "string" ] }, "ipv6": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postal_code": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ] }, "longitude": { "type": [ "null", "number" ] }, "accuracy_km": { "type": [ "null", "number" ] }, "timezone": { "type": [ "null", "string" ] }, "utc_offset": { "type": [ "null", "string" ] }, "languages": { "type": "array", "items": { "type": "string" } }, "asn": { "type": [ "null", "integer" ] }, "as_org": { "type": [ "null", "string" ] }, "latency_ms": { "type": "object", "required": [ "tcp", "handshake", "first_byte" ], "properties": { "tcp": { "type": [ "null", "number" ] }, "handshake": { "type": [ "null", "number" ] }, "first_byte": { "type": [ "null", "number" ] } } }, "geo_source": { "type": [ "null", "string" ] }, "duplicate_profiles": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/checkers": { "get": { "summary": "Verfügbare IP-Prüfdienste", "tags": [ "Proxys" ], "x-required-scopes": [ "proxies:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "ipv6" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "ipv6": { "type": "boolean" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/{id}/test": { "post": { "summary": "Proxy prüfen: Erreichbarkeit, Exit-IP v4/v6, Standort, Zeitzone, ASN, Latenz; Ergebnis wird gespeichert", "tags": [ "Proxys" ], "parameters": [ { "schema": { "type": "string", "maxLength": 32 }, "in": "query", "name": "ip_checker", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "apply_protocol", "required": false, "description": "Nur zusammen mit detect_protocol=true: erfolgreich erkanntes HTTP-/HTTPS-/SOCKS5-Protokoll bei unveränderter Proxyversion übernehmen. Prüfergebnis wird dabei nicht gespeichert." }, { "schema": { "type": "boolean" }, "in": "query", "name": "detect_protocol", "required": false, "description": "Gespeicherte Zugangsdaten zur HTTP-/HTTPS-/SOCKS5-Erkennung verwenden, ohne Protokoll oder Prüfergebnis zu speichern." }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "proxies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "checked_at", "error_class", "error_code", "protocol_detected", "ipv4", "ipv6", "country", "region", "city", "postal_code", "latitude", "longitude", "accuracy_km", "timezone", "utc_offset", "languages", "asn", "as_org", "latency_ms", "geo_source", "duplicate_profiles" ], "properties": { "ok": { "type": "boolean" }, "checked_at": { "type": "integer" }, "error_class": { "type": [ "null", "string" ] }, "error_code": { "type": [ "null", "string" ] }, "protocol_detected": { "type": [ "null", "string" ] }, "ipv4": { "type": [ "null", "string" ] }, "ipv6": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postal_code": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ] }, "longitude": { "type": [ "null", "number" ] }, "accuracy_km": { "type": [ "null", "number" ] }, "timezone": { "type": [ "null", "string" ] }, "utc_offset": { "type": [ "null", "string" ] }, "languages": { "type": "array", "items": { "type": "string" } }, "asn": { "type": [ "null", "integer" ] }, "as_org": { "type": [ "null", "string" ] }, "latency_ms": { "type": "object", "required": [ "tcp", "handshake", "first_byte" ], "properties": { "tcp": { "type": [ "null", "number" ] }, "handshake": { "type": [ "null", "number" ] }, "first_byte": { "type": [ "null", "number" ] } } }, "geo_source": { "type": [ "null", "string" ] }, "duplicate_profiles": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/proxies/batch/test": { "post": { "summary": "Mehrere Proxys prüfen (höchstens 5 gleichzeitig)", "tags": [ "Proxys" ], "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 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "proxies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "id", "ok", "check", "error" ], "properties": { "id": { "type": "string" }, "ok": { "type": "boolean" }, "check": { "anyOf": [ { "type": "object", "required": [ "ok", "checked_at", "error_class", "error_code", "protocol_detected", "ipv4", "ipv6", "country", "region", "city", "postal_code", "latitude", "longitude", "accuracy_km", "timezone", "utc_offset", "languages", "asn", "as_org", "latency_ms", "geo_source", "duplicate_profiles" ], "properties": { "ok": { "type": "boolean" }, "checked_at": { "type": "integer" }, "error_class": { "type": [ "null", "string" ] }, "error_code": { "type": [ "null", "string" ] }, "protocol_detected": { "type": [ "null", "string" ] }, "ipv4": { "type": [ "null", "string" ] }, "ipv6": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postal_code": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ] }, "longitude": { "type": [ "null", "number" ] }, "accuracy_km": { "type": [ "null", "number" ] }, "timezone": { "type": [ "null", "string" ] }, "utc_offset": { "type": [ "null", "string" ] }, "languages": { "type": "array", "items": { "type": "string" } }, "asn": { "type": [ "null", "integer" ] }, "as_org": { "type": [ "null", "string" ] }, "latency_ms": { "type": "object", "required": [ "tcp", "handshake", "first_byte" ], "properties": { "tcp": { "type": [ "null", "number" ] }, "handshake": { "type": [ "null", "number" ] }, "first_byte": { "type": [ "null", "number" ] } } }, "geo_source": { "type": [ "null", "string" ] }, "duplicate_profiles": { "type": "integer" } } }, { "type": "null" } ] }, "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" } } } } } } }, "/api/v1/proxies/test": { "post": { "summary": "Proxy-Angaben prüfen, ohne zu speichern; Protokoll optional automatisch erkennen", "tags": [ "Proxys" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "host", "port" ], "properties": { "ssh_private_key": { "type": [ "string", "null" ], "maxLength": 65536 }, "ssh_key_passphrase": { "type": [ "string", "null" ], "maxLength": 1024 }, "ip_checker": { "type": [ "string", "null" ], "maxLength": 32 }, "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" ] } ] }, "detect_protocol": { "type": "boolean", "description": "HTTP, HTTPS oder SOCKS5 durch Handshake erkennen; protocol wird zuerst geprüft. Kein Speichern." }, "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 }, "ssh_host_key": { "type": [ "string", "null" ], "pattern": "^SHA256:[A-Za-z0-9+/]{43}$" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "proxies:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "checked_at", "error_class", "error_code", "protocol_detected", "ipv4", "ipv6", "country", "region", "city", "postal_code", "latitude", "longitude", "accuracy_km", "timezone", "utc_offset", "languages", "asn", "as_org", "latency_ms", "geo_source", "duplicate_profiles" ], "properties": { "ok": { "type": "boolean" }, "checked_at": { "type": "integer" }, "error_class": { "type": [ "null", "string" ] }, "error_code": { "type": [ "null", "string" ] }, "protocol_detected": { "type": [ "null", "string" ] }, "ipv4": { "type": [ "null", "string" ] }, "ipv6": { "type": [ "null", "string" ] }, "country": { "type": [ "null", "string" ] }, "region": { "type": [ "null", "string" ] }, "city": { "type": [ "null", "string" ] }, "postal_code": { "type": [ "null", "string" ] }, "latitude": { "type": [ "null", "number" ] }, "longitude": { "type": [ "null", "number" ] }, "accuracy_km": { "type": [ "null", "number" ] }, "timezone": { "type": [ "null", "string" ] }, "utc_offset": { "type": [ "null", "string" ] }, "languages": { "type": "array", "items": { "type": "string" } }, "asn": { "type": [ "null", "integer" ] }, "as_org": { "type": [ "null", "string" ] }, "latency_ms": { "type": "object", "required": [ "tcp", "handshake", "first_byte" ], "properties": { "tcp": { "type": [ "null", "number" ] }, "handshake": { "type": [ "null", "number" ] }, "first_byte": { "type": [ "null", "number" ] } } }, "geo_source": { "type": [ "null", "string" ] }, "duplicate_profiles": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/geo": { "get": { "summary": "Zustand der lokalen IP-Geo-Datenbank", "tags": [ "Proxys" ], "x-required-scopes": [ "proxies:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "loaded", "database_type", "city", "asn", "attribution", "timezone_table" ], "properties": { "source": { "type": "string" }, "loaded": { "type": "boolean" }, "database_type": { "type": [ "null", "string" ] }, "city": { "type": "object", "required": [ "file", "present", "size_bytes", "modified_at" ], "properties": { "file": { "type": "string" }, "present": { "type": "boolean" }, "size_bytes": { "type": [ "null", "integer" ] }, "modified_at": { "type": [ "null", "integer" ] } } }, "asn": { "type": "object", "required": [ "file", "present", "size_bytes", "modified_at" ], "properties": { "file": { "type": "string" }, "present": { "type": "boolean" }, "size_bytes": { "type": [ "null", "integer" ] }, "modified_at": { "type": [ "null", "integer" ] } } }, "attribution": { "type": "string" }, "timezone_table": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/geo/update": { "post": { "summary": "IP-Geo-Datenbank (DB-IP Lite, CC BY 4.0) herunterladen oder aktualisieren", "tags": [ "Proxys" ], "x-required-scopes": [ "settings:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "loaded", "database_type", "city", "asn", "attribution", "timezone_table" ], "properties": { "source": { "type": "string" }, "loaded": { "type": "boolean" }, "database_type": { "type": [ "null", "string" ] }, "city": { "type": "object", "required": [ "file", "present", "size_bytes", "modified_at" ], "properties": { "file": { "type": "string" }, "present": { "type": "boolean" }, "size_bytes": { "type": [ "null", "integer" ] }, "modified_at": { "type": [ "null", "integer" ] } } }, "asn": { "type": "object", "required": [ "file", "present", "size_bytes", "modified_at" ], "properties": { "file": { "type": "string" }, "present": { "type": "boolean" }, "size_bytes": { "type": [ "null", "integer" ] }, "modified_at": { "type": [ "null", "integer" ] } } }, "attribution": { "type": "string" }, "timezone_table": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/start": { "post": { "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" } } } } } } }, "/api/v1/profiles/{id}/stop": { "post": { "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" } } } } } } }, "/api/v1/profiles/{id}/kill": { "post": { "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" } } } } } } }, "/api/v1/profiles/{id}/runtime": { "get": { "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" } } } } } } }, "/api/v1/runtime": { "get": { "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" } } } } } } }, "/api/v1/runtime/batch/start": { "post": { "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" } } } } } } }, "/api/v1/runtime/batch/stop": { "post": { "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" } } } } } } }, "/api/v1/profiles/{id}/cache/clear": { "post": { "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" } } } } } } }, "/api/v1/kernels": { "get": { "summary": "Installierte Browserkerne", "tags": [ "Kerne" ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "engine", "version", "revision", "build", "major", "path", "source", "fingerprint", "features", "state", "installed_at", "last_used_at" ], "properties": { "id": { "type": "string" }, "engine": { "type": "string" }, "version": { "type": "string" }, "revision": { "type": "string" }, "build": { "type": "string" }, "major": { "type": "integer" }, "path": { "type": "string" }, "source": { "type": "string" }, "fingerprint": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string" }, "installed_at": { "type": [ "null", "integer" ] }, "last_used_at": { "type": [ "null", "integer" ] } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/kernels/candidates": { "get": { "summary": "Gefundene, noch nicht registrierte Browser-Installationen auf diesem Rechner", "tags": [ "Kerne" ], "x-required-scopes": [ "kernels:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "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" } } } } } } }, "/api/v1/kernels/local": { "post": { "summary": "Lokal installierten Browserkern registrieren (Version wird erkannt)", "tags": [ "Kerne" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "engine", "path" ], "properties": { "engine": { "anyOf": [ { "type": "string", "enum": [ "chromium" ] }, { "type": "string", "enum": [ "firefox" ] } ] }, "path": { "type": "string", "minLength": 3, "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "kernels:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "engine", "version", "revision", "build", "major", "path", "source", "fingerprint", "features", "state", "installed_at", "last_used_at" ], "properties": { "id": { "type": "string" }, "engine": { "type": "string" }, "version": { "type": "string" }, "revision": { "type": "string" }, "build": { "type": "string" }, "major": { "type": "integer" }, "path": { "type": "string" }, "source": { "type": "string" }, "fingerprint": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string" }, "installed_at": { "type": [ "null", "integer" ] }, "last_used_at": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/kernels/install": { "post": { "summary": "Kern-Paket (ZIP aus kern-chromium mit build-info.json) in die Datenwurzel installieren; eigene Kerne unterstützen den Fingerprint", "tags": [ "Kerne" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "path" ], "properties": { "path": { "type": "string", "minLength": 3, "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "kernels:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "engine", "version", "revision", "build", "major", "path", "source", "fingerprint", "features", "state", "installed_at", "last_used_at" ], "properties": { "id": { "type": "string" }, "engine": { "type": "string" }, "version": { "type": "string" }, "revision": { "type": "string" }, "build": { "type": "string" }, "major": { "type": "integer" }, "path": { "type": "string" }, "source": { "type": "string" }, "fingerprint": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string" }, "installed_at": { "type": [ "null", "integer" ] }, "last_used_at": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/kernels/{id}": { "delete": { "summary": "Kern entfernen (lokal registrierte Kerne: nur die Registrierung; installierte Kern-Pakete: auch die Dateien)", "tags": [ "Kerne" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "kernels:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "removed" ], "properties": { "id": { "type": "string" }, "removed": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/settings/cache": { "get": { "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": { "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" } } } } } } }, "/api/v1/settings/runtime": { "get": { "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": { "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" } } } } } } }, "/api/v1/settings/compat": { "get": { "summary": "Einstellungen der AdsPower-kompatiblen Schnittstelle", "tags": [ "AdsPower-Kompatibilität" ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled", "port", "require_token", "rate_limit", "legacy_key_set", "webdriver_path", "running", "active_port" ], "properties": { "enabled": { "type": "boolean" }, "port": { "type": "integer", "minimum": 1024, "maximum": 65535 }, "require_token": { "type": "boolean" }, "rate_limit": { "type": "integer", "minimum": 0, "maximum": 100 }, "legacy_key_set": { "type": "boolean" }, "webdriver_path": { "type": [ "null", "string" ] }, "running": { "type": "boolean" }, "active_port": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "AdsPower-kompatible Schnittstelle ein-/ausschalten und konfigurieren; legacy_key übernimmt einen vorhandenen AdsPower-API-Schlüssel (nur als Hash gespeichert)", "tags": [ "AdsPower-Kompatibilität" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "port": { "type": "integer", "minimum": 1024, "maximum": 65535 }, "require_token": { "type": "boolean" }, "rate_limit": { "type": "integer", "minimum": 0, "maximum": 100 }, "legacy_key": { "type": [ "string", "null" ], "minLength": 8, "maxLength": 256 }, "webdriver_path": { "type": [ "string", "null" ], "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "settings:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "enabled", "port", "require_token", "rate_limit", "legacy_key_set", "webdriver_path", "running", "active_port" ], "properties": { "enabled": { "type": "boolean" }, "port": { "type": "integer", "minimum": 1024, "maximum": 65535 }, "require_token": { "type": "boolean" }, "rate_limit": { "type": "integer", "minimum": 0, "maximum": 100 }, "legacy_key_set": { "type": "boolean" }, "webdriver_path": { "type": [ "null", "string" ] }, "running": { "type": "boolean" }, "active_port": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/kernels/updates": { "get": { "summary": "Status und signierte verfügbare Kernel-Updates", "tags": [ "Kerne" ], "x-required-scopes": [ "kernels:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "auto_check", "auto_download", "feed", "checked_at", "expires_at", "error", "busy", "stage", "downloaded", "total", "available" ], "properties": { "auto_check": { "type": "boolean" }, "auto_download": { "type": "boolean" }, "feed": { "type": "string" }, "checked_at": { "type": [ "null", "integer" ] }, "expires_at": { "type": [ "null", "integer" ] }, "error": { "type": [ "null", "string" ] }, "busy": { "type": "boolean" }, "stage": { "type": "string" }, "downloaded": { "type": "number" }, "total": { "type": "number" }, "available": { "type": "array", "items": { "type": "object", "required": [ "engine", "version", "revision", "platform", "arch", "url", "size", "sha256", "build", "installed", "installable" ], "properties": { "engine": { "type": "string" }, "version": { "type": "string" }, "revision": { "type": "string" }, "platform": { "type": "string" }, "arch": { "type": "string" }, "url": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" }, "build": { "type": "string" }, "installed": { "type": "boolean" }, "installable": { "type": "boolean" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/kernels/updates/settings": { "put": { "summary": "Automatische Prüfung auf Kernel-Updates einstellen", "tags": [ "Kerne" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "auto_check": { "type": "boolean" }, "auto_download": { "type": "boolean" } }, "additionalProperties": false, "minProperties": 1 } } } }, "x-required-scopes": [ "kernels:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "auto_check", "auto_download", "feed", "checked_at", "expires_at", "error", "busy", "stage", "downloaded", "total", "available" ], "properties": { "auto_check": { "type": "boolean" }, "auto_download": { "type": "boolean" }, "feed": { "type": "string" }, "checked_at": { "type": [ "null", "integer" ] }, "expires_at": { "type": [ "null", "integer" ] }, "error": { "type": [ "null", "string" ] }, "busy": { "type": "boolean" }, "stage": { "type": "string" }, "downloaded": { "type": "number" }, "total": { "type": "number" }, "available": { "type": "array", "items": { "type": "object", "required": [ "engine", "version", "revision", "platform", "arch", "url", "size", "sha256", "build", "installed", "installable" ], "properties": { "engine": { "type": "string" }, "version": { "type": "string" }, "revision": { "type": "string" }, "platform": { "type": "string" }, "arch": { "type": "string" }, "url": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" }, "build": { "type": "string" }, "installed": { "type": "boolean" }, "installable": { "type": "boolean" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/kernels/updates/check": { "post": { "summary": "Signiertes Kernel-Manifest laden und prüfen", "tags": [ "Kerne" ], "x-required-scopes": [ "kernels:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "auto_check", "auto_download", "feed", "checked_at", "expires_at", "error", "busy", "stage", "downloaded", "total", "available" ], "properties": { "auto_check": { "type": "boolean" }, "auto_download": { "type": "boolean" }, "feed": { "type": "string" }, "checked_at": { "type": [ "null", "integer" ] }, "expires_at": { "type": [ "null", "integer" ] }, "error": { "type": [ "null", "string" ] }, "busy": { "type": "boolean" }, "stage": { "type": "string" }, "downloaded": { "type": "number" }, "total": { "type": "number" }, "available": { "type": "array", "items": { "type": "object", "required": [ "engine", "version", "revision", "platform", "arch", "url", "size", "sha256", "build", "installed", "installable" ], "properties": { "engine": { "type": "string" }, "version": { "type": "string" }, "revision": { "type": "string" }, "platform": { "type": "string" }, "arch": { "type": "string" }, "url": { "type": "string" }, "size": { "type": "number" }, "sha256": { "type": "string" }, "build": { "type": "string" }, "installed": { "type": "boolean" }, "installable": { "type": "boolean" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/kernels/updates/install": { "post": { "summary": "Signierten Kernel herunterladen, prüfen und installieren", "tags": [ "Kerne" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "build" ], "properties": { "build": { "type": "string", "minLength": 7, "maxLength": 80 }, "engine": { "anyOf": [ { "type": "string", "enum": [ "chromium" ] }, { "type": "string", "enum": [ "firefox" ] } ] } }, "additionalProperties": false } } } }, "x-required-scopes": [ "kernels:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "engine", "version", "revision", "build", "major", "path", "source", "fingerprint", "features", "state", "installed_at", "last_used_at" ], "properties": { "id": { "type": "string" }, "engine": { "type": "string" }, "version": { "type": "string" }, "revision": { "type": "string" }, "build": { "type": "string" }, "major": { "type": "integer" }, "path": { "type": "string" }, "source": { "type": "string" }, "fingerprint": { "type": "boolean" }, "features": { "type": "array", "items": { "type": "string" } }, "state": { "type": "string" }, "installed_at": { "type": [ "null", "integer" ] }, "last_used_at": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/cookies": { "get": { "summary": "Cookies eines Profils lesen (laufend über CDP, sonst über eine unsichtbare Wartungssitzung des Kerns)", "tags": [ "Cookies" ], "parameters": [ { "schema": { "anyOf": [ { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] } ] }, "in": "query", "name": "format", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "cookies:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "format", "count", "cookies", "content" ], "properties": { "format": { "type": "string" }, "count": { "type": "integer" }, "cookies": { "type": "array", "items": { "type": "object", "required": [ "name", "value", "domain", "host_only", "path", "expires", "http_only", "secure", "same_site", "session", "partition_key", "priority", "source_scheme", "source_port", "creation", "last_access" ], "properties": { "firefox": { "type": "object", "required": [ "partition_key", "partitioned", "user_context_id" ], "properties": { "partition_key": { "type": "string" }, "partitioned": { "type": "boolean" }, "user_context_id": { "type": "integer" } } }, "name": { "type": "string" }, "value": { "type": "string" }, "domain": { "type": "string" }, "host_only": { "type": "boolean" }, "path": { "type": "string" }, "expires": { "type": [ "null", "number" ] }, "http_only": { "type": "boolean" }, "secure": { "type": "boolean" }, "same_site": { "type": "string" }, "session": { "type": "boolean" }, "partition_key": { "anyOf": [ { "type": "object", "required": [ "top_level_site", "has_cross_site_ancestor" ], "properties": { "top_level_site": { "type": "string" }, "has_cross_site_ancestor": { "type": "boolean" } } }, { "type": "null" } ] }, "priority": { "type": [ "null", "string" ] }, "source_scheme": { "type": [ "null", "string" ] }, "source_port": { "type": [ "null", "integer" ] }, "creation": { "type": [ "null", "number" ] }, "last_access": { "type": [ "null", "number" ] } } } }, "content": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Cookies importieren (JSON, Netscape, Name=Wert, Base64, storageState); Einspielen über den Browser, nie per Datei", "tags": [ "Cookies" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "cookies" ], "properties": { "cookies": { "description": "Cookies als Text (JSON, Netscape, Name=Wert, Base64) oder als JSON-Array" }, "format": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] }, { "type": "string", "enum": [ "storage_state" ] }, { "type": "string", "enum": [ "base64" ] } ] }, "domain": { "type": "string", "minLength": 1, "maxLength": 253 }, "mode": { "anyOf": [ { "type": "string", "enum": [ "merge" ] }, { "type": "string", "enum": [ "replace" ] } ] }, "ignore_errors": { "type": "boolean" }, "skip_expired": { "type": "boolean" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "cookies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "format", "encoding", "received", "imported", "skipped_expired", "errors", "state", "access", "failed", "held_for_start", "pending_reason" ], "properties": { "format": { "type": "string" }, "encoding": { "type": "string" }, "received": { "type": "integer" }, "imported": { "type": "integer" }, "skipped_expired": { "type": "integer" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "index", "name", "code", "message" ], "properties": { "index": { "type": "integer" }, "name": { "type": [ "null", "string" ] }, "code": { "type": "string" }, "message": { "type": "string" } } } }, "state": { "type": "string" }, "access": { "type": [ "null", "string" ] }, "failed": { "type": "array", "items": { "type": "object", "required": [ "name", "domain", "message" ], "properties": { "name": { "type": "string" }, "domain": { "type": "string" }, "message": { "type": "string" } } } }, "held_for_start": { "type": "integer" }, "pending_reason": { "type": [ "null", "string" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Alle Cookies eines Profils löschen, auch noch nicht eingespielte Importe", "tags": [ "Cookies" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "cookies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "cleared", "access" ], "properties": { "cleared": { "type": "boolean" }, "access": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/batch/cookies": { "post": { "summary": "Dieselben Cookies in mehrere Profile importieren: je Profil vorgemerkt und im Hintergrund über den Browser eingespielt (laufende Profile sofort)", "tags": [ "Cookies" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "cookies" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "cookies": { "description": "Cookies als Text (JSON, Netscape, Name=Wert, Base64) oder als JSON-Array" }, "format": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] }, { "type": "string", "enum": [ "storage_state" ] }, { "type": "string", "enum": [ "base64" ] } ] }, "domain": { "type": "string", "minLength": 1, "maxLength": 253 }, "mode": { "anyOf": [ { "type": "string", "enum": [ "merge" ] }, { "type": "string", "enum": [ "replace" ] } ] }, "ignore_errors": { "type": "boolean" }, "skip_expired": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "cookies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "format", "received", "results" ], "properties": { "format": { "type": "string" }, "received": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "no", "ok", "queued", "error" ], "properties": { "id": { "type": "string" }, "no": { "type": [ "null", "integer" ] }, "ok": { "type": "boolean" }, "queued": { "type": "integer" }, "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" } } } } } } }, "/api/v1/profiles/batch/cookies/export": { "post": { "summary": "Cookies mehrerer Profile lesen (höchstens 100) und als ZIP mit einer Datei je Profil zurückgeben", "tags": [ "Cookies" ], "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": 100 }, "format": { "anyOf": [ { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] } ] } }, "additionalProperties": false } } } }, "x-required-scopes": [ "cookies:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "file_name", "content_base64", "results" ], "properties": { "file_name": { "type": "string" }, "content_base64": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "id", "no", "count", "error" ], "properties": { "id": { "type": "string" }, "no": { "type": [ "null", "integer" ] }, "count": { "type": [ "null", "integer" ] }, "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" } } } } } } }, "/api/v1/profiles/{id}/cookies/remove": { "post": { "summary": "Ausgewählte Cookies einschließlich vorgemerkter Kopien löschen", "tags": [ "Cookies" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "cookies" ], "properties": { "cookies": { "type": "array", "items": { "type": "object", "required": [ "name", "value", "domain", "host_only", "path", "expires", "http_only", "secure", "same_site", "session", "partition_key", "priority", "source_scheme", "source_port", "creation", "last_access" ], "properties": { "firefox": { "type": "object", "required": [ "partition_key", "partitioned", "user_context_id" ], "properties": { "partition_key": { "type": "string" }, "partitioned": { "type": "boolean" }, "user_context_id": { "type": "integer" } } }, "name": { "type": "string" }, "value": { "type": "string" }, "domain": { "type": "string" }, "host_only": { "type": "boolean" }, "path": { "type": "string" }, "expires": { "type": [ "null", "number" ] }, "http_only": { "type": "boolean" }, "secure": { "type": "boolean" }, "same_site": { "type": "string" }, "session": { "type": "boolean" }, "partition_key": { "anyOf": [ { "type": "object", "required": [ "top_level_site", "has_cross_site_ancestor" ], "properties": { "top_level_site": { "type": "string" }, "has_cross_site_ancestor": { "type": "boolean" } } }, { "type": "null" } ] }, "priority": { "type": [ "null", "string" ] }, "source_scheme": { "type": [ "null", "string" ] }, "source_port": { "type": [ "null", "integer" ] }, "creation": { "type": [ "null", "number" ] }, "last_access": { "type": [ "null", "number" ] } } }, "minItems": 1, "maxItems": 20000 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "cookies:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "removed" ], "properties": { "removed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/cookies/convert": { "post": { "summary": "Cookie-Formate umwandeln und prüfen, ohne ein Profil zu ändern", "tags": [ "Cookies" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "cookies", "to" ], "properties": { "cookies": { "description": "Cookies als Text (JSON, Netscape, Name=Wert, Base64) oder als JSON-Array" }, "from": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] }, { "type": "string", "enum": [ "storage_state" ] }, { "type": "string", "enum": [ "base64" ] } ] }, "to": { "anyOf": [ { "type": "string", "enum": [ "json" ] }, { "type": "string", "enum": [ "netscape" ] }, { "type": "string", "enum": [ "header" ] } ] }, "domain": { "type": "string", "minLength": 1, "maxLength": 253 }, "skip_expired": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "cookies:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "detected", "encoding", "count", "expired", "errors", "output" ], "properties": { "detected": { "type": "string" }, "encoding": { "type": "string" }, "count": { "type": "integer" }, "expired": { "type": "integer" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "index", "name", "code", "message" ], "properties": { "index": { "type": "integer" }, "name": { "type": [ "null", "string" ] }, "code": { "type": "string" }, "message": { "type": "string" } } } }, "output": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/local-storage/export": { "post": { "summary": "Local Storage für explizite Origins ohne Abruf der Webseiten exportieren", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "origins" ], "properties": { "origins": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "minItems": 1, "maxItems": 50 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:read", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "origins" ], "properties": { "origins": { "type": "array", "items": { "type": "object", "required": [ "origin", "localStorage" ], "properties": { "origin": { "type": "string" }, "localStorage": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/session-storage/export": { "post": { "summary": "Session Storage geöffneter Tabs für explizite Origins exportieren", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "origins" ], "properties": { "origins": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "minItems": 1, "maxItems": 50 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:read", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "tabs", "skipped_tabs" ], "properties": { "tabs": { "type": "array", "items": { "type": "object", "required": [ "target_id", "origin", "sessionStorage" ], "properties": { "target_id": { "type": "string" }, "origin": { "type": "string" }, "sessionStorage": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } } } } }, "skipped_tabs": { "type": "array", "items": { "type": "object", "required": [ "target_id", "reason" ], "properties": { "target_id": { "type": "string" }, "reason": { "anyOf": [ { "type": "string", "enum": [ "unavailable" ] }, { "type": "string", "enum": [ "origin_changed" ] }, { "type": "string", "enum": [ "storage_unavailable" ] } ] } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/website-storage/indexeddb/import": { "post": { "summary": "Eine neue IndexedDB-Datenbank aus einem Website-Speicherexport in ein geöffnetes Dokument importieren", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "document_index", "database_index", "target_id", "frame_id" ], "properties": { "data": {}, "document_index": { "type": "integer", "minimum": 0, "maximum": 499 }, "database_index": { "type": "integer", "minimum": 0, "maximum": 99 }, "target_id": { "type": "string", "minLength": 1, "maxLength": 512 }, "frame_id": { "type": "string", "minLength": 1, "maxLength": 512 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:write", "runtime:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "status", "reason" ], "properties": { "status": { "anyOf": [ { "type": "string", "enum": [ "imported" ] }, { "type": "string", "enum": [ "conflict" ] }, { "type": "string", "enum": [ "aborted" ] }, { "type": "string", "enum": [ "rejected" ] }, { "type": "string", "enum": [ "unknown" ] } ] }, "reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "records": { "type": "integer", "minimum": 0 } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/website-storage/export": { "post": { "summary": "Website-Speicher geöffneter Tabs und Frames mit Partitionenzuordnung exportieren", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "origins", "kinds" ], "properties": { "origins": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 2048 }, "minItems": 1, "maxItems": 50 }, "kinds": { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "local" ] }, { "type": "string", "enum": [ "session" ] }, { "type": "string", "enum": [ "indexeddb" ] } ] }, "minItems": 1, "maxItems": 3, "uniqueItems": true } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:read", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "format", "documents", "skipped_documents" ], "properties": { "format": { "type": "string", "enum": [ "adbr-website-storage-v1" ] }, "documents": { "type": "array", "items": { "type": "object", "required": [ "target_id", "frame_id", "parent_frame_id", "top_level_origin", "ancestor_origins", "origin", "storage_key", "data" ], "properties": { "target_id": { "type": "string" }, "frame_id": { "type": "string" }, "parent_frame_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "top_level_origin": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ancestor_origins": { "type": "array", "items": { "type": "string" } }, "origin": { "type": "string" }, "storage_key": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "data": { "type": "object", "additionalProperties": {} } } } }, "skipped_documents": { "type": "array", "items": { "type": "object", "required": [ "target_id", "frame_id", "reason" ], "properties": { "target_id": { "type": "string" }, "frame_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "reason": { "type": "string" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/import/preview": { "post": { "summary": "Profil-Import prüfen (CSV, XLSX, TXT im AdsPower-Format): Spaltenerkennung, Vorschau je Zeile", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "file_name", "content_base64" ], "properties": { "file_name": { "type": "string", "minLength": 1, "maxLength": 260 }, "content_base64": { "type": "string", "minLength": 4, "maxLength": 20971520 }, "sheet": { "type": "string", "maxLength": 64 }, "mapping": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "no" ] }, { "type": "string", "enum": [ "external_id" ] }, { "type": "string", "enum": [ "ip" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "custom_no" ] }, { "type": "string", "enum": [ "group" ] }, { "type": "string", "enum": [ "tags" ] }, { "type": "string", "enum": [ "status" ] }, { "type": "string", "enum": [ "notes" ] }, { "type": "string", "enum": [ "engine" ] }, { "type": "string", "enum": [ "engine_version" ] }, { "type": "string", "enum": [ "os" ] }, { "type": "string", "enum": [ "ua" ] }, { "type": "string", "enum": [ "resolution" ] }, { "type": "string", "enum": [ "platform" ] }, { "type": "string", "enum": [ "username" ] }, { "type": "string", "enum": [ "password" ] }, { "type": "string", "enum": [ "totp_secret" ] }, { "type": "string", "enum": [ "cookie" ] }, { "type": "string", "enum": [ "proxytype" ] }, { "type": "string", "enum": [ "proxy" ] }, { "type": "string", "enum": [ "proxy_url" ] }, { "type": "string", "enum": [ "proxy_id" ] }, { "type": "string", "enum": [ "ip_checker" ] }, { "type": "string", "enum": [ "countrycode" ] }, { "type": "string", "enum": [ "regioncode" ] }, { "type": "string", "enum": [ "citycode" ] }, { "type": "string", "enum": [ "start_urls" ] }, { "type": "string", "enum": [ "extensions_set" ] } ] }, { "type": "null" } ] } }, "duplicate_check": { "anyOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "account" ] }, { "type": "string", "enum": [ "account_password" ] }, { "type": "string", "enum": [ "cookie" ] } ] }, "ignore_cookie_errors": { "type": "boolean" }, "exclude_lines": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 1000 }, "defaults": { "type": "object", "properties": { "group_id": { "type": [ "string", "null" ] }, "engine": { "anyOf": [ { "type": "string", "enum": [ "chromium" ] }, { "type": "string", "enum": [ "firefox" ] } ] }, "engine_version": { "type": "string", "pattern": "^[0-9]{2,4}$" }, "os": { "type": "string", "maxLength": 16 }, "tag_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 30 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50 }, "maxItems": 30 }, "storage_options": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "kind", "sheets", "sheet", "fields", "columns", "extra_accounts", "counts", "rows" ], "properties": { "kind": { "type": "string" }, "sheets": { "type": "array", "items": { "type": "string" } }, "sheet": { "type": "string" }, "fields": { "type": "array", "items": { "type": "string" } }, "columns": { "type": "array", "items": { "type": "object", "required": [ "index", "header", "field" ], "properties": { "index": { "type": "integer" }, "header": { "type": "string" }, "field": { "type": [ "null", "string" ] } } } }, "extra_accounts": { "type": "integer" }, "counts": { "type": "object", "required": [ "create", "update", "invalid", "duplicate", "excluded" ], "properties": { "create": { "type": "integer" }, "update": { "type": "integer" }, "invalid": { "type": "integer" }, "duplicate": { "type": "integer" }, "excluded": { "type": "integer" } } }, "rows": { "type": "array", "items": { "type": "object", "required": [ "line", "action", "status", "issues", "warnings", "profile_id", "name", "group", "tags", "engine", "extension_set", "proxy", "accounts", "first_account", "cookies" ], "properties": { "line": { "type": "integer" }, "action": { "type": "string" }, "status": { "type": "string" }, "issues": { "type": "array", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } }, "warnings": { "type": "array", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } }, "profile_id": { "type": [ "null", "string" ] }, "name": { "type": "string" }, "group": { "type": [ "null", "string" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "engine": { "type": [ "null", "string" ] }, "extension_set": { "type": [ "null", "string" ] }, "proxy": { "type": [ "null", "string" ] }, "accounts": { "type": "integer" }, "first_account": { "type": [ "null", "string" ] }, "cookies": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/import": { "post": { "summary": "Profile aus Datei anlegen oder über die Spalte id aktualisieren; Ergebnis je Zeile", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "file_name", "content_base64" ], "properties": { "file_name": { "type": "string", "minLength": 1, "maxLength": 260 }, "content_base64": { "type": "string", "minLength": 4, "maxLength": 20971520 }, "sheet": { "type": "string", "maxLength": 64 }, "mapping": { "type": "object", "additionalProperties": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "id" ] }, { "type": "string", "enum": [ "no" ] }, { "type": "string", "enum": [ "external_id" ] }, { "type": "string", "enum": [ "ip" ] }, { "type": "string", "enum": [ "name" ] }, { "type": "string", "enum": [ "custom_no" ] }, { "type": "string", "enum": [ "group" ] }, { "type": "string", "enum": [ "tags" ] }, { "type": "string", "enum": [ "status" ] }, { "type": "string", "enum": [ "notes" ] }, { "type": "string", "enum": [ "engine" ] }, { "type": "string", "enum": [ "engine_version" ] }, { "type": "string", "enum": [ "os" ] }, { "type": "string", "enum": [ "ua" ] }, { "type": "string", "enum": [ "resolution" ] }, { "type": "string", "enum": [ "platform" ] }, { "type": "string", "enum": [ "username" ] }, { "type": "string", "enum": [ "password" ] }, { "type": "string", "enum": [ "totp_secret" ] }, { "type": "string", "enum": [ "cookie" ] }, { "type": "string", "enum": [ "proxytype" ] }, { "type": "string", "enum": [ "proxy" ] }, { "type": "string", "enum": [ "proxy_url" ] }, { "type": "string", "enum": [ "proxy_id" ] }, { "type": "string", "enum": [ "ip_checker" ] }, { "type": "string", "enum": [ "countrycode" ] }, { "type": "string", "enum": [ "regioncode" ] }, { "type": "string", "enum": [ "citycode" ] }, { "type": "string", "enum": [ "start_urls" ] }, { "type": "string", "enum": [ "extensions_set" ] } ] }, { "type": "null" } ] } }, "duplicate_check": { "anyOf": [ { "type": "string", "enum": [ "none" ] }, { "type": "string", "enum": [ "account" ] }, { "type": "string", "enum": [ "account_password" ] }, { "type": "string", "enum": [ "cookie" ] } ] }, "ignore_cookie_errors": { "type": "boolean" }, "exclude_lines": { "type": "array", "items": { "type": "integer", "minimum": 1 }, "maxItems": 1000 }, "defaults": { "type": "object", "properties": { "group_id": { "type": [ "string", "null" ] }, "engine": { "anyOf": [ { "type": "string", "enum": [ "chromium" ] }, { "type": "string", "enum": [ "firefox" ] } ] }, "engine_version": { "type": "string", "pattern": "^[0-9]{2,4}$" }, "os": { "type": "string", "maxLength": 16 }, "tag_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 30 }, "tags": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 50 }, "maxItems": 30 }, "storage_options": { "type": "object", "additionalProperties": { "type": "boolean" } } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "created", "updated", "skipped", "failed", "results" ], "properties": { "created": { "type": "integer" }, "updated": { "type": "integer" }, "skipped": { "type": "integer" }, "failed": { "type": "integer" }, "results": { "type": "array", "items": { "type": "object", "required": [ "line", "status", "id", "no", "error", "warnings", "cookies" ], "properties": { "line": { "type": "integer" }, "status": { "type": "string" }, "id": { "type": [ "null", "string" ] }, "no": { "type": [ "null", "integer" ] }, "error": { "anyOf": [ { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, { "type": "null" } ] }, "warnings": { "type": "array", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } }, "cookies": { "type": [ "null", "string" ] } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/import/template": { "get": { "summary": "Import-Vorlage mit allen Spalten (XLSX mit Blatt „Zusatzkonten“, CSV oder TXT)", "tags": [ "Import/Export" ], "parameters": [ { "schema": { "anyOf": [ { "type": "string", "enum": [ "xlsx" ] }, { "type": "string", "enum": [ "csv" ] }, { "type": "string", "enum": [ "txt" ] } ] }, "in": "query", "name": "format", "required": false } ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "file_name", "mime", "content_base64" ], "properties": { "file_name": { "type": "string" }, "mime": { "type": "string" }, "content_base64": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/export": { "post": { "summary": "Profile als XLSX, CSV oder TXT exportieren (wieder importierbar, Spalten id/no für Aktualisierung); Passwörter nur mit secrets:read", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "format" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "all": { "type": "boolean" }, "format": { "anyOf": [ { "type": "string", "enum": [ "xlsx" ] }, { "type": "string", "enum": [ "csv" ] }, { "type": "string", "enum": [ "txt" ] } ] }, "include_secrets": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "file_name", "mime", "count", "content_base64" ], "properties": { "file_name": { "type": "string" }, "mime": { "type": "string" }, "count": { "type": "integer" }, "content_base64": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/integrations/transfers/list": { "post": { "summary": "GoLogin-, Dolphin- oder Multilogin-X-Profile ohne lokale Änderungen auflisten", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "token" ], "properties": { "source": { "anyOf": [ { "type": "string", "enum": [ "gologin" ] }, { "type": "string", "enum": [ "dolphin" ] }, { "type": "string", "enum": [ "multilogin" ] } ] }, "token": { "type": "string", "minLength": 8, "maxLength": 8192 }, "page": { "type": "integer", "minimum": 1, "maximum": 10000 }, "cursor": { "type": "string", "maxLength": 4096 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "next" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } }, "next": { "type": [ "string", "null" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/integrations/transfers/preview": { "post": { "summary": "Direkttransfer von bis zu 20 ausgewählten Profilen prüfen; zehn Minuten gültige Vorschau", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "source", "token", "ids", "cookies" ], "properties": { "source": { "anyOf": [ { "type": "string", "enum": [ "gologin" ] }, { "type": "string", "enum": [ "dolphin" ] }, { "type": "string", "enum": [ "multilogin" ] } ] }, "token": { "type": "string", "minLength": 8, "maxLength": 8192 }, "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 100 }, "minItems": 1, "maxItems": 20, "uniqueItems": true }, "cookies": { "type": "boolean" }, "group_id": { "type": "string", "maxLength": 64 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "expires_at", "warnings", "rows" ], "properties": { "id": { "type": "string" }, "expires_at": { "type": "integer" }, "warnings": { "type": "array", "items": { "type": "string" } }, "rows": { "type": "array", "items": { "type": "object", "required": [ "line", "action", "status", "issues", "warnings", "profile_id", "name", "group", "tags", "engine", "extension_set", "proxy", "accounts", "first_account", "cookies" ], "properties": { "line": { "type": "integer" }, "action": { "anyOf": [ { "type": "string", "enum": [ "create" ] }, { "type": "string", "enum": [ "update" ] }, { "type": "string", "enum": [ "skip" ] } ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "ok" ] }, { "type": "string", "enum": [ "invalid" ] }, { "type": "string", "enum": [ "duplicate" ] }, { "type": "string", "enum": [ "excluded" ] } ] }, "issues": { "type": "array", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } }, "warnings": { "type": "array", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } }, "profile_id": { "type": [ "string", "null" ] }, "name": { "type": "string" }, "group": { "type": [ "string", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "engine": { "type": [ "string", "null" ] }, "extension_set": { "type": [ "string", "null" ] }, "proxy": { "type": [ "string", "null" ] }, "accounts": { "type": "integer" }, "first_account": { "type": [ "string", "null" ] }, "cookies": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/integrations/transfers/execute": { "post": { "summary": "Geprüften Direkttransfer einmalig ausführen", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "created", "failed", "skipped" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "line", "status", "id", "no", "error", "warnings", "cookies" ], "properties": { "line": { "type": "integer" }, "status": { "anyOf": [ { "type": "string", "enum": [ "created" ] }, { "type": "string", "enum": [ "updated" ] }, { "type": "string", "enum": [ "skipped" ] }, { "type": "string", "enum": [ "failed" ] } ] }, "id": { "type": [ "string", "null" ] }, "no": { "type": [ "integer", "null" ] }, "error": { "anyOf": [ { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } }, { "type": "null" } ] }, "warnings": { "type": "array", "items": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } }, "cookies": { "anyOf": [ { "type": "string", "enum": [ "queued" ] }, { "type": "null" } ] } } } }, "created": { "type": "integer" }, "failed": { "type": "integer" }, "skipped": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/bookmarks": { "get": { "summary": "Verwaltete Lesezeichen eines Profils", "tags": [ "Lesezeichen" ], "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": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "folder" ], "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "folder": { "type": [ "null", "string" ] } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Lesezeichen ersetzen; wirksam beim nächsten Start (eigene Lesezeichen im Browser bleiben erhalten)", "tags": [ "Lesezeichen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "bookmarks" ], "properties": { "bookmarks": { "type": "array", "items": { "type": "object", "required": [ "title", "url" ], "properties": { "title": { "type": "string", "maxLength": 512 }, "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "folder": { "type": [ "string", "null" ], "maxLength": 256 } } }, "maxItems": 1000 } }, "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": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "folder" ], "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "folder": { "type": [ "null", "string" ] } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/batch/bookmarks": { "post": { "summary": "Lesezeichen für mehrere Profile hinzufügen, ersetzen oder leeren", "tags": [ "Lesezeichen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "mode" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "mode": { "anyOf": [ { "type": "string", "enum": [ "add" ] }, { "type": "string", "enum": [ "replace" ] }, { "type": "string", "enum": [ "clear" ] } ] }, "bookmarks": { "type": "array", "items": { "type": "object", "required": [ "title", "url" ], "properties": { "title": { "type": "string", "maxLength": 512 }, "url": { "type": "string", "minLength": 1, "maxLength": 2048 }, "folder": { "type": [ "string", "null" ], "maxLength": 256 } } }, "maxItems": 1000 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/bookmarks/parse": { "post": { "summary": "Lesezeichen aus Zeilen („Ordner::Name::URL“, „Name::URL“, „URL“) oder HTML-Lesezeichendatei lesen", "tags": [ "Lesezeichen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "maxLength": 16777216 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "format", "items", "errors" ], "properties": { "format": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "title", "url", "folder" ], "properties": { "title": { "type": "string" }, "url": { "type": "string" }, "folder": { "type": [ "null", "string" ] } } } }, "errors": { "type": "array", "items": { "type": "object", "required": [ "line", "message" ], "properties": { "line": { "type": "integer" }, "message": { "type": "string" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/extensions/store-metadata": { "get": { "summary": "Store-Versionen und Veröffentlichungsdaten ohne Paketdownload abrufen", "tags": [ "Erweiterungen" ], "parameters": [ { "schema": { "anyOf": [ { "type": "string", "enum": [ "chromium" ] }, { "type": "string", "enum": [ "firefox" ] } ] }, "in": "query", "name": "engine", "required": false } ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "engine", "extension_id", "url", "version", "updated_at", "checked_at" ], "properties": { "engine": { "anyOf": [ { "type": "string", "enum": [ "chromium" ] }, { "type": "string", "enum": [ "firefox" ] } ] }, "extension_id": { "type": "string" }, "url": { "type": "string" }, "version": { "type": "string" }, "updated_at": { "type": "integer" }, "checked_at": { "type": "integer" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/extensions": { "get": { "summary": "Erweiterungsbibliothek (Chromium und Firefox getrennt)", "tags": [ "Erweiterungen" ], "parameters": [ { "schema": { "anyOf": [ { "type": "string", "enum": [ "chromium" ] }, { "type": "string", "enum": [ "firefox" ] } ] }, "in": "query", "name": "engine", "required": false } ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "engine", "source_type", "source_url", "extension_id", "update_mode", "version", "manifest_version", "description", "fingerprint_risk", "icon_data_url", "groups", "versions", "set_count", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "engine": { "type": "string" }, "source_type": { "type": "string" }, "source_url": { "type": [ "null", "string" ] }, "extension_id": { "type": [ "null", "string" ] }, "update_mode": { "type": "string" }, "version": { "type": [ "null", "string" ] }, "manifest_version": { "type": [ "null", "integer" ] }, "description": { "type": [ "null", "string" ] }, "fingerprint_risk": { "type": "boolean" }, "icon_data_url": { "type": [ "null", "string" ] }, "groups": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } }, "versions": { "type": "array", "items": { "type": "object", "required": [ "id", "version", "sha256", "size_bytes", "added_at" ], "properties": { "id": { "type": "string" }, "version": { "type": "string" }, "sha256": { "type": "string" }, "size_bytes": { "type": "integer" }, "added_at": { "type": "integer" } } } }, "set_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_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": { "summary": "Erweiterung hinzufügen: Store-Adresse (Chrome Web Store, addons.mozilla.org), CRX/ZIP/XPI-Datei oder entpackter Ordner", "tags": [ "Erweiterungen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "source" ], "properties": { "source": { "anyOf": [ { "type": "string", "enum": [ "store_url" ] }, { "type": "string", "enum": [ "file" ] }, { "type": "string", "enum": [ "unpacked" ] } ] }, "url": { "type": "string", "maxLength": 2048 }, "file_name": { "type": "string", "maxLength": 260 }, "content_base64": { "type": "string", "maxLength": 146800640 }, "path": { "type": "string", "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "extensions:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "engine", "source_type", "source_url", "extension_id", "update_mode", "version", "manifest_version", "description", "fingerprint_risk", "icon_data_url", "groups", "versions", "set_count", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "engine": { "type": "string" }, "source_type": { "type": "string" }, "source_url": { "type": [ "null", "string" ] }, "extension_id": { "type": [ "null", "string" ] }, "update_mode": { "type": "string" }, "version": { "type": [ "null", "string" ] }, "manifest_version": { "type": [ "null", "integer" ] }, "description": { "type": [ "null", "string" ] }, "fingerprint_risk": { "type": "boolean" }, "icon_data_url": { "type": [ "null", "string" ] }, "groups": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } }, "versions": { "type": "array", "items": { "type": "object", "required": [ "id", "version", "sha256", "size_bytes", "added_at" ], "properties": { "id": { "type": "string" }, "version": { "type": "string" }, "sha256": { "type": "string" }, "size_bytes": { "type": "integer" }, "added_at": { "type": "integer" } } } }, "set_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/extensions/{id}/groups": { "get": { "summary": "Dauerhafte Gruppenzuordnung einer Erweiterung", "tags": [ "Erweiterungen" ], "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": [ "revision", "groups" ], "properties": { "revision": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "profile_count", "selected" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "profile_count": { "type": "integer" }, "selected": { "type": "boolean" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Gruppenzuordnung atomar ändern; gilt auch für neue Profile und beim nächsten Start", "tags": [ "Erweiterungen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "group_ids", "revision" ], "properties": { "group_ids": { "type": "array", "items": { "type": "string" }, "maxItems": 10000 }, "revision": { "type": "string", "minLength": 64, "maxLength": 64 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "extensions:write", "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "revision", "groups" ], "properties": { "revision": { "type": "string" }, "groups": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "profile_count", "selected" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "profile_count": { "type": "integer" }, "selected": { "type": "boolean" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/extensions/{id}": { "patch": { "summary": "Name oder Update-Modus (automatisch, manuell, gesperrt) ändern", "tags": [ "Erweiterungen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 200 }, "update_mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "manual" ] }, { "type": "string", "enum": [ "locked" ] } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "extensions:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "engine", "source_type", "source_url", "extension_id", "update_mode", "version", "manifest_version", "description", "fingerprint_risk", "icon_data_url", "groups", "versions", "set_count", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "engine": { "type": "string" }, "source_type": { "type": "string" }, "source_url": { "type": [ "null", "string" ] }, "extension_id": { "type": [ "null", "string" ] }, "update_mode": { "type": "string" }, "version": { "type": [ "null", "string" ] }, "manifest_version": { "type": [ "null", "integer" ] }, "description": { "type": [ "null", "string" ] }, "fingerprint_risk": { "type": "boolean" }, "icon_data_url": { "type": [ "null", "string" ] }, "groups": { "type": "array", "items": { "type": "object", "required": [ "id", "name" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" } } } }, "versions": { "type": "array", "items": { "type": "object", "required": [ "id", "version", "sha256", "size_bytes", "added_at" ], "properties": { "id": { "type": "string" }, "version": { "type": "string" }, "sha256": { "type": "string" }, "size_bytes": { "type": "integer" }, "added_at": { "type": "integer" } } } }, "set_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Erweiterung aus Bibliothek und Sätzen entfernen (nicht bei laufenden Profilen)", "tags": [ "Erweiterungen" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "extensions:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "removed" ], "properties": { "id": { "type": "string" }, "removed": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/extensions/{id}/update": { "post": { "summary": "Neue Version aus dem Store laden", "tags": [ "Erweiterungen" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "extensions:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "updated", "version" ], "properties": { "updated": { "type": "boolean" }, "version": { "type": [ "null", "string" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/extension-sets": { "get": { "summary": "Erweiterungssätze", "tags": [ "Erweiterungen" ], "parameters": [ { "schema": { "anyOf": [ { "type": "string", "enum": [ "chromium" ] }, { "type": "string", "enum": [ "firefox" ] } ] }, "in": "query", "name": "engine", "required": false } ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "engine", "items", "profile_count", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "engine": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "extension_id", "name", "enabled", "pinned_version_id", "version" ], "properties": { "extension_id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "pinned_version_id": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "string" ] } } } }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_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": { "summary": "Erweiterungssatz anlegen (höchstens 20 Erweiterungen)", "tags": [ "Erweiterungen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "engine" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "engine": { "anyOf": [ { "type": "string", "enum": [ "chromium" ] }, { "type": "string", "enum": [ "firefox" ] } ] }, "items": { "type": "array", "items": { "type": "object", "required": [ "extension_id" ], "properties": { "extension_id": { "type": "string" }, "enabled": { "type": "boolean" }, "pinned_version_id": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "maxItems": 20 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "extensions:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "engine", "items", "profile_count", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "engine": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "extension_id", "name", "enabled", "pinned_version_id", "version" ], "properties": { "extension_id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "pinned_version_id": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "string" ] } } } }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/extension-sets/{id}": { "patch": { "summary": "Erweiterungssatz ändern", "tags": [ "Erweiterungen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "items": { "type": "array", "items": { "type": "object", "required": [ "extension_id" ], "properties": { "extension_id": { "type": "string" }, "enabled": { "type": "boolean" }, "pinned_version_id": { "type": [ "string", "null" ] } }, "additionalProperties": false }, "maxItems": 20 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "extensions:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "engine", "items", "profile_count", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "engine": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "required": [ "extension_id", "name", "enabled", "pinned_version_id", "version" ], "properties": { "extension_id": { "type": "string" }, "name": { "type": "string" }, "enabled": { "type": "boolean" }, "pinned_version_id": { "type": [ "null", "string" ] }, "version": { "type": [ "null", "string" ] } } } }, "profile_count": { "type": "integer" }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Erweiterungssatz löschen; Profile verlieren die Zuweisung", "tags": [ "Erweiterungen" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "extensions:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "removed" ], "properties": { "id": { "type": "string" }, "removed": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/extension-sets/{id}/assign": { "post": { "summary": "Satz Profilen zuweisen: Auswahl, Gruppe, Tag oder alle (nur Profile desselben Kerns)", "tags": [ "Erweiterungen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "group_id": { "type": "string" }, "tag_id": { "type": "string" }, "all": { "type": "boolean" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "extensions:write", "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "assigned", "skipped" ], "properties": { "assigned": { "type": "integer" }, "skipped": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/extension-sets/unassign": { "post": { "summary": "Zuweisung von Erweiterungssätzen entfernen", "tags": [ "Erweiterungen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "profile_ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "group_id": { "type": "string" }, "tag_id": { "type": "string" }, "all": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "extensions:write", "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "assigned", "skipped" ], "properties": { "assigned": { "type": "integer" }, "skipped": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/audit": { "get": { "summary": "Audit-Log mit Filtern, neueste zuerst; Weiterblättern über before_seq", "tags": [ "Audit-Log" ], "parameters": [ { "schema": { "anyOf": [ { "type": "string", "enum": [ "account" ] }, { "type": "string", "enum": [ "profile" ] }, { "type": "string", "enum": [ "startup" ] }, { "type": "string", "enum": [ "proxy" ] }, { "type": "string", "enum": [ "team" ] } ] }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "from", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "to", "required": false }, { "schema": { "type": "string", "maxLength": 100 }, "in": "query", "name": "action", "required": false }, { "schema": { "type": "string", "maxLength": 20 }, "in": "query", "name": "source", "required": false }, { "schema": { "type": "string", "maxLength": 20 }, "in": "query", "name": "actor_type", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "entity_id", "required": false }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "entity_no", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "ok" ] }, { "type": "string", "enum": [ "denied" ] }, { "type": "string", "enum": [ "error" ] } ] }, "in": "query", "name": "result", "required": false }, { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "before_seq", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false } ], "x-required-scopes": [ "audit:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "next_before_seq" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "seq", "id", "ts", "actor_type", "actor_id", "actor_label", "source", "action", "entity_type", "entity_id", "entity_no", "result", "error_code", "details", "request_id" ], "properties": { "seq": { "type": "integer" }, "id": { "type": "string" }, "ts": { "type": "integer" }, "actor_type": { "type": "string" }, "actor_id": { "type": [ "null", "string" ] }, "actor_label": { "type": "string" }, "source": { "type": "string" }, "action": { "type": "string" }, "entity_type": { "type": [ "null", "string" ] }, "entity_id": { "type": [ "null", "string" ] }, "entity_no": { "type": [ "null", "integer" ] }, "result": { "type": "string" }, "error_code": { "type": [ "null", "string" ] }, "details": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": true }, { "type": "null" } ] }, "request_id": { "type": [ "null", "string" ] } } } }, "next_before_seq": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/audit/verify": { "get": { "summary": "Hash-Kette und Tagesanker prüfen; meldet die erste Abweichung", "tags": [ "Audit-Log" ], "x-required-scopes": [ "audit:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "ok", "checked", "anchors", "first_bad_seq", "missing_anchor" ], "properties": { "ok": { "type": "boolean" }, "checked": { "type": "integer" }, "anchors": { "type": "integer" }, "first_bad_seq": { "type": [ "null", "integer" ] }, "missing_anchor": { "type": [ "null", "string" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/audit/export": { "get": { "summary": "Audit-Log als CSV oder JSONL exportieren (Filter wie bei der Liste)", "tags": [ "Audit-Log" ], "parameters": [ { "schema": { "anyOf": [ { "type": "string", "enum": [ "account" ] }, { "type": "string", "enum": [ "profile" ] }, { "type": "string", "enum": [ "startup" ] }, { "type": "string", "enum": [ "proxy" ] }, { "type": "string", "enum": [ "team" ] } ] }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "from", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "to", "required": false }, { "schema": { "type": "string", "maxLength": 100 }, "in": "query", "name": "action", "required": false }, { "schema": { "type": "string", "maxLength": 20 }, "in": "query", "name": "source", "required": false }, { "schema": { "type": "string", "maxLength": 20 }, "in": "query", "name": "actor_type", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "entity_id", "required": false }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "entity_no", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "ok" ] }, { "type": "string", "enum": [ "denied" ] }, { "type": "string", "enum": [ "error" ] } ] }, "in": "query", "name": "result", "required": false }, { "schema": { "type": "string", "maxLength": 200 }, "in": "query", "name": "search", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "csv" ] }, { "type": "string", "enum": [ "jsonl" ] } ] }, "in": "query", "name": "format", "required": true } ], "x-required-scopes": [ "audit:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "file_name", "count", "content_base64" ], "properties": { "file_name": { "type": "string" }, "count": { "type": "integer" }, "content_base64": { "type": "string" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/settings/audit": { "get": { "summary": "Aufbewahrung des Audit-Logs", "tags": [ "Audit-Log" ], "x-required-scopes": [ "audit:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "retention_days", "entries", "oldest_ts" ], "properties": { "retention_days": { "type": "integer" }, "entries": { "type": "integer" }, "oldest_ts": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Aufbewahrung des Audit-Logs ändern (30–1.095 Tage)", "tags": [ "Audit-Log" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "retention_days" ], "properties": { "retention_days": { "type": "integer", "minimum": 30, "maximum": 1095 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "settings:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "retention_days" ], "properties": { "retention_days": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/backups/full": { "get": { "summary": "Einstellungen und Stand des verschlüsselten Vollbackups (.adbbackup) und der Prüfung", "tags": [ "Sicherungen" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "schedule", "target_dir", "include_cookies", "password_stored", "running", "last_run", "last_success_at", "next_due_at", "last_verify", "last_verify_ok_at" ], "properties": { "schedule": { "type": "string" }, "target_dir": { "type": [ "null", "string" ] }, "include_cookies": { "type": "boolean" }, "password_stored": { "type": "boolean" }, "running": { "type": "boolean" }, "last_run": { "anyOf": [ { "type": "object", "required": [ "at", "ok", "trigger", "path", "size_bytes", "profiles", "warnings", "pruned", "error" ], "properties": { "at": { "type": "integer" }, "ok": { "type": "boolean" }, "trigger": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "size_bytes": { "type": [ "integer", "null" ] }, "profiles": { "type": [ "integer", "null" ] }, "warnings": { "type": "integer" }, "pruned": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } }, { "type": "null" } ] }, "last_success_at": { "type": [ "null", "integer" ] }, "next_due_at": { "type": [ "null", "integer" ] }, "last_verify": { "anyOf": [ { "type": "object", "required": [ "at", "ok", "db", "full" ], "properties": { "at": { "type": "integer" }, "ok": { "type": "boolean" }, "db": { "type": "object", "required": [ "file", "ok", "profiles", "error" ], "properties": { "file": { "type": [ "null", "string" ] }, "ok": { "type": [ "null", "boolean" ] }, "profiles": { "type": [ "null", "integer" ] }, "error": { "type": [ "null", "string" ] } } }, "full": { "type": "object", "required": [ "file", "ok", "profiles", "error" ], "properties": { "file": { "type": [ "null", "string" ] }, "ok": { "type": [ "null", "boolean" ] }, "profiles": { "type": [ "null", "integer" ] }, "error": { "type": [ "null", "string" ] } } } } }, { "type": "null" } ] }, "last_verify_ok_at": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Vollbackup jetzt erstellen: alle Profile portabel, Proxys, Gruppen, Tags, Erweiterungsbibliothek und RPA-Abläufe; verschlüsselt, geprüft und erst dann in den Zielordner verschoben", "tags": [ "Sicherungen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "target_dir": { "type": "string", "minLength": 3, "maxLength": 1024 }, "password": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "path", "size_bytes", "sha256", "proxies", "groups", "tags", "extensions", "extension_sets", "workflows", "pruned", "warnings", "profiles" ], "properties": { "path": { "type": "string" }, "size_bytes": { "type": "integer" }, "sha256": { "type": "string" }, "proxies": { "type": "integer" }, "groups": { "type": "integer" }, "tags": { "type": "integer" }, "extensions": { "type": "integer" }, "extension_sets": { "type": "integer" }, "workflows": { "type": "integer" }, "pruned": { "type": "integer" }, "warnings": { "type": "array", "items": { "type": "string" } }, "profiles": { "type": "array", "items": { "type": "object", "required": [ "id", "no", "name", "cookies", "files", "warnings" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "name": { "type": "string" }, "cookies": { "type": [ "null", "integer" ] }, "files": { "type": "integer" }, "warnings": { "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" } } } } } } }, "/api/v1/backups/full/settings": { "put": { "summary": "Zeitplan, Zielordner und gespeichertes Passwort für Vollbackups festlegen (Passwort liegt dann im Tresor)", "tags": [ "Sicherungen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "schedule": { "anyOf": [ { "type": "string", "enum": [ "off" ] }, { "type": "string", "enum": [ "daily" ] }, { "type": "string", "enum": [ "weekly" ] } ] }, "target_dir": { "type": [ "string", "null" ], "minLength": 3, "maxLength": 1024 }, "include_cookies": { "type": "boolean" }, "password": { "type": "string", "minLength": 12, "maxLength": 1024 }, "clear_password": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "schedule", "target_dir", "include_cookies", "password_stored", "running", "last_run", "last_success_at", "next_due_at", "last_verify", "last_verify_ok_at" ], "properties": { "schedule": { "type": "string" }, "target_dir": { "type": [ "null", "string" ] }, "include_cookies": { "type": "boolean" }, "password_stored": { "type": "boolean" }, "running": { "type": "boolean" }, "last_run": { "anyOf": [ { "type": "object", "required": [ "at", "ok", "trigger", "path", "size_bytes", "profiles", "warnings", "pruned", "error" ], "properties": { "at": { "type": "integer" }, "ok": { "type": "boolean" }, "trigger": { "type": "string" }, "path": { "type": [ "string", "null" ] }, "size_bytes": { "type": [ "integer", "null" ] }, "profiles": { "type": [ "integer", "null" ] }, "warnings": { "type": "integer" }, "pruned": { "type": "integer" }, "error": { "type": [ "string", "null" ] } } }, { "type": "null" } ] }, "last_success_at": { "type": [ "null", "integer" ] }, "next_due_at": { "type": [ "null", "integer" ] }, "last_verify": { "anyOf": [ { "type": "object", "required": [ "at", "ok", "db", "full" ], "properties": { "at": { "type": "integer" }, "ok": { "type": "boolean" }, "db": { "type": "object", "required": [ "file", "ok", "profiles", "error" ], "properties": { "file": { "type": [ "null", "string" ] }, "ok": { "type": [ "null", "boolean" ] }, "profiles": { "type": [ "null", "integer" ] }, "error": { "type": [ "null", "string" ] } } }, "full": { "type": "object", "required": [ "file", "ok", "profiles", "error" ], "properties": { "file": { "type": [ "null", "string" ] }, "ok": { "type": [ "null", "boolean" ] }, "profiles": { "type": [ "null", "integer" ] }, "error": { "type": [ "null", "string" ] } } } } }, { "type": "null" } ] }, "last_verify_ok_at": { "type": [ "null", "integer" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/backups/verify": { "post": { "summary": "Sicherungen prüfen: neueste Datenbanksicherung (integrity_check an einer Kopie) und neuestes Vollbackup entschlüsseln und Prüfsummen vergleichen, ohne etwas einzuspielen", "tags": [ "Sicherungen" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "password": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "at", "ok", "db", "full" ], "properties": { "at": { "type": "integer" }, "ok": { "type": "boolean" }, "db": { "type": "object", "required": [ "file", "ok", "profiles", "error" ], "properties": { "file": { "type": [ "null", "string" ] }, "ok": { "type": [ "null", "boolean" ] }, "profiles": { "type": [ "null", "integer" ] }, "error": { "type": [ "null", "string" ] } } }, "full": { "type": "object", "required": [ "file", "ok", "profiles", "error" ], "properties": { "file": { "type": [ "null", "string" ] }, "ok": { "type": [ "null", "boolean" ] }, "profiles": { "type": [ "null", "integer" ] }, "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" } } } } } } }, "/api/v1/backups": { "get": { "summary": "Datenbanksicherungen (täglich, vor Migrationen, vor Massenänderungen)", "tags": [ "Sicherungen" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items", "pending_restore" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "kind", "file_name", "path", "size_bytes", "created_at", "note", "exists" ], "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "file_name": { "type": "string" }, "path": { "type": "string" }, "size_bytes": { "type": "integer" }, "created_at": { "type": "integer" }, "note": { "type": [ "null", "string" ] }, "exists": { "type": "boolean" } } } }, "pending_restore": { "anyOf": [ { "type": "object", "required": [ "backup_id", "file", "created_at", "requested_at" ], "properties": { "backup_id": { "type": "string" }, "file": { "type": "string" }, "created_at": { "type": "integer" }, "requested_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" } } } } } } }, "/api/v1/backups/db": { "post": { "summary": "Datenbank jetzt sichern (VACUUM INTO)", "tags": [ "Sicherungen" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "kind", "file_name", "path", "size_bytes", "created_at", "note", "exists" ], "properties": { "id": { "type": "string" }, "kind": { "type": "string" }, "file_name": { "type": "string" }, "path": { "type": "string" }, "size_bytes": { "type": "integer" }, "created_at": { "type": "integer" }, "note": { "type": [ "null", "string" ] }, "exists": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/backups/{id}/restore": { "post": { "summary": "Wiederherstellung vormerken: Die Sicherung wird geprüft und beim nächsten Core-Start eingespielt; der aktuelle Stand wird vorher gesichert", "tags": [ "Sicherungen" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "pending_restore", "restart_required" ], "properties": { "pending_restore": { "anyOf": [ { "type": "object", "required": [ "backup_id", "file", "created_at", "requested_at" ], "properties": { "backup_id": { "type": "string" }, "file": { "type": "string" }, "created_at": { "type": "integer" }, "requested_at": { "type": "integer" } } }, { "type": "null" } ] }, "restart_required": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/backups/restore-pending": { "delete": { "summary": "Vorgemerkte Wiederherstellung verwerfen", "tags": [ "Sicherungen" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "pending_restore" ], "properties": { "pending_restore": { "anyOf": [ { "type": "object", "required": [ "backup_id", "file", "created_at", "requested_at" ], "properties": { "backup_id": { "type": "string" }, "file": { "type": "string" }, "created_at": { "type": "integer" }, "requested_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" } } } } } } }, "/api/v1/backups/{id}": { "delete": { "summary": "Sicherung löschen", "tags": [ "Sicherungen" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "removed" ], "properties": { "id": { "type": "string" }, "removed": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/clone": { "post": { "summary": "Profil klonen: neue ID und Nr.; Fingerprint neu (Standard) oder gleich; Cookies, Proxy, Konten und Browserdaten nur auf Wunsch", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "integer", "minimum": 1, "maximum": 50 }, "name_pattern": { "type": "string", "minLength": 1, "maxLength": 100 }, "fingerprint": { "anyOf": [ { "type": "string", "enum": [ "new" ] }, { "type": "string", "enum": [ "same" ] } ] }, "cookies": { "type": "boolean" }, "proxy": { "type": "boolean" }, "accounts": { "type": "boolean" }, "storage": { "type": "boolean" }, "group_id": { "type": [ "string", "null" ] } }, "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": [ "results", "succeeded", "failed" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "index", "id", "ok" ], "properties": { "index": { "type": "integer" }, "id": { "type": [ "null", "string" ] }, "ok": { "type": "boolean" }, "no": { "type": "integer" }, "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "details": { "type": "object", "additionalProperties": {} } } } } } }, "succeeded": { "type": "integer" }, "failed": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/snapshots": { "get": { "summary": "Lokale Snapshots eines Profils (gerätegebunden, ohne Cache)", "tags": [ "Snapshots" ], "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": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "profile_id", "reason", "file_name", "size_bytes", "engine_build", "created_at", "exists" ], "properties": { "id": { "type": "string" }, "profile_id": { "type": "string" }, "reason": { "type": "string" }, "file_name": { "type": "string" }, "size_bytes": { "type": "integer" }, "engine_build": { "type": "string" }, "created_at": { "type": "integer" }, "exists": { "type": "boolean" } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "post": { "summary": "Snapshot jetzt anlegen (Profil muss geschlossen sein)", "tags": [ "Snapshots" ], "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": [ "id", "profile_id", "reason", "file_name", "size_bytes", "engine_build", "created_at", "exists" ], "properties": { "id": { "type": "string" }, "profile_id": { "type": "string" }, "reason": { "type": "string" }, "file_name": { "type": "string" }, "size_bytes": { "type": "integer" }, "engine_build": { "type": "string" }, "created_at": { "type": "integer" }, "exists": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/snapshots/{snapshotId}/restore": { "post": { "summary": "Snapshot wiederherstellen; vorher wird der aktuelle Stand gesichert, engine_build_last_used wird auf den Build des Snapshots gesetzt", "tags": [ "Snapshots" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "snapshotId", "required": true } ], "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "restored", "safety" ], "properties": { "restored": { "type": "object", "required": [ "id", "profile_id", "reason", "file_name", "size_bytes", "engine_build", "created_at", "exists" ], "properties": { "id": { "type": "string" }, "profile_id": { "type": "string" }, "reason": { "type": "string" }, "file_name": { "type": "string" }, "size_bytes": { "type": "integer" }, "engine_build": { "type": "string" }, "created_at": { "type": "integer" }, "exists": { "type": "boolean" } } }, "safety": { "type": "object", "required": [ "id", "profile_id", "reason", "file_name", "size_bytes", "engine_build", "created_at", "exists" ], "properties": { "id": { "type": "string" }, "profile_id": { "type": "string" }, "reason": { "type": "string" }, "file_name": { "type": "string" }, "size_bytes": { "type": "integer" }, "engine_build": { "type": "string" }, "created_at": { "type": "integer" }, "exists": { "type": "boolean" } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/snapshots/{snapshotId}": { "delete": { "summary": "Snapshot löschen", "tags": [ "Snapshots" ], "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "id", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "snapshotId", "required": true } ], "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "removed" ], "properties": { "id": { "type": "string" }, "removed": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/settings/snapshots": { "get": { "summary": "Snapshot-Einstellungen", "tags": [ "Snapshots" ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "on_close", "per_profile" ], "properties": { "on_close": { "type": "boolean" }, "per_profile": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "put": { "summary": "Snapshot beim Schließen ein-/ausschalten und Anzahl je Profil (1–20) festlegen", "tags": [ "Snapshots" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "on_close": { "type": "boolean" }, "per_profile": { "type": "integer", "minimum": 1, "maximum": 20 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "settings:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "on_close", "per_profile" ], "properties": { "on_close": { "type": "boolean" }, "per_profile": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/package/export": { "post": { "summary": "Profile als verschlüsseltes .adbprofile-Paket exportieren (Argon2id + XChaCha20-Poly1305): Einstellungen, Konten, Proxy, Cookies neutral, Browserdaten ohne Cache; unterstützte Windows-DPAPI-Schlüssel werden im Paket übertragen und beim Import neu geschützt, App-Bound-Daten werden ausgelassen", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "ids", "password", "target_path" ], "properties": { "ids": { "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 }, "minItems": 1, "maxItems": 1000 }, "password": { "type": "string", "minLength": 12, "maxLength": 1024 }, "target_path": { "type": "string", "minLength": 4, "maxLength": 1024 }, "include_cookies": { "type": "boolean" }, "include_browser_data": { "type": "boolean" } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:read", "secrets:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "path", "size_bytes", "sha256", "profiles" ], "properties": { "path": { "type": "string" }, "size_bytes": { "type": "integer" }, "sha256": { "type": "string" }, "profiles": { "type": "array", "items": { "type": "object", "required": [ "id", "no", "name", "cookies", "files", "warnings" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "name": { "type": "string" }, "cookies": { "type": [ "null", "integer" ] }, "files": { "type": "integer" }, "warnings": { "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" } } } } } } }, "/api/v1/profiles/package/preview": { "post": { "summary": "Inhalt eines .adbprofile-Pakets oder .adbbackup-Vollbackups anzeigen und bereits vorhandene Profile erkennen (ohne etwas einzuspielen)", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "path", "password" ], "properties": { "path": { "type": "string", "minLength": 4, "maxLength": 1024 }, "password": { "type": "string", "minLength": 1, "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "kind", "created_at", "workflows", "profiles" ], "properties": { "kind": { "type": "string" }, "created_at": { "type": "string" }, "workflows": { "type": "integer" }, "profiles": { "type": "array", "items": { "type": "object", "required": [ "id", "no", "name", "existing" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "name": { "type": "string" }, "existing": { "anyOf": [ { "type": "object", "required": [ "id", "no", "name" ], "properties": { "id": { "type": "string" }, "no": { "type": "integer" }, "name": { "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" } } } } } } }, "/api/v1/profiles/package/import": { "post": { "summary": "Profile aus einem .adbprofile-Paket oder .adbbackup-Vollbackup importieren: neue ID und Nr., Fingerprint-Seeds erhalten, Cookies über den Browser eingespielt; on_conflict: new (Standard), skip oder replace (vorhandenes Profil in den Papierkorb)", "tags": [ "Import/Export" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "path", "password" ], "properties": { "path": { "type": "string", "minLength": 4, "maxLength": 1024 }, "password": { "type": "string", "minLength": 1, "maxLength": 1024 }, "on_conflict": { "anyOf": [ { "type": "string", "enum": [ "new" ] }, { "type": "string", "enum": [ "skip" ] }, { "type": "string", "enum": [ "replace" ] } ] }, "decisions": { "type": "object", "additionalProperties": { "anyOf": [ { "type": "string", "enum": [ "new" ] }, { "type": "string", "enum": [ "skip" ] }, { "type": "string", "enum": [ "replace" ] } ] } } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "kind", "results", "restored" ], "properties": { "kind": { "type": "string" }, "results": { "type": "array", "items": { "type": "object", "required": [ "source_no", "source_name", "status", "id", "no", "warnings", "error" ], "properties": { "source_no": { "type": "integer" }, "source_name": { "type": "string" }, "status": { "type": "string" }, "id": { "type": [ "null", "string" ] }, "no": { "type": [ "null", "integer" ] }, "warnings": { "type": "array", "items": { "type": "string" } }, "error": { "type": [ "null", "string" ] } } } }, "restored": { "anyOf": [ { "type": "object", "required": [ "proxies", "groups", "tags", "extensions", "extension_sets", "workflows", "warnings" ], "properties": { "proxies": { "type": "integer" }, "groups": { "type": "integer" }, "tags": { "type": "integer" }, "extensions": { "type": "integer" }, "extension_sets": { "type": "integer" }, "workflows": { "type": "integer" }, "warnings": { "type": "array", "items": { "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" } } } } } } }, "/api/v1/maintenance/orphans": { "get": { "summary": "Unbekannte Profilordner: Ordner im Profilbereich ohne Datenbankeintrag (z. B. nach Wiederherstellung einer älteren Datenbanksicherung)", "tags": [ "Wartung" ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "folder_key", "modified_at", "size_bytes", "has_mirror", "profile" ], "properties": { "folder_key": { "type": "string" }, "modified_at": { "type": "integer" }, "size_bytes": { "type": "integer" }, "has_mirror": { "type": "boolean" }, "profile": { "anyOf": [ { "type": "object", "required": [ "id", "no", "name", "group", "engine", "engine_version", "updated_at" ], "properties": { "id": { "type": [ "string", "null" ] }, "no": { "type": [ "integer", "null" ] }, "name": { "type": [ "string", "null" ] }, "group": { "type": [ "string", "null" ] }, "engine": { "type": [ "string", "null" ] }, "engine_version": { "type": [ "string", "null" ] }, "updated_at": { "type": [ "integer", "null" ] } } }, { "type": "null" } ] } } } } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/maintenance/orphans/import": { "post": { "summary": "Unbekannte Profilordner über profile.json wieder als Profile aufnehmen (Nr. und Kurz-ID bleiben, wenn frei; Geheimnisse müssen neu gesetzt werden)", "tags": [ "Wartung" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "folder_keys" ], "properties": { "folder_keys": { "type": "array", "items": { "type": "string", "pattern": "^[0-9A-Z]{12}$" }, "minItems": 1, "maxItems": 500 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "folder_key", "ok", "id", "no", "warnings", "error" ], "properties": { "folder_key": { "type": "string" }, "ok": { "type": "boolean" }, "id": { "type": [ "null", "string" ] }, "no": { "type": [ "null", "integer" ] }, "warnings": { "type": "array", "items": { "type": "string" } }, "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" } } } } } } }, "/api/v1/maintenance/orphans/delete": { "post": { "summary": "Unbekannte Profilordner endgültig löschen (confirm_count muss der Anzahl entsprechen)", "tags": [ "Wartung" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "folder_keys", "confirm_count" ], "properties": { "folder_keys": { "type": "array", "items": { "type": "string", "pattern": "^[0-9A-Z]{12}$" }, "minItems": 1, "maxItems": 500 }, "confirm_count": { "type": "integer", "minimum": 1 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "trash:manage" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "results" ], "properties": { "results": { "type": "array", "items": { "type": "object", "required": [ "folder_key", "ok", "id", "no", "warnings", "error" ], "properties": { "folder_key": { "type": "string" }, "ok": { "type": "boolean" }, "id": { "type": [ "null", "string" ] }, "no": { "type": [ "null", "integer" ] }, "warnings": { "type": "array", "items": { "type": "string" } }, "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" } } } } } } }, "/api/v1/storage/move/check": { "post": { "summary": "Zielordner für das Verschieben der Datenwurzel prüfen (lokal, leer, beschreibbar, genug Platz); das Verschieben selbst startet die Manager-App bei beendetem Core", "tags": [ "Wartung" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "target" ], "properties": { "target": { "type": "string", "minLength": 3, "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "size_bytes", "required_bytes", "free_bytes", "running_profiles" ], "properties": { "size_bytes": { "type": "integer" }, "required_bytes": { "type": "integer" }, "free_bytes": { "type": "integer" }, "running_profiles": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/storage/previous-root": { "get": { "summary": "Alte Datenwurzel nach dem Verschieben (bleibt bis zur Bestätigung erhalten)", "tags": [ "Wartung" ], "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "previous" ], "properties": { "previous": { "anyOf": [ { "type": "object", "required": [ "path", "exists", "size_bytes" ], "properties": { "path": { "type": "string" }, "exists": { "type": "boolean" }, "size_bytes": { "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" } } } } } } }, "/api/v1/storage/previous-root/delete": { "post": { "summary": "Alte Datenwurzel löschen (path muss der gemeldeten alten Datenwurzel entsprechen)", "tags": [ "Wartung" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "path" ], "properties": { "path": { "type": "string", "minLength": 3, "maxLength": 1024 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "admin" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "removed" ], "properties": { "removed": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profile-templates": { "get": { "summary": "Benannte Vorlagen für neue Profile („Mehrere erstellen“, quick-create mit template_id)", "tags": [ "Profile" ], "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "items" ], "properties": { "items": { "type": "array", "items": { "type": "object", "required": [ "id", "name", "name_pattern", "template", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "name_pattern": { "type": [ "null", "string" ] }, "template": { "type": "object", "additionalProperties": {} }, "created_at": { "type": "integer" }, "updated_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": { "summary": "Vorlage anlegen (Felder wie beim Anlegen eines Profils, ohne Name, Proxy und Konten)", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "template" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "name_pattern": { "type": [ "string", "null" ], "maxLength": 100 }, "template": { "type": "object", "properties": { "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 }, "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": {} }, "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" } }, "cache_dir_override": { "type": [ "string", "null" ], "maxLength": 512 }, "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 } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "name_pattern", "template", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "name_pattern": { "type": [ "null", "string" ] }, "template": { "type": "object", "additionalProperties": {} }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profile-templates/from-profile": { "post": { "summary": "Vorlage aus den Einstellungen eines Profils erzeugen (ohne Name, Notiz, Fingerabdruck, Proxy, Konten)", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "profile_id", "name" ], "properties": { "profile_id": { "type": "string", "minLength": 1, "maxLength": 64 }, "name": { "type": "string", "minLength": 1, "maxLength": 100 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:write" ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "name", "name_pattern", "template", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "name_pattern": { "type": [ "null", "string" ] }, "template": { "type": "object", "additionalProperties": {} }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profile-templates/{id}": { "put": { "summary": "Vorlage ändern", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 100 }, "name_pattern": { "type": [ "string", "null" ], "maxLength": 100 }, "template": { "type": "object", "properties": { "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 }, "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": {} }, "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" } }, "cache_dir_override": { "type": [ "string", "null" ], "maxLength": 512 }, "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 } }, "additionalProperties": false } }, "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": [ "id", "name", "name_pattern", "template", "created_at", "updated_at" ], "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "name_pattern": { "type": [ "null", "string" ] }, "template": { "type": "object", "additionalProperties": {} }, "created_at": { "type": "integer" }, "updated_at": { "type": "integer" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } }, "delete": { "summary": "Vorlage löschen", "tags": [ "Profile" ], "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": [ "id", "removed" ], "properties": { "id": { "type": "string" }, "removed": { "type": "boolean" } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/windows/uniform": { "post": { "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" } } } } } } }, "/api/v1/displays": { "get": { "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" } } } } } } }, "/api/v1/windows/arrange": { "post": { "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" } } } } } } }, "/api/v1/windows/{id}/bounds": { "post": { "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" } } } } } } }, "/api/v1/fingerprint/preview": { "post": { "summary": "Fingerprint-Entwurf erzeugen und prüfen, ohne ein Profil zu speichern", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "engine", "os", "fingerprint_overrides" ], "properties": { "engine": { "anyOf": [ { "type": "string", "enum": [ "chromium" ] }, { "type": "string", "enum": [ "firefox" ] } ] }, "os": { "anyOf": [ { "type": "string", "enum": [ "windows" ] }, { "type": "string", "enum": [ "macos" ] }, { "type": "string", "enum": [ "linux" ] }, { "type": "string", "enum": [ "android" ] }, { "type": "string", "enum": [ "ios" ] } ] }, "engine_version": { "type": "string", "maxLength": 16 }, "engine_auto_update": { "type": "boolean" }, "os_version": { "type": [ "string", "null" ], "maxLength": 32 }, "user_agent": { "type": [ "string", "null" ], "maxLength": 512 }, "fingerprint_overrides": { "type": "object", "additionalProperties": {} }, "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 } }, "additionalProperties": false } } } }, "x-required-scopes": [ "profiles:read" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "fingerprint", "issues", "host", "seeds", "user_agent", "kernel_version" ], "properties": { "fingerprint": { "type": "object", "required": [ "reference", "fonts", "hardware_concurrency", "device_memory", "screen", "webgl", "noise" ], "properties": { "reference": { "type": "integer" }, "fonts": { "type": "object", "required": [ "mode", "families" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "families": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } } }, "hardware_concurrency": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "type": "number" } } }, "device_memory": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "type": "number" } } }, "screen": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "anyOf": [ { "type": "object", "required": [ "width", "height", "avail_width", "avail_height", "color_depth", "pixel_ratio" ], "properties": { "width": { "type": "integer" }, "height": { "type": "integer" }, "avail_width": { "type": "integer" }, "avail_height": { "type": "integer" }, "color_depth": { "type": "integer" }, "pixel_ratio": { "type": "number" } } }, { "type": "null" } ] } } }, "webgl": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "anyOf": [ { "type": "object", "required": [ "vendor", "renderer" ], "properties": { "vendor": { "type": "string" }, "renderer": { "type": "string" }, "architecture": { "type": [ "string", "null" ] }, "webgpu": { "type": "object", "required": [ "vendor", "device", "description" ], "properties": { "vendor": { "type": "string" }, "device": { "type": "string" }, "description": { "type": "string" } } } } }, { "type": "null" } ] } } }, "noise": { "type": "object", "required": [ "canvas", "webgl", "audio", "client_rects" ], "properties": { "canvas": { "type": "integer" }, "webgl": { "type": "integer" }, "audio": { "type": "integer" }, "client_rects": { "type": "integer" } } } } }, "issues": { "type": "array", "items": { "type": "object", "required": [ "field", "code", "severity", "message" ], "properties": { "field": { "type": "string" }, "code": { "type": "string" }, "severity": { "anyOf": [ { "type": "string", "enum": [ "error" ] }, { "type": "string", "enum": [ "warning" ] } ] }, "message": { "type": "string" } } } }, "host": { "type": "object", "required": [ "cores", "memory_gb", "gpu_vendor", "gpu_name", "screen" ], "properties": { "cores": { "type": "integer" }, "memory_gb": { "type": "integer" }, "gpu_vendor": { "type": [ "null", "string" ] }, "gpu_name": { "type": [ "null", "string" ] }, "screen": { "anyOf": [ { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "type": "integer" }, "height": { "type": "integer" } } }, { "type": "null" } ] } } }, "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 }, "user_agent": { "type": [ "null", "string" ] }, "kernel_version": { "type": [ "null", "string" ] } } } } } }, "default": { "description": "HTTP error envelope. The status and error.code identify the failure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/profiles/{id}/fingerprint/report": { "post": { "summary": "Fingerprint im laufenden Profil lokal messen und mit der Startkonfiguration vergleichen", "tags": [ "Profile" ], "parameters": [ { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "path", "name": "id", "required": true } ], "x-required-scopes": [ "profiles:read", "runtime:control" ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "required": [ "profile_id", "session_id", "measured_at", "kernel", "passed", "failed", "skipped", "checks", "limitations" ], "properties": { "profile_id": { "type": "string" }, "session_id": { "type": "string" }, "measured_at": { "type": "number" }, "kernel": { "type": "string" }, "passed": { "type": "integer" }, "failed": { "type": "integer" }, "skipped": { "type": "integer" }, "checks": { "type": "array", "items": { "type": "object", "required": [ "id", "label", "status", "expected", "actual" ], "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "status": { "anyOf": [ { "type": "string", "enum": [ "pass" ] }, { "type": "string", "enum": [ "fail" ] }, { "type": "string", "enum": [ "skip" ] } ] }, "expected": { "type": "string" }, "actual": { "type": "string" } } } }, "limitations": { "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" } } } } } } }, "/api/v1/profiles/{id}/fingerprint": { "get": { "summary": "Aufgelöster Fingerprint eines Profils (Werte, die der Kern beim Start erhält) mit Konsistenzprüfung", "tags": [ "Profile" ], "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": [ "fingerprint", "issues", "host" ], "properties": { "fingerprint": { "type": "object", "required": [ "reference", "fonts", "hardware_concurrency", "device_memory", "screen", "webgl", "noise" ], "properties": { "reference": { "type": "integer" }, "fonts": { "type": "object", "required": [ "mode", "families" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "families": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } } }, "hardware_concurrency": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "type": "number" } } }, "device_memory": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "type": "number" } } }, "screen": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "anyOf": [ { "type": "object", "required": [ "width", "height", "avail_width", "avail_height", "color_depth", "pixel_ratio" ], "properties": { "width": { "type": "integer" }, "height": { "type": "integer" }, "avail_width": { "type": "integer" }, "avail_height": { "type": "integer" }, "color_depth": { "type": "integer" }, "pixel_ratio": { "type": "number" } } }, { "type": "null" } ] } } }, "webgl": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "anyOf": [ { "type": "object", "required": [ "vendor", "renderer" ], "properties": { "vendor": { "type": "string" }, "renderer": { "type": "string" }, "architecture": { "type": [ "string", "null" ] }, "webgpu": { "type": "object", "required": [ "vendor", "device", "description" ], "properties": { "vendor": { "type": "string" }, "device": { "type": "string" }, "description": { "type": "string" } } } } }, { "type": "null" } ] } } }, "noise": { "type": "object", "required": [ "canvas", "webgl", "audio", "client_rects" ], "properties": { "canvas": { "type": "integer" }, "webgl": { "type": "integer" }, "audio": { "type": "integer" }, "client_rects": { "type": "integer" } } } } }, "issues": { "type": "array", "items": { "type": "object", "required": [ "field", "code", "severity", "message" ], "properties": { "field": { "type": "string" }, "code": { "type": "string" }, "severity": { "anyOf": [ { "type": "string", "enum": [ "error" ] }, { "type": "string", "enum": [ "warning" ] } ] }, "message": { "type": "string" } } } }, "host": { "type": "object", "required": [ "cores", "memory_gb", "gpu_vendor", "gpu_name", "screen" ], "properties": { "cores": { "type": "integer" }, "memory_gb": { "type": "integer" }, "gpu_vendor": { "type": [ "null", "string" ] }, "gpu_name": { "type": [ "null", "string" ] }, "screen": { "anyOf": [ { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "type": "integer" }, "height": { "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" } } } } } } }, "/api/v1/profiles/{id}/fingerprint/preview": { "post": { "summary": "Fingerprint mit geänderten Überschreibungen prüfen, ohne zu speichern", "tags": [ "Profile" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "fingerprint_overrides" ], "properties": { "fingerprint_overrides": { "type": "object", "additionalProperties": {} } }, "additionalProperties": false } } } }, "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": [ "fingerprint", "issues", "host" ], "properties": { "fingerprint": { "type": "object", "required": [ "reference", "fonts", "hardware_concurrency", "device_memory", "screen", "webgl", "noise" ], "properties": { "reference": { "type": "integer" }, "fonts": { "type": "object", "required": [ "mode", "families" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "families": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } } }, "hardware_concurrency": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "type": "number" } } }, "device_memory": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "type": "number" } } }, "screen": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "anyOf": [ { "type": "object", "required": [ "width", "height", "avail_width", "avail_height", "color_depth", "pixel_ratio" ], "properties": { "width": { "type": "integer" }, "height": { "type": "integer" }, "avail_width": { "type": "integer" }, "avail_height": { "type": "integer" }, "color_depth": { "type": "integer" }, "pixel_ratio": { "type": "number" } } }, { "type": "null" } ] } } }, "webgl": { "type": "object", "required": [ "mode", "value" ], "properties": { "mode": { "anyOf": [ { "type": "string", "enum": [ "auto" ] }, { "type": "string", "enum": [ "real" ] }, { "type": "string", "enum": [ "custom" ] } ] }, "value": { "anyOf": [ { "type": "object", "required": [ "vendor", "renderer" ], "properties": { "vendor": { "type": "string" }, "renderer": { "type": "string" }, "architecture": { "type": [ "string", "null" ] }, "webgpu": { "type": "object", "required": [ "vendor", "device", "description" ], "properties": { "vendor": { "type": "string" }, "device": { "type": "string" }, "description": { "type": "string" } } } } }, { "type": "null" } ] } } }, "noise": { "type": "object", "required": [ "canvas", "webgl", "audio", "client_rects" ], "properties": { "canvas": { "type": "integer" }, "webgl": { "type": "integer" }, "audio": { "type": "integer" }, "client_rects": { "type": "integer" } } } } }, "issues": { "type": "array", "items": { "type": "object", "required": [ "field", "code", "severity", "message" ], "properties": { "field": { "type": "string" }, "code": { "type": "string" }, "severity": { "anyOf": [ { "type": "string", "enum": [ "error" ] }, { "type": "string", "enum": [ "warning" ] } ] }, "message": { "type": "string" } } } }, "host": { "type": "object", "required": [ "cores", "memory_gb", "gpu_vendor", "gpu_name", "screen" ], "properties": { "cores": { "type": "integer" }, "memory_gb": { "type": "integer" }, "gpu_vendor": { "type": [ "null", "string" ] }, "gpu_name": { "type": [ "null", "string" ] }, "screen": { "anyOf": [ { "type": "object", "required": [ "width", "height" ], "properties": { "width": { "type": "integer" }, "height": { "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" } } } } } } } }, "servers": [ { "url": "http://127.0.0.1:47300" } ], "security": [ { "bearer": [] } ] }