Skip to main content
GET/api/public/v1/profiles/{id}/share

shares.preview

What a copy of this profile would carry: the committed revision it is pinned to, which data categories that revision holds, which ones your rights allow, and whether a machine can prepare it now.

Capability: share.manageMCP tool: shares_preview
View as Markdown

Parameters

NameTypeRequiredDescription
idpathstring (uuid)YesProfile id

Examples

curl "https://browlix.com/api/public/v1/profiles/<id>/share" \
  -H "Authorization: Bearer $BROWLIX_API_KEY"

Response

200 with { data, correlation_id }.

FieldTypeAlways presentDescription
dataobjectYes
data.profileobjectYes
data.profile.idstring (uuid)Yes
data.profile.namestringYes
data.profile.os"windows" | "linux"Yes
data.profile.network_modestringYes
data.profile.has_proxybooleanYes
data.revisionintegerYesLatest committed revision (0 = never synced: only the configuration can be shared) (min -9007199254740991, max 9007199254740991)
data.categoriesarray<"cookies" | "local_storage" | "indexed_db" | "service_workers" | "extensions" | "bookmarks" | "history" | "open_tabs" | …>YesCategories that revision holds
data.openbooleanYes
data.allowedobjectYes
data.allowed.sessionbooleanYes
data.allowed.saved_passwordsbooleanYes
data.machinesintegerYesMachines of this workspace whose worker can prepare a copy now (min -9007199254740991, max 9007199254740991)
correlation_idstring (uuid)Yes

New fields can appear at any time; ignore the ones you do not know.

Errors

CodeHTTPRetryable
UNAUTHENTICATED401No
FORBIDDEN403No
RATE_LIMITED429Yes
VALIDATION_FAILED422No
NOT_FOUND404No
DEPENDENCY_UNAVAILABLE503Yes
UNKNOWN500No

Every error code and when to retry

All operations