TabGeckoPATCH
/api/v1/automation/synchronizer/options
Synchronizer-Optionen ändern
Anfrage#
POSIX-Shell · curl
curl --fail-with-body --request PATCH \
"$ADBR_API_URL/api/v1/automation/synchronizer/options" \
-H "Authorization: Bearer $ADBR_API_TOKEN" \
-H "Content-Type: application/json" \
--data @request.jsonVerwende lokale Adresse und Token aus API & MCP. Ersetze Pfadplatzhalter wie {id} durch tatsächliche IDs. Erstelle request.json anhand des folgenden Körperschemas, bevor du den Befehl ausführst.
Authentifizierung und Rechte#
Authentifizierung: Bearer-Token
Scopes: runtime:control, sync:control
Alle aufgeführten Scopes sind erforderlich; admin erfüllt Scope-Prüfungen. Kontorechte, Anfrageinhalt, Tresorzustand und Ressourcenrechte können weitere Voraussetzungen setzen.
Parameter#
Keine Pfad- oder Query-Parameter deklariert.
Anfragekörper#
Erforderlich.
| Feld | Typ | Pflicht | Beschreibung |
|---|---|---|---|
mouse | boolean | Nein | |
keyboard | boolean | Nein | |
scroll | boolean | Nein | |
navigation | boolean | Nein | |
tabs | boolean | Nein | |
native_controls | boolean | Nein | |
extension_pages | boolean | Nein | |
delay_min_ms | integer | Nein | |
delay_max_ms | integer | Nein |
Vollständiges Körperschema
OpenAPI JSON
{
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mouse": {
"type": "boolean"
},
"keyboard": {
"type": "boolean"
},
"scroll": {
"type": "boolean"
},
"navigation": {
"type": "boolean"
},
"tabs": {
"type": "boolean"
},
"native_controls": {
"type": "boolean"
},
"extension_pages": {
"type": "boolean"
},
"delay_min_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
},
"delay_max_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
}
},
"additionalProperties": false
}
}
}
}Antworten#
200 · Standardantwort
OpenAPI JSON
{
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"running",
"source_id",
"follower_ids",
"mode",
"options",
"tabs",
"events",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"source_id": {
"type": [
"string",
"null"
]
},
"follower_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"element"
]
},
{
"type": "string",
"enum": [
"coordinates"
]
}
]
},
"options": {
"type": "object",
"required": [
"mouse",
"keyboard",
"scroll",
"navigation",
"tabs",
"native_controls",
"extension_pages",
"delay_min_ms",
"delay_max_ms"
],
"properties": {
"mouse": {
"type": "boolean"
},
"keyboard": {
"type": "boolean"
},
"scroll": {
"type": "boolean"
},
"navigation": {
"type": "boolean"
},
"tabs": {
"type": "boolean"
},
"native_controls": {
"type": "boolean"
},
"extension_pages": {
"type": "boolean"
},
"delay_min_ms": {
"type": "integer"
},
"delay_max_ms": {
"type": "integer"
}
}
},
"tabs": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
},
"events": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
}
}
}
}default · HTTP-Fehlerhülle. Status und error.code bezeichnen den Fehler.
OpenAPI JSON
{
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}Allgemeine Authentifizierungs- und Transportfehler können zusätzlich zu den dokumentierten Antworten auftreten.
OpenAPI-Definition#
Vollständige Operationsdefinition
OpenAPI JSON
{
"summary": "Synchronizer-Optionen ändern",
"tags": [
"Automation"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"mouse": {
"type": "boolean"
},
"keyboard": {
"type": "boolean"
},
"scroll": {
"type": "boolean"
},
"navigation": {
"type": "boolean"
},
"tabs": {
"type": "boolean"
},
"native_controls": {
"type": "boolean"
},
"extension_pages": {
"type": "boolean"
},
"delay_min_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
},
"delay_max_ms": {
"type": "integer",
"minimum": 0,
"maximum": 5000
}
},
"additionalProperties": false
}
}
}
},
"x-required-scopes": [
"runtime:control",
"sync:control"
],
"responses": {
"200": {
"description": "Default Response",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"running",
"source_id",
"follower_ids",
"mode",
"options",
"tabs",
"events",
"error"
],
"properties": {
"running": {
"type": "boolean"
},
"source_id": {
"type": [
"string",
"null"
]
},
"follower_ids": {
"type": "array",
"items": {
"type": "string"
}
},
"mode": {
"anyOf": [
{
"type": "string",
"enum": [
"element"
]
},
{
"type": "string",
"enum": [
"coordinates"
]
}
]
},
"options": {
"type": "object",
"required": [
"mouse",
"keyboard",
"scroll",
"navigation",
"tabs",
"native_controls",
"extension_pages",
"delay_min_ms",
"delay_max_ms"
],
"properties": {
"mouse": {
"type": "boolean"
},
"keyboard": {
"type": "boolean"
},
"scroll": {
"type": "boolean"
},
"navigation": {
"type": "boolean"
},
"tabs": {
"type": "boolean"
},
"native_controls": {
"type": "boolean"
},
"extension_pages": {
"type": "boolean"
},
"delay_min_ms": {
"type": "integer"
},
"delay_max_ms": {
"type": "integer"
}
}
},
"tabs": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"url"
],
"properties": {
"id": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
},
"events": {
"type": "integer"
},
"error": {
"type": [
"string",
"null"
]
}
}
}
}
}
},
"default": {
"description": "HTTP error envelope. The status and error.code identify the failure.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
}
}
}
}
}
}