Authentication

Generates an API key for the current user. Deprecated in favor of POST /api/auth/api-keys.

Generates, stores, and returns a new API key with the default expiration period for the user currently logged in.

Once created, you can then provide this API key in an Authorization: PL-API-KEY <Key> header in replacement of an X-PL-AUTH header.

get/api/auth/api-key/generate

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-key/generate/get.ts
A function with typed inputs. Its response is checked against the schema.

expireSecondsinteger nullable

Number of seconds until the key expires.

rolestring nullable

Role of the new key.

expirationinteger required

Expiration of the new key.

keystring required

New API key.

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