TabGeckoPOST
/api/v1/groups
Create a group
Request#
POSIX shell · curl
curl --fail-with-body --request POST \
"$ADBR_API_URL/api/v1/groups" \
-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#
| Parameter | Location | Required | Description |
|---|---|---|---|
operation_id | query | No |
Complete parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9-]{16,64}$"
},
"in": "query",
"name": "operation_id",
"required": false
}
]Request body#
Required.
| Field | Type | Required | Description |
|---|---|---|---|
accounts_enabled | boolean | No | |
browser_defaults | object | No | |
name | string | Yes | |
remark | string | null | No | |
color | string | null | No | |
sort_order | integer | No | |
pinned | boolean | No |
Complete body schema
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"accounts_enabled": {
"type": "boolean"
},
"browser_defaults": {
"type": "object",
"properties": {
"browser_options": {
"type": "object",
"properties": {
"block_images": {
"type": "boolean"
},
"block_video": {
"type": "boolean"
},
"block_audio": {
"type": "boolean"
},
"block_notifications": {
"type": "boolean"
},
"block_password_view": {
"type": "boolean"
},
"block_password_save": {
"type": "boolean"
},
"block_extension_pages": {
"type": "boolean"
},
"block_translation": {
"type": "boolean"
},
"block_devtools": {
"type": "boolean"
},
"local_network": {
"type": "object",
"required": [
"blocked",
"allowed_ports"
],
"properties": {
"blocked": {
"type": "boolean"
},
"allowed_ports": {
"type": "string",
"maxLength": 1536
}
},
"additionalProperties": false
},
"taskbar_icon": {
"anyOf": [
{
"type": "string",
"minLength": 50,
"maxLength": 393216
},
{
"type": "null"
}
]
},
"ui_language": {
"anyOf": [
{
"type": "string",
"minLength": 2,
"maxLength": 35
},
{
"type": "null"
}
]
},
"tls_cipher_blocklist": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "null"
}
]
},
"secure_dns": {
"anyOf": [
{
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"off"
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mode",
"server"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"secure"
]
},
"server": {
"type": "string",
"minLength": 9,
"maxLength": 2048
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"startup": {
"type": "object",
"required": [
"mode",
"urls"
],
"properties": {
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"new_tab"
]
},
{
"type": "string",
"enum": [
"last_tabs"
]
},
{
"type": "string",
"enum": [
"urls"
]
},
{
"type": "string",
"enum": [
"last_and_urls"
]
}
]
},
"urls": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 20
}
},
"additionalProperties": false
},
"launch_args": {
"type": "object",
"properties": {
"chromium": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 100
},
"firefox": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 100
}
},
"additionalProperties": false
},
"extension_sets": {
"type": "object",
"properties": {
"chromium": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
},
"firefox": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"bookmarks": {
"type": "array",
"items": {
"type": "object",
"required": [
"title",
"url",
"folder"
],
"properties": {
"title": {
"type": "string",
"maxLength": 512
},
"url": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"folder": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"maxItems": 1000
}
},
"additionalProperties": false
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"remark": {
"type": [
"string",
"null"
],
"maxLength": 1000
},
"color": {
"type": [
"string",
"null"
],
"maxLength": 32
},
"sort_order": {
"type": "integer"
},
"pinned": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
}Responses#
201 · Default response
OpenAPI JSON
{
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"accounts_enabled",
"account_count",
"browser_defaults",
"id",
"name",
"remark",
"color",
"sort_order",
"is_default",
"pinned",
"compat_group_id",
"profile_count",
"created_at",
"updated_at",
"row_version"
],
"properties": {
"accounts_enabled": {
"type": "boolean"
},
"account_count": {
"type": "integer"
},
"browser_defaults": {
"type": "object",
"properties": {
"browser_options": {
"type": "object",
"properties": {
"block_images": {
"type": "boolean"
},
"block_video": {
"type": "boolean"
},
"block_audio": {
"type": "boolean"
},
"block_notifications": {
"type": "boolean"
},
"block_password_view": {
"type": "boolean"
},
"block_password_save": {
"type": "boolean"
},
"block_extension_pages": {
"type": "boolean"
},
"block_translation": {
"type": "boolean"
},
"block_devtools": {
"type": "boolean"
},
"local_network": {
"type": "object",
"required": [
"blocked",
"allowed_ports"
],
"properties": {
"blocked": {
"type": "boolean"
},
"allowed_ports": {
"type": "string",
"maxLength": 1536
}
},
"additionalProperties": false
},
"taskbar_icon": {
"anyOf": [
{
"type": "string",
"minLength": 50,
"maxLength": 393216
},
{
"type": "null"
}
]
},
"ui_language": {
"anyOf": [
{
"type": "string",
"minLength": 2,
"maxLength": 35
},
{
"type": "null"
}
]
},
"tls_cipher_blocklist": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "null"
}
]
},
"secure_dns": {
"anyOf": [
{
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"off"
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mode",
"server"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"secure"
]
},
"server": {
"type": "string",
"minLength": 9,
"maxLength": 2048
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"startup": {
"type": "object",
"required": [
"mode",
"urls"
],
"properties": {
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"new_tab"
]
},
{
"type": "string",
"enum": [
"last_tabs"
]
},
{
"type": "string",
"enum": [
"urls"
]
},
{
"type": "string",
"enum": [
"last_and_urls"
]
}
]
},
"urls": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 20
}
},
"additionalProperties": false
},
"launch_args": {
"type": "object",
"properties": {
"chromium": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 100
},
"firefox": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 100
}
},
"additionalProperties": false
},
"extension_sets": {
"type": "object",
"properties": {
"chromium": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
},
"firefox": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"bookmarks": {
"type": "array",
"items": {
"type": "object",
"required": [
"title",
"url",
"folder"
],
"properties": {
"title": {
"type": "string",
"maxLength": 512
},
"url": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"folder": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"maxItems": 1000
}
},
"additionalProperties": false
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"remark": {
"type": [
"null",
"string"
]
},
"color": {
"type": [
"null",
"string"
]
},
"sort_order": {
"type": "integer"
},
"is_default": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"compat_group_id": {
"type": [
"null",
"string"
]
},
"profile_count": {
"type": "integer"
},
"created_at": {
"type": "integer"
},
"updated_at": {
"type": "integer"
},
"row_version": {
"type": "integer"
}
}
}
}
}
}default · 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": "Gruppe anlegen",
"tags": [
"Gruppen"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"name"
],
"properties": {
"accounts_enabled": {
"type": "boolean"
},
"browser_defaults": {
"type": "object",
"properties": {
"browser_options": {
"type": "object",
"properties": {
"block_images": {
"type": "boolean"
},
"block_video": {
"type": "boolean"
},
"block_audio": {
"type": "boolean"
},
"block_notifications": {
"type": "boolean"
},
"block_password_view": {
"type": "boolean"
},
"block_password_save": {
"type": "boolean"
},
"block_extension_pages": {
"type": "boolean"
},
"block_translation": {
"type": "boolean"
},
"block_devtools": {
"type": "boolean"
},
"local_network": {
"type": "object",
"required": [
"blocked",
"allowed_ports"
],
"properties": {
"blocked": {
"type": "boolean"
},
"allowed_ports": {
"type": "string",
"maxLength": 1536
}
},
"additionalProperties": false
},
"taskbar_icon": {
"anyOf": [
{
"type": "string",
"minLength": 50,
"maxLength": 393216
},
{
"type": "null"
}
]
},
"ui_language": {
"anyOf": [
{
"type": "string",
"minLength": 2,
"maxLength": 35
},
{
"type": "null"
}
]
},
"tls_cipher_blocklist": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "null"
}
]
},
"secure_dns": {
"anyOf": [
{
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"off"
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mode",
"server"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"secure"
]
},
"server": {
"type": "string",
"minLength": 9,
"maxLength": 2048
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"startup": {
"type": "object",
"required": [
"mode",
"urls"
],
"properties": {
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"new_tab"
]
},
{
"type": "string",
"enum": [
"last_tabs"
]
},
{
"type": "string",
"enum": [
"urls"
]
},
{
"type": "string",
"enum": [
"last_and_urls"
]
}
]
},
"urls": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 20
}
},
"additionalProperties": false
},
"launch_args": {
"type": "object",
"properties": {
"chromium": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 100
},
"firefox": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 100
}
},
"additionalProperties": false
},
"extension_sets": {
"type": "object",
"properties": {
"chromium": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
},
"firefox": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"bookmarks": {
"type": "array",
"items": {
"type": "object",
"required": [
"title",
"url",
"folder"
],
"properties": {
"title": {
"type": "string",
"maxLength": 512
},
"url": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"folder": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"maxItems": 1000
}
},
"additionalProperties": false
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 100
},
"remark": {
"type": [
"string",
"null"
],
"maxLength": 1000
},
"color": {
"type": [
"string",
"null"
],
"maxLength": 32
},
"sort_order": {
"type": "integer"
},
"pinned": {
"type": "boolean"
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"pattern": "^[a-zA-Z0-9-]{16,64}$"
},
"in": "query",
"name": "operation_id",
"required": false
}
],
"x-required-scopes": [
"profiles:write"
],
"responses": {
"201": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"accounts_enabled",
"account_count",
"browser_defaults",
"id",
"name",
"remark",
"color",
"sort_order",
"is_default",
"pinned",
"compat_group_id",
"profile_count",
"created_at",
"updated_at",
"row_version"
],
"properties": {
"accounts_enabled": {
"type": "boolean"
},
"account_count": {
"type": "integer"
},
"browser_defaults": {
"type": "object",
"properties": {
"browser_options": {
"type": "object",
"properties": {
"block_images": {
"type": "boolean"
},
"block_video": {
"type": "boolean"
},
"block_audio": {
"type": "boolean"
},
"block_notifications": {
"type": "boolean"
},
"block_password_view": {
"type": "boolean"
},
"block_password_save": {
"type": "boolean"
},
"block_extension_pages": {
"type": "boolean"
},
"block_translation": {
"type": "boolean"
},
"block_devtools": {
"type": "boolean"
},
"local_network": {
"type": "object",
"required": [
"blocked",
"allowed_ports"
],
"properties": {
"blocked": {
"type": "boolean"
},
"allowed_ports": {
"type": "string",
"maxLength": 1536
}
},
"additionalProperties": false
},
"taskbar_icon": {
"anyOf": [
{
"type": "string",
"minLength": 50,
"maxLength": 393216
},
{
"type": "null"
}
]
},
"ui_language": {
"anyOf": [
{
"type": "string",
"minLength": 2,
"maxLength": 35
},
{
"type": "null"
}
]
},
"tls_cipher_blocklist": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 256
},
{
"type": "null"
}
]
},
"secure_dns": {
"anyOf": [
{
"type": "object",
"required": [
"mode"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"off"
]
}
},
"additionalProperties": false
},
{
"type": "object",
"required": [
"mode",
"server"
],
"properties": {
"mode": {
"type": "string",
"enum": [
"secure"
]
},
"server": {
"type": "string",
"minLength": 9,
"maxLength": 2048
}
},
"additionalProperties": false
}
]
}
},
"additionalProperties": false
},
"startup": {
"type": "object",
"required": [
"mode",
"urls"
],
"properties": {
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"new_tab"
]
},
{
"type": "string",
"enum": [
"last_tabs"
]
},
{
"type": "string",
"enum": [
"urls"
]
},
{
"type": "string",
"enum": [
"last_and_urls"
]
}
]
},
"urls": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 20
}
},
"additionalProperties": false
},
"launch_args": {
"type": "object",
"properties": {
"chromium": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 100
},
"firefox": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"maxItems": 100
}
},
"additionalProperties": false
},
"extension_sets": {
"type": "object",
"properties": {
"chromium": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
},
"firefox": {
"anyOf": [
{
"type": "string",
"minLength": 1,
"maxLength": 100
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"bookmarks": {
"type": "array",
"items": {
"type": "object",
"required": [
"title",
"url",
"folder"
],
"properties": {
"title": {
"type": "string",
"maxLength": 512
},
"url": {
"type": "string",
"minLength": 1,
"maxLength": 2048
},
"folder": {
"anyOf": [
{
"type": "string",
"maxLength": 256
},
{
"type": "null"
}
]
}
},
"additionalProperties": false
},
"maxItems": 1000
}
},
"additionalProperties": false
},
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"remark": {
"type": [
"null",
"string"
]
},
"color": {
"type": [
"null",
"string"
]
},
"sort_order": {
"type": "integer"
},
"is_default": {
"type": "boolean"
},
"pinned": {
"type": "boolean"
},
"compat_group_id": {
"type": [
"null",
"string"
]
},
"profile_count": {
"type": "integer"
},
"created_at": {
"type": "integer"
},
"updated_at": {
"type": "integer"
},
"row_version": {
"type": "integer"
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}