/profile/refresh
POST/profile/refresh
Replaces the state of an existing authentication profile in place. The "name" must already exist for the requesting token. Counts of any dropped or truncated entries are surfaced under "diagnostics".
Request
Body
- Schema
- Example (auto)
Name of the existing profile to refresh. Must already exist for the requesting token.
Pre-captured authentication state. Same shape as POST /profile/upload.
captureSettings object
Capture inputs this refresh ran with. Omit the key to leave the stored settings untouched — which is what an older CLI does. An object that survives validation REPLACES the stored one wholesale — it is not a patch, so a partial payload drops the members it omits.
An object that validates down to nothing — {}, or one carrying only
onlyDomains: [] / keepDomains: [] — is treated as if the key were omitted:
200, stored settings untouched. excludeDomains: [] is the deliberate exception:
it survives, so the payload DOES replace the stored object and drops every member
it omits. It records "captured with no exclusions", which a later flagless refresh
replays instead of re-reading the refreshing machine's own config.
Raw --browser value.
Raw --profile value.
Effective merged exclusion list, not just the --exclude-domain flags.
Normalized --only-domain hostnames, deduped and capped — not merged with local config.
Normalized --keep-domain hostnames, same normalization, no merge.
Whether --auto-fit was used.
Raw --password-store value. Linux only.
CLI version that produced these settings.
{
"name": "string",
"captureSettings": {
"browser": "string",
"profile": "string",
"excludeDomains": [
"string"
],
"onlyDomains": [
"string"
],
"keepDomains": [
"string"
],
"autoFit": true,
"passwordStore": "string",
"cliVersion": "string"
}
}
Responses
- 200
- 400
- 401
- 403
- 404
- 408
- 429
- 500
- 503
Schema
- Fields
- Example (auto)
- Array [
- ]
diagnostics objectrequired
Per-entry counts of cookies, origins, and IndexedDB items the server dropped or truncated before persisting. All zero on a clean refresh.
Cookies dropped because required fields were missing or wrong type.
Cookies dropped because their domain pointed at a private/internal host.
Origins dropped because they were malformed or non-http(s).
Origins dropped because they targeted a private/internal network.
Origins dropped because the per-profile cap was exceeded.
IndexedDB databases dropped because required fields were missing.
IndexedDB databases dropped because the per-origin cap was exceeded.
IndexedDB object-stores dropped because required fields were missing.
IndexedDB entries dropped because the per-store cap was exceeded.
localStorage entries dropped because names or values were not strings.
IndexedDB indexes dropped because required fields were malformed.
Unique profile identifier.
User-supplied profile name. Unique per token.
Number of cookies captured in the profile.
Number of distinct origins with stored localStorage or IndexedDB.
captureSettings objectrequired
Capture inputs the CLI used, or null for profiles not created by the CLI. The UI
derives no capture flag from these; it uses any non-empty object to stamp the CLI
badge and show a read-only summary, and reads browser/profile specifically to
decide whether its refresh command needs placeholders for them. The CLI reads the
rest itself and decides the exclusion behaviour from excludeDomains.
Raw --browser value.
Raw --profile value (source profile directory or display name).
Effective merged exclusion list. [] is meaningful — "captured with no
exclusions" — and distinct from absent, which means "unknown".
Normalized --only-domain hostnames, deduped and capped — not merged with local config.
Normalized --keep-domain hostnames, same normalization, no merge.
Whether --auto-fit was used.
Raw --password-store value. Linux only.
CLI version that produced these settings, for drift diagnosis.
domainAuth object[]required
Per-domain auth status + expiry for the saved logins in this profile, with status classified at read time (valid / expiring_soon / expired / unknown). Empty for profiles saved before this feature, until their next capture, upload, or refresh. Never contains a cookie value.
Per-domain auth status, computed at read time from a stored absolute expiry.
Possible values: [expired, expiring_soon, unknown, valid]
ISO timestamp of the last time this profile was applied to a session, or null if never used.
ISO timestamp of when the profile was created.
ISO timestamp of the last metadata change (e.g., rename).
{
"diagnostics": {
"skippedMalformedCookies": 0,
"skippedPrivateCookies": 0,
"skippedMalformedOrigins": 0,
"skippedPrivateOrigins": 0,
"truncatedOrigins": 0,
"skippedMalformedIdbDatabases": 0,
"truncatedIdbDatabases": 0,
"skippedMalformedIdbStores": 0,
"truncatedIdbEntries": 0,
"skippedMalformedLocalStorageEntries": 0,
"skippedMalformedIdbIndexes": 0
},
"id": "string",
"name": "string",
"cookieCount": 0,
"originCount": 0,
"captureSettings": {
"browser": "string",
"profile": "string",
"excludeDomains": [
"string"
],
"onlyDomains": [
"string"
],
"keepDomains": [
"string"
],
"autoFit": true,
"passwordStore": "string",
"cliVersion": "string"
},
"domainAuth": [
{
"domain": "string",
"status": "expired",
"expiresAt": "string"
}
],
"lastUsedAt": "string",
"createdAt": "string",
"updatedAt": "string"
}
The request contains errors or didn't properly encode content.
The request is missing, or contains bad, authorization credentials.
The request targets a destination that is not allowed.
Resource couldn't be found.
The request took has taken too long to process.
Too many requests are currently being processed.
An internal error occurred when handling the request.
Service is unavailable.