POpostproxy
API Keys

Create API key

Creates an API key scoped to a profile group. The response is the only place the token is returned - store it immediately. Requires an account-wide API key; only scoped keys can be minted, so there is no API path to a second account-wide key. Keys are environment-bound: the target profile group must be in the caller's environment. Send an Idempotency-Key header to make the call safe to retry - a retried create returns the original key rather than minting a second one.

post/api/api_keys

Request

  • Base URL
    https://api.postproxy.dev
  • URL
    https://api.postproxy.dev/api/api_keys
  • Auth
    HTTP bearer

Request body

profile_group_idstring required

Profile group to scope the key to. Must belong to your account and match the caller's environment.

namestring

Label for the key, shown in the web app.

Response

The created key, token included (returned only here)

idstring

API key ID, used in the revoke URL.

namestring nullable

Label given to the key.

profile_group_idstring

The profile group the key is scoped to.

sandboxboolean

true for sandbox keys.

tokenstring

The secret bearer token. Returned only in the create response.

created_atstring date-time

Changes

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