TabGeckoPOST
/api/v1/profiles/{id}/start
Start a profile: relay, proxy check, and kernel startup; optionally without API control
Request#
POSIX shell · curl
curl --fail-with-body --request POST \
"$ADBR_API_URL/api/v1/profiles/{id}/start" \
-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: runtime:control
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 |
|---|---|---|---|
id | path | Yes |
Complete parameter schemas
OpenAPI JSON
[
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
]Request body#
Required.
| Field | Type | Required | Description |
|---|---|---|---|
headless | boolean | No | Open the profile without a visible window for this start only; saved launch arguments are retained. |
automation | boolean | No | Enable API control (default: true); false opens a normal Windows profile window without a debug endpoint. |
info_page_language | union | No | |
skip_proxy_check | boolean | No | |
urls | array | No |
Complete body schema
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"headless": {
"type": "boolean",
"description": "Profil nur für diesen Start ohne sichtbares Fenster öffnen; gespeicherte Startargumente bleiben erhalten."
},
"automation": {
"type": "boolean",
"description": "API-Steuerung aktivieren (Standard: true); false öffnet ein normales Windows-Profilfenster ohne Debug-Endpunkt."
},
"info_page_language": {
"anyOf": [
{
"type": "string",
"enum": [
"de"
]
},
{
"type": "string",
"enum": [
"en"
]
}
]
},
"skip_proxy_check": {
"type": "boolean"
},
"urls": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"maxItems": 50
}
},
"additionalProperties": false
}
}
}
}Responses#
200 · Default response
OpenAPI JSON
{
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer",
"description": "Debug-Port; 0 bei normalem Profilfenster ohne API-Steuerung."
},
"ws_endpoint": {
"type": "string",
"description": "DevTools-Endpunkt; leer bei normalem Profilfenster ohne API-Steuerung."
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"null",
"string"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"null",
"integer"
]
},
"exit_ip": {
"type": [
"null",
"string"
]
},
"proxy_country": {
"type": [
"null",
"string"
]
},
"timezone": {
"type": [
"null",
"string"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
},
"timings": {
"type": "object",
"required": [
"request_id",
"profile_id",
"pid",
"outcome",
"total_ms",
"phases"
],
"properties": {
"request_id": {
"type": [
"null",
"string"
]
},
"profile_id": {
"type": "string"
},
"pid": {
"type": [
"null",
"integer"
]
},
"outcome": {
"anyOf": [
{
"type": "string",
"enum": [
"started"
]
},
{
"type": "string",
"enum": [
"failed"
]
},
{
"type": "string",
"enum": [
"cancelled"
]
}
]
},
"total_ms": {
"type": "integer",
"minimum": 0
},
"phases": {
"type": "object",
"properties": {
"api_request": {
"type": "integer",
"minimum": 0
},
"waiting_for_data": {
"type": "integer",
"minimum": 0
},
"waiting_for_capacity": {
"type": "integer",
"minimum": 0
},
"queued": {
"type": "integer",
"minimum": 0
},
"checking_account": {
"type": "integer",
"minimum": 0
},
"preparing_profile": {
"type": "integer",
"minimum": 0
},
"unlocking_profile": {
"type": "integer",
"minimum": 0
},
"preparing_browser": {
"type": "integer",
"minimum": 0
},
"maintenance_session": {
"type": "integer",
"minimum": 0
},
"checking_connection": {
"type": "integer",
"minimum": 0
},
"authorizing_start": {
"type": "integer",
"minimum": 0
},
"launching_browser": {
"type": "integer",
"minimum": 0
},
"connecting_debugger": {
"type": "integer",
"minimum": 0
},
"finalizing_start": {
"type": "integer",
"minimum": 0
},
"cleanup": {
"type": "integer",
"minimum": 0
},
"response": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"failed_phase": {
"type": "string"
},
"error_code": {
"type": "string"
}
},
"description": "Monotone Dauer je Startphase in Millisekunden für diesen Startaufruf. Nur erreichte Phasen sind enthalten."
}
}
}
}
}
}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": "Profil starten: Relay, Proxy-Prüfung, Kern-Start; optional ohne API-Steuerung",
"tags": [
"Laufzeit"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"headless": {
"type": "boolean",
"description": "Profil nur für diesen Start ohne sichtbares Fenster öffnen; gespeicherte Startargumente bleiben erhalten."
},
"automation": {
"type": "boolean",
"description": "API-Steuerung aktivieren (Standard: true); false öffnet ein normales Windows-Profilfenster ohne Debug-Endpunkt."
},
"info_page_language": {
"anyOf": [
{
"type": "string",
"enum": [
"de"
]
},
{
"type": "string",
"enum": [
"en"
]
}
]
},
"skip_proxy_check": {
"type": "boolean"
},
"urls": {
"type": "array",
"items": {
"type": "string",
"minLength": 1,
"maxLength": 4096
},
"maxItems": 50
}
},
"additionalProperties": false
}
}
}
},
"parameters": [
{
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 64
},
"in": "path",
"name": "id",
"required": true
}
],
"x-required-scopes": [
"runtime:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"profile_id",
"profile_no",
"session_id",
"pid",
"debug_port",
"ws_endpoint",
"http",
"webdriver",
"kernel",
"relay_port",
"exit_ip",
"proxy_country",
"timezone",
"languages",
"started_at"
],
"properties": {
"profile_id": {
"type": "string"
},
"profile_no": {
"type": "integer"
},
"session_id": {
"type": "string"
},
"pid": {
"type": "integer"
},
"debug_port": {
"type": "integer",
"description": "Debug-Port; 0 bei normalem Profilfenster ohne API-Steuerung."
},
"ws_endpoint": {
"type": "string",
"description": "DevTools-Endpunkt; leer bei normalem Profilfenster ohne API-Steuerung."
},
"http": {
"type": "string"
},
"webdriver": {
"type": [
"null",
"string"
]
},
"kernel": {
"type": "object",
"required": [
"engine",
"version",
"build",
"source"
],
"properties": {
"engine": {
"type": "string"
},
"version": {
"type": "string"
},
"build": {
"type": "string"
},
"source": {
"type": "string"
}
}
},
"relay_port": {
"type": [
"null",
"integer"
]
},
"exit_ip": {
"type": [
"null",
"string"
]
},
"proxy_country": {
"type": [
"null",
"string"
]
},
"timezone": {
"type": [
"null",
"string"
]
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"started_at": {
"type": "integer"
},
"timings": {
"type": "object",
"required": [
"request_id",
"profile_id",
"pid",
"outcome",
"total_ms",
"phases"
],
"properties": {
"request_id": {
"type": [
"null",
"string"
]
},
"profile_id": {
"type": "string"
},
"pid": {
"type": [
"null",
"integer"
]
},
"outcome": {
"anyOf": [
{
"type": "string",
"enum": [
"started"
]
},
{
"type": "string",
"enum": [
"failed"
]
},
{
"type": "string",
"enum": [
"cancelled"
]
}
]
},
"total_ms": {
"type": "integer",
"minimum": 0
},
"phases": {
"type": "object",
"properties": {
"api_request": {
"type": "integer",
"minimum": 0
},
"waiting_for_data": {
"type": "integer",
"minimum": 0
},
"waiting_for_capacity": {
"type": "integer",
"minimum": 0
},
"queued": {
"type": "integer",
"minimum": 0
},
"checking_account": {
"type": "integer",
"minimum": 0
},
"preparing_profile": {
"type": "integer",
"minimum": 0
},
"unlocking_profile": {
"type": "integer",
"minimum": 0
},
"preparing_browser": {
"type": "integer",
"minimum": 0
},
"maintenance_session": {
"type": "integer",
"minimum": 0
},
"checking_connection": {
"type": "integer",
"minimum": 0
},
"authorizing_start": {
"type": "integer",
"minimum": 0
},
"launching_browser": {
"type": "integer",
"minimum": 0
},
"connecting_debugger": {
"type": "integer",
"minimum": 0
},
"finalizing_start": {
"type": "integer",
"minimum": 0
},
"cleanup": {
"type": "integer",
"minimum": 0
},
"response": {
"type": "integer",
"minimum": 0
}
},
"additionalProperties": false
},
"failed_phase": {
"type": "string"
},
"error_code": {
"type": "string"
}
},
"description": "Monotone Dauer je Startphase in Millisekunden für diesen Startaufruf. Nur erreichte Phasen sind enthalten."
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}