PUT

/api/v1/settings/runtime

Einstellungen für den Profilstart ändern

Anfrage#

POSIX-Shell · curl

curl --fail-with-body --request PUT \
  "$ADBR_API_URL/api/v1/settings/runtime" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Verwende 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: settings:write

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
`hardware_acceleration`	`boolean \| null`	Nein
`download_directory`	`string \| null`	Nein
`info_page`	`boolean`	Nein
`max_parallel_starts`	`integer`	Nein
`stop_timeout_ms`	`integer`	Nein
`proxy_check_timeout_ms`	`integer`	Nein
`max_running`	`integer`	Nein
`load_guard`	`boolean`	Nein
`background_priority`	`boolean`	Nein

Vollständiges Körperschema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "hardware_acceleration": {
            "type": [
              "boolean",
              "null"
            ]
          },
          "download_directory": {
            "type": [
              "string",
              "null"
            ],
            "minLength": 1,
            "maxLength": 1024
          },
          "info_page": {
            "type": "boolean"
          },
          "max_parallel_starts": {
            "type": "integer",
            "minimum": 1,
            "maximum": 20
          },
          "stop_timeout_ms": {
            "type": "integer",
            "minimum": 1000,
            "maximum": 120000
          },
          "proxy_check_timeout_ms": {
            "type": "integer",
            "minimum": 2000,
            "maximum": 30000
          },
          "max_running": {
            "type": "integer",
            "minimum": 0,
            "maximum": 500
          },
          "load_guard": {
            "type": "boolean"
          },
          "background_priority": {
            "type": "boolean"
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Antworten#

200 · Standardantwort

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "hardware_acceleration",
          "download_directory",
          "info_page",
          "max_parallel_starts",
          "stop_timeout_ms",
          "proxy_check_timeout_ms",
          "max_running",
          "load_guard",
          "background_priority"
        ],
        "properties": {
          "hardware_acceleration": {
            "type": [
              "null",
              "boolean"
            ]
          },
          "download_directory": {
            "type": [
              "null",
              "string"
            ],
            "minLength": 1,
            "maxLength": 1024
          },
          "info_page": {
            "type": "boolean"
          },
          "max_parallel_starts": {
            "type": "integer",
            "minimum": 1,
            "maximum": 20
          },
          "stop_timeout_ms": {
            "type": "integer",
            "minimum": 1000,
            "maximum": 120000
          },
          "proxy_check_timeout_ms": {
            "type": "integer",
            "minimum": 2000,
            "maximum": 30000
          },
          "max_running": {
            "type": "integer",
            "minimum": 0,
            "maximum": 500
          },
          "load_guard": {
            "type": "boolean"
          },
          "background_priority": {
            "type": "boolean"
          }
        }
      }
    }
  }
}

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": "Einstellungen für den Profilstart ändern",
  "tags": [
    "Laufzeit"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "hardware_acceleration": {
              "type": [
                "boolean",
                "null"
              ]
            },
            "download_directory": {
              "type": [
                "string",
                "null"
              ],
              "minLength": 1,
              "maxLength": 1024
            },
            "info_page": {
              "type": "boolean"
            },
            "max_parallel_starts": {
              "type": "integer",
              "minimum": 1,
              "maximum": 20
            },
            "stop_timeout_ms": {
              "type": "integer",
              "minimum": 1000,
              "maximum": 120000
            },
            "proxy_check_timeout_ms": {
              "type": "integer",
              "minimum": 2000,
              "maximum": 30000
            },
            "max_running": {
              "type": "integer",
              "minimum": 0,
              "maximum": 500
            },
            "load_guard": {
              "type": "boolean"
            },
            "background_priority": {
              "type": "boolean"
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "settings:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "hardware_acceleration",
              "download_directory",
              "info_page",
              "max_parallel_starts",
              "stop_timeout_ms",
              "proxy_check_timeout_ms",
              "max_running",
              "load_guard",
              "background_priority"
            ],
            "properties": {
              "hardware_acceleration": {
                "type": [
                  "null",
                  "boolean"
                ]
              },
              "download_directory": {
                "type": [
                  "null",
                  "string"
                ],
                "minLength": 1,
                "maxLength": 1024
              },
              "info_page": {
                "type": "boolean"
              },
              "max_parallel_starts": {
                "type": "integer",
                "minimum": 1,
                "maximum": 20
              },
              "stop_timeout_ms": {
                "type": "integer",
                "minimum": 1000,
                "maximum": 120000
              },
              "proxy_check_timeout_ms": {
                "type": "integer",
                "minimum": 2000,
                "maximum": 30000
              },
              "max_running": {
                "type": "integer",
                "minimum": 0,
                "maximum": 500
              },
              "load_guard": {
                "type": "boolean"
              },
              "background_priority": {
                "type": "boolean"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}