API Keys

Create API key

Generate a new API key for the authenticated user

post/api/api-keys

Request

  • Base URL: https://api.zvid.io
  • URL: https://api.zvid.io/api/api-keys
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer

Request body

namestring required

Name for the API key

Example request

{
  "name": "Production API Key"
}

Response

API key created successfully

idinteger required
apiKeystring required

Full API key (only shown once)

namestring required
keyPrefixstring required

Stored prefix derived from the key

createdboolean required

Example response

{
  "id": 729,
  "apiKey": "zvid_1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "name": "Production API Key",
  "keyPrefix": "zvid_d3f4a1b2c3d",
  "created": true
}

Changes

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