Admin Remote access

patch/api/v2/admin/remote-clients/{clientId}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/admin/remote-clients/{clientId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie caplets_dashboard_session

Path parameters

clientIdstring required

Headers

Idempotency-Keystring required

Principal-scoped retry key. Reuse with the same validated request replays the finalized response.

If-Matchstring required

Strong ETag of the current resource. Required for an existing resource mutation.

X-Caplets-CSRFstring

Required for unsafe requests authenticated by a dashboard session cookie; optional and ignored for bearer authentication.

Response

Successful direct resource representation.

clientIdstring required
clientLabelstring required
role'access' | 'operator' required
hostUrlstring uri required
createdAtstring date-time required
generationinteger required
lastUsedAtstring date-time
revokedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.