/api/public/v1/profiles/{id}/cleanupprofiles.cleanup.run
Remove chosen browser data (cache, cookies, local_storage, indexed_db, service_workers, history, open_tabs) from every machine's copy and, with the next synced launch, from the stored copy. BUSY while open, SYNC_PENDING while a machine holds newer data.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
idpath | string (uuid) | Yes | Profile id |
command_idbody | string (uuid) | Yes | Client-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. |
categoriesbody | array<"cache" | "cookies" | "local_storage" | "indexed_db" | "service_workers" | "history" | "open_tabs"> | Yes | Browser data to remove; duplicates are ignored. Bookmarks, extensions, saved passwords and settings are never touched (min 1 items, max 7 items) |
Examples
curl -X POST "https://browlix.com/api/public/v1/profiles/<id>/cleanup" \
-H "Authorization: Bearer $BROWLIX_API_KEY" \
-H "Content-Type: application/json" \
-d '{"command_id":"<uuid>","categories":[]}'Response
201 with { data, replayed: false, correlation_id } the first time; 200 with replayed: true when the same command_id and body come again.
Errors
| Code | HTTP | Retryable |
|---|---|---|
| UNAUTHENTICATED | 401 | No |
| FORBIDDEN | 403 | No |
| RATE_LIMITED | 429 | Yes |
| VALIDATION_FAILED | 422 | No |
| NOT_FOUND | 404 | No |
| CONFLICT | 409 | No |
| OUTCOME_UNKNOWN | 202 | Yes |
| BUSY | 409 | Yes |
| SYNC_PENDING | 409 | Yes |
| DEPENDENCY_UNAVAILABLE | 503 | Yes |
| UNKNOWN | 500 | No |