TabGeckoProfiles · API
Generated from the OpenAPI snapshot. Source summaries remain unchanged; JSON schemas below are the exact exported definitions.
GET /api/v1/profiles
Profile suchen, filtern, sortieren und seitenweise abrufen
Authentication: bearer token
Required route scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
page | query | No | |
limit | query | No | |
cursor | query | No | |
search | query | No | |
ids | query | No | Kommagetrennte Profil-IDs |
group_id | query | No | |
tag_ids | query | No | Kommagetrennte Tag-IDs |
tag_mode | query | No | |
exclude_tag_ids | query | No | |
status_id | query | No | |
engine | query | No | |
os | query | No | |
runtime_state | query | No | |
pinned | query | No | |
proxy_id | query | No | |
sort | query | No | |
order | query | No | |
pinned_first | query | No |
Full parameter schemas
OpenAPI JSON
[
{
"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
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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 /api/v1/profiles
Profil anlegen
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}POST /api/v1/profiles/batch
Mehrere Profile anlegen; Ergebnis je Eintrag
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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 /api/v1/profiles/batch
Mehrere Profile bearbeiten; nur angegebene Felder werden geändert
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}POST /api/v1/profiles/quick-create
Mehrere Profile nach Anzahl anlegen: Namensschema mit {NR}, {N}, {DATUM}, {LOGIN}, {ZUFALL:6}; eigener Fingerprint je Profil
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}POST /api/v1/profiles/batch/assign-group
Profile einer Gruppe zuordnen
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}GET /api/v1/profiles/by-no/{no}
Profil über die fortlaufende Nummer abrufen
Authentication: bearer token
Required route scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
no | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "integer",
"minimum": 1
},
"in": "path",
"name": "no",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}GET /api/v1/profiles/{id}
Profil mit Konten (Passwörter maskiert) abrufen
Authentication: bearer token
Required route scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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 /api/v1/profiles/{id}
Profil bearbeiten; Kern und Betriebssystem sind nach der Anlage fest
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}GET /api/v1/profiles/{id}/encryption
Zustand der Verschlüsselung ruhender Profildaten
Authentication: bearer token
Required route scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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 /api/v1/profiles/{id}/encryption
Verschlüsselung ruhender Profildaten ändern
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"enabled"
],
"properties": {
"enabled": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}POST /api/v1/profiles/{id}/encryption/rotate
Profilschlüssel erneuern und ruhende Dateien ohne Klartextkopie neu verschlüsseln
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"confirm"
],
"properties": {
"confirm": {
"type": "boolean",
"enum": [
true
]
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}POST /api/v1/profiles/batch/assign-proxy
Proxys zuweisen: ein Proxy für alle, der Reihe nach oder zufällig, optional nur unbenutzte
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}POST /api/v1/profiles/{id}/proxy/test
Gespeicherte Profilverbindung ohne Browserstart prüfen; Ausgangs-IP und Land bei unveränderter Konfiguration speichern
Authentication: bearer token
Required route scopes: profiles:write, proxies:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
ip_checker | query | No | |
detect_protocol | query | No | HTTP, HTTPS oder SOCKS5 mit gespeicherten Zugangsdaten erkennen; nur Vorschau, ohne Konfiguration oder Messstand zu ändern. |
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"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
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}POST /api/v1/profiles/{id}/clone
Profil klonen: neue ID und Nr.; Fingerprint neu (Standard) oder gleich; Cookies, Proxy, Konten und Browserdaten nur auf Wunsch
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}GET /api/v1/profile-templates
Benannte Vorlagen für neue Profile („Mehrere erstellen“, quick-create mit template_id)
Authentication: bearer token
Required route scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"items"
],
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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 /api/v1/profile-templates
Vorlage anlegen (Felder wie beim Anlegen eines Profils, ohne Name, Proxy und Konten)
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}POST /api/v1/profile-templates/from-profile
Vorlage aus den Einstellungen eines Profils erzeugen (ohne Name, Notiz, Fingerabdruck, Proxy, Konten)
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}PUT /api/v1/profile-templates/{id}
Vorlage ändern
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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 /api/v1/profile-templates/{id}
Vorlage löschen
Authentication: bearer token
Required route scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}POST /api/v1/fingerprint/preview
Fingerprint-Entwurf erzeugen und prüfen, ohne ein Profil zu speichern
Authentication: bearer token
Required route scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
No path or query parameters declared.
Request body · required
OpenAPI JSON
{
"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
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}POST /api/v1/profiles/{id}/fingerprint/report
Fingerprint im laufenden Profil lokal messen und mit der Startkonfiguration vergleichen
Authentication: bearer token
Required route scopes: profiles:read, runtime:control
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}GET /api/v1/profiles/{id}/fingerprint
Aufgelöster Fingerprint eines Profils (Werte, die der Kern beim Start erhält) mit Konsistenzprüfung
Authentication: bearer token
Required route scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]No request body declared.
Documented responses
OpenAPI JSON
{
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}POST /api/v1/profiles/{id}/fingerprint/preview
Fingerprint mit geänderten Überschreibungen prüfen, ohne zu speichern
Authentication: bearer token
Required route scopes: profiles:read
All listed scopes are required; admin satisfies scope checks. Request content, vault state and resource permissions can impose additional requirements.
| Name | Location | Required | Description |
|---|---|---|---|
id | path | Yes |
Full parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body · required
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"fingerprint_overrides"
],
"properties": {
"fingerprint_overrides": {
"type": "object",
"additionalProperties": {}
}
},
"additionalProperties": false
}
}
}
}Documented responses
OpenAPI JSON
{
"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"
}
}
}
}
}Complete operation definition
OpenAPI JSON
{
"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"
}
}
}
}
}
}