PUT

/api/v1/settings/compat

Enable, disable, and configure the AdsPower-compatible interface

Request#

POSIX shell · curl

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

Use 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: settings: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
`enabled`	`boolean`	No
`port`	`integer`	No
`require_token`	`boolean`	No
`rate_limit`	`integer`	No

Complete body schema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "port": {
            "type": "integer",
            "minimum": 1024,
            "maximum": 65535
          },
          "require_token": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "rate_limit": {
            "type": "integer",
            "minimum": 0,
            "maximum": 100
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "enabled",
          "port",
          "require_token",
          "rate_limit",
          "running",
          "active_port"
        ],
        "properties": {
          "enabled": {
            "type": "boolean"
          },
          "port": {
            "type": "integer",
            "minimum": 1024,
            "maximum": 65535
          },
          "require_token": {
            "type": "boolean",
            "enum": [
              true
            ]
          },
          "rate_limit": {
            "type": "integer",
            "minimum": 0,
            "maximum": 100
          },
          "running": {
            "type": "boolean"
          },
          "active_port": {
            "type": [
              "null",
              "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": "AdsPower-kompatible Schnittstelle ein-/ausschalten und konfigurieren",
  "tags": [
    "AdsPower-Kompatibilität"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "enabled": {
              "type": "boolean"
            },
            "port": {
              "type": "integer",
              "minimum": 1024,
              "maximum": 65535
            },
            "require_token": {
              "type": "boolean",
              "enum": [
                true
              ]
            },
            "rate_limit": {
              "type": "integer",
              "minimum": 0,
              "maximum": 100
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "settings:write"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "enabled",
              "port",
              "require_token",
              "rate_limit",
              "running",
              "active_port"
            ],
            "properties": {
              "enabled": {
                "type": "boolean"
              },
              "port": {
                "type": "integer",
                "minimum": 1024,
                "maximum": 65535
              },
              "require_token": {
                "type": "boolean",
                "enum": [
                  true
                ]
              },
              "rate_limit": {
                "type": "integer",
                "minimum": 0,
                "maximum": 100
              },
              "running": {
                "type": "boolean"
              },
              "active_port": {
                "type": [
                  "null",
                  "integer"
                ]
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}