TabGeckoPATCH
/api/v1/profiles/batch
Edit multiple profiles; change only specified fields
Request#
POSIX shell · curl
curl --fail-with-body --request PATCH \
"$ADBR_API_URL/api/v1/profiles/batch" \
-H "Authorization: Bearer $ADBR_API_TOKEN" \
-H "Content-Type: application/json" \
--data @request.jsonUse the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.
Authentication and permissions#
Authentication: Bearer token
Scopes: profiles:write
All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.
Parameters#
No path or query parameters declared.
Request body#
Required.
| Field | Type | Required | Description |
|---|---|---|---|
ids | array | Yes | |
patch | object | Yes |
Complete body schema
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"
]
},
"proxy_group_id": {
"type": [
"string",
"null"
],
"maxLength": 64
},
"ssh_host_key": {
"type": [
"string",
"null"
],
"pattern": "^SHA256:[A-Za-z0-9+/]{43}$"
},
"protocol": {
"anyOf": [
{
"type": "string",
"enum": [
"http"
]
},
{
"type": "string",
"enum": [
"https"
]
},
{
"type": "string",
"enum": [
"socks4"
]
},
{
"type": "string",
"enum": [
"socks4a"
]
},
{
"type": "string",
"enum": [
"socks5"
]
},
{
"type": "string",
"enum": [
"socks5h"
]
},
{
"type": "string",
"enum": [
"ssh"
]
}
]
},
"host": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"username": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"password": {
"type": [
"string",
"null"
],
"maxLength": 1024
}
},
"additionalProperties": false
},
"ip_checker": {
"type": [
"string",
"null"
],
"maxLength": 32
},
"browser_options": {
"type": "object",
"properties": {
"block_images": {
"type": "boolean"
},
"block_video": {
"type": "boolean"
},
"block_audio": {
"type": "boolean"
},
"block_notifications": {
"type": "boolean"
},
"block_password_view": {
"type": "boolean"
},
"block_password_save": {
"type": "boolean"
},
"block_extension_pages": {
"type": "boolean"
},
"block_translation": {
"type": "boolean"
},
"block_devtools": {
"type": "boolean"
},
"local_network": {
"type": "object",
"required": [
"blocked",
"allowed_ports"
],
"properties": {
"blocked": {
"type": "boolean"
},
"allowed_ports": {
"type": "string",
"maxLength": 1536
}
},
"additionalProperties": false
},
"taskbar_icon": {
"anyOf": [
{
"type": "string",
"minLength": 50,
"maxLength": 393216
},
{
"type": "null"
}
]
},
"ui_language": {
"anyOf": [
{
"type": "string",
"minLength": 2,
"maxLength": 35
},
{
"type": "null"
}
]
},
"tls_cipher_blocklist": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "null"
}
]
},
"secure_dns": {
"anyOf": [
{
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"off"
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mode",
"server"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"secure"
]
},
"server": {
"type": "string",
"minLength": 9,
"maxLength": 2048
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"net": {
"type": "object",
"additionalProperties": {}
},
"start_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"new_tab"
]
},
{
"type": "string",
"enum": [
"last_tabs"
]
},
{
"type": "string",
"enum": [
"urls"
]
},
{
"type": "string",
"enum": [
"last_and_urls"
]
}
]
},
"start_urls": {
"type": "array",
"items": {
"type": "string",
"maxLength": 2048
},
"maxItems": 20
},
"open_account_pages": {
"type": "boolean"
},
"homepage": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"launch_args": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1024
},
"maxItems": 100
},
"extension_set_id": {
"type": [
"string",
"null"
]
},
"storage_options": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"clear_on_close": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"cache_dir_override": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"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
},
"id": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"maxItems": 50
},
"replace_fingerprint_overrides": {
"type": "boolean"
},
"local_network_allowed_ports": {
"type": "string",
"maxLength": 1536
},
"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
}
}
}
}Responses#
200 · Default response
OpenAPI JSON
{
"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 · HTTP error envelope. The status and error.code identify the failure.
OpenAPI JSON
{
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}General authentication and transport errors may occur in addition to the documented responses.
OpenAPI definition#
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"
]
},
"proxy_group_id": {
"type": [
"string",
"null"
],
"maxLength": 64
},
"ssh_host_key": {
"type": [
"string",
"null"
],
"pattern": "^SHA256:[A-Za-z0-9+/]{43}$"
},
"protocol": {
"anyOf": [
{
"type": "string",
"enum": [
"http"
]
},
{
"type": "string",
"enum": [
"https"
]
},
{
"type": "string",
"enum": [
"socks4"
]
},
{
"type": "string",
"enum": [
"socks4a"
]
},
{
"type": "string",
"enum": [
"socks5"
]
},
{
"type": "string",
"enum": [
"socks5h"
]
},
{
"type": "string",
"enum": [
"ssh"
]
}
]
},
"host": {
"type": "string",
"minLength": 1,
"maxLength": 255
},
"port": {
"type": "integer",
"minimum": 1,
"maximum": 65535
},
"username": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"password": {
"type": [
"string",
"null"
],
"maxLength": 1024
}
},
"additionalProperties": false
},
"ip_checker": {
"type": [
"string",
"null"
],
"maxLength": 32
},
"browser_options": {
"type": "object",
"properties": {
"block_images": {
"type": "boolean"
},
"block_video": {
"type": "boolean"
},
"block_audio": {
"type": "boolean"
},
"block_notifications": {
"type": "boolean"
},
"block_password_view": {
"type": "boolean"
},
"block_password_save": {
"type": "boolean"
},
"block_extension_pages": {
"type": "boolean"
},
"block_translation": {
"type": "boolean"
},
"block_devtools": {
"type": "boolean"
},
"local_network": {
"type": "object",
"required": [
"blocked",
"allowed_ports"
],
"properties": {
"blocked": {
"type": "boolean"
},
"allowed_ports": {
"type": "string",
"maxLength": 1536
}
},
"additionalProperties": false
},
"taskbar_icon": {
"anyOf": [
{
"type": "string",
"minLength": 50,
"maxLength": 393216
},
{
"type": "null"
}
]
},
"ui_language": {
"anyOf": [
{
"type": "string",
"minLength": 2,
"maxLength": 35
},
{
"type": "null"
}
]
},
"tls_cipher_blocklist": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "null"
}
]
},
"secure_dns": {
"anyOf": [
{
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"off"
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mode",
"server"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"secure"
]
},
"server": {
"type": "string",
"minLength": 9,
"maxLength": 2048
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"net": {
"type": "object",
"additionalProperties": {}
},
"start_mode": {
"anyOf": [
{
"type": "string",
"enum": [
"new_tab"
]
},
{
"type": "string",
"enum": [
"last_tabs"
]
},
{
"type": "string",
"enum": [
"urls"
]
},
{
"type": "string",
"enum": [
"last_and_urls"
]
}
]
},
"start_urls": {
"type": "array",
"items": {
"type": "string",
"maxLength": 2048
},
"maxItems": 20
},
"open_account_pages": {
"type": "boolean"
},
"homepage": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"launch_args": {
"type": "array",
"items": {
"type": "string",
"maxLength": 1024
},
"maxItems": 100
},
"extension_set_id": {
"type": [
"string",
"null"
]
},
"storage_options": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"clear_on_close": {
"type": "object",
"additionalProperties": {
"type": "boolean"
}
},
"cache_dir_override": {
"type": [
"string",
"null"
],
"maxLength": 512
},
"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
},
"id": {
"type": "string",
"minLength": 1
}
},
"additionalProperties": false
},
"maxItems": 50
},
"replace_fingerprint_overrides": {
"type": "boolean"
},
"local_network_allowed_ports": {
"type": "string",
"maxLength": 1536
},
"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"
}
}
}
}
}
}