Skip to main content
POST/api/public/v1/devices/{id}/adspower-api

devices.adspower_api.set

Turn the machine's AdsPower-compatible Local API (manifest adspower-8.9.23, loopback only, Browlix API key on every call) on or off.

Capability: device.manageCommand (idempotent)MCP tool: devices_adspower_api_set
View as Markdown

Parameters

NameTypeRequiredDescription
idpathstring (uuid)YesDevice id
command_idbodystring (uuid)YesClient-generated UUID for this command. Send the same id (and body) again to get the stored receipt instead of a second change; a different body under the same id is CONFLICT.
enabledbodybooleanYesServe the AdsPower-compatible Local API on this machine (loopback only)
portbodyintegerNoLocal port; AdsPower's default is 50325 (min 1024, max 65535) Default: `50325`.
expected_revisionbodyintegerNoDevice revision from devices.list; a stale value is CONFLICT (min 1, max 9007199254740991)

Examples

curl -X POST "https://browlix.com/api/public/v1/devices/<id>/adspower-api" \
  -H "Authorization: Bearer $BROWLIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"command_id":"<uuid>","enabled":true}'

Response

201 with { data, replayed: false, correlation_id } the first time; 200 with replayed: true when the same command_id and body come again.

The field list of this reply is not published yet; read data as JSON.

Errors

CodeHTTPRetryable
UNAUTHENTICATED401No
FORBIDDEN403No
RATE_LIMITED429Yes
VALIDATION_FAILED422No
NOT_FOUND404No
CONFLICT409No
OUTCOME_UNKNOWN202Yes
DEPENDENCY_UNAVAILABLE503Yes
UNKNOWN500No

Every error code and when to retry

All operations