API Keys

Updates API key metadata. API key role may only be reduced.

patch/api/auth/api-keys/{apiKeyID}

Request

Base URL
https://passivelogic.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header X-PL-AUTH
- or API key in header Authorization: PL-API-KEY
- or API key in header PL-API-KEY
- or HTTP basic
TypeScript
https://skmtc.dev/passivelogic/apis/passivelogic-http-api/docs/api/auth/api-keys/:apiKeyID/patch.ts
A function with typed inputs. Its response is checked against the schema.

apiKeyIDstring required

rolestring nullable

Updated role. Roles may only be reduced. Options are read or readWrite.

namestring nullable

Updated label for the API key.

expirationstring date-time required

Expiration time.

namestring nullable

Optional API key label.

rolestring required

Role assigned to the API key. Options are read or readWrite.

idstring uuid required

Unique API key ID.

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