API keys

Create an api key, the plaintext is returned once

post/api/v1/projects/{projectId}/api-keys

Request

  • Base URL: https://otprun.com
  • URL: https://otprun.com/api/v1/projects/{projectId}/api-keys
  • Auth: HTTP bearer

Path parameters

projectIdinteger required

Request body

chat_access'all' | 'own'

all (default): read every chat; own: only chats this key wrote to

ip_allowliststring[] nullable

IP addresses or CIDR ranges, empty allows any

namestring required
scopesstring[] nullable required

Response

Created

chat_access'all' | 'own' required

all: the key reads every WhatsApp chat of the workspace; own: only chats it wrote to itself

created_atstring date-time required
idinteger required
ip_allowliststring[] nullable required
keystring required

Plaintext key, shown only once

last_used_atstring date-time nullable required
namestring required
prefixstring required
project_idinteger required
revoked_atstring date-time nullable required
scopesstring[] nullable required

Changes

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