API Keys

Regenerate API key

Issue a new key (a new id and secret) with the same name, environment, scopes and project, replacing this one. The old key stops working immediately. The new key lists the old one in replaced_key_ids, so its requests and usage stay with the integration.

post/api/v1/me/api-keys/{id}/regenerate

Request

  • Base URL: https://api.proof.holdings
  • URL: https://api.proof.holdings/api/v1/me/api-keys/{id}/regenerate
  • Auth: API key in cookie auth_token

Path parameters

idstring required

MongoDB ObjectId

Example:507f1f77bcf86cd799439011

Response

API key regenerated (the new key is shown only once)

idstring required

MongoDB ObjectId

keystring required

The full API key. Returned only in this response; it cannot be read again.

namestring required
prefixstring required
environment'production' | 'test' required
scopesstring[] required
profile_idstring required

MongoDB ObjectId

created_atstring date-time required
warningstring required

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "key": "pk_live_abc123...",
  "name": "Production Key",
  "prefix": "pk_live_",
  "environment": "production",
  "scopes": [
    "verifications:*"
  ],
  "profile_id": "507f1f77bcf86cd799439011",
  "warning": "Copy this key now. You will not be able to see it again."
}

Changes

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