Skip to main content
PATCH
Rotate a saved scan account

Authorizations

X-API-Key
string
header
required

API key for authentication

Headers

X-Organization-Id
string

Organization ID (required for session auth, optional for API key auth)

Path Parameters

id
string
required

Body

application/json
label
string

New label for the account.

Maximum string length: 40
kind
enum<string>

Kind of the account already stored. Optional, and only an assertion: it must equal the kind the account was saved with, because changing an account's kind in place is not supported — save a new account instead. Material must match that kind: 'cookie' takes value, 'headers' takes headers.

Available options:
cookie,
headers
value
string

New raw Cookie header value, replacing the stored one. Only for a cookie account — sending it to a headers account is refused, never ignored. Omit all material to relabel the account instead. Never echoed back.

Maximum string length: 8192
headers
object[]

New header set to replay, replacing the stored one. Only for a headers account — sending it to a cookie account is refused, never ignored. Omit all material to relabel the account instead. Never echoed back.

role
string

Role this account represents in the app. Reporting metadata only — the scan never enforces it.

Maximum string length: 40
tenant
string

Tenant or workspace the account belongs to. Reporting metadata only — the scan never enforces it.

Maximum string length: 60
targetUrl
string

URL the new credential is probed against, required only when material is sent. A relabel sends no material, so it contacts no target and never sends the stored credential anywhere.

Example:

"https://app.example.com"

Response

Updated scan account

id
string
required

Saved account id.

Example:

"psa_abc123"

label
string
required

Customer-facing account name.

Example:

"auditor"

kind
enum<string>
required

How the credential travels: 'cookie' or 'headers'. The credential itself is never returned.

Available options:
cookie,
headers
createdAt
string<date-time>
required

When the account was saved.

role
string | null

Role this account represents. Reporting metadata only.

tenant
string | null

Tenant or workspace this account belongs to.

lastVerifiedAt
string<date-time> | null

When the credential last passed a probe against a target. Null when a probe has never verified it.

revokedAt
string<date-time> | null

When the account was deleted. Deleted accounts cannot be used by a scan.