Skip to main content
POST
/
api
/
tenant
/
api-keys
Create a new API key
curl --request POST \
  --url https://api.g-tateth.com/api/tenant/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production API Key",
  "permissions": [
    "read:conversations",
    "write:customers"
  ],
  "environment": "production",
  "expiresAt": "2023-11-07T05:31:56Z",
  "rotationPolicy": {
    "enabled": true,
    "intervalDays": 123,
    "notifyDaysBefore": 123
  },
  "rateLimit": {
    "requests": 123,
    "window": "1m"
  },
  "ipWhitelist": [
    "<string>"
  ]
}
'
{
  "success": true,
  "data": {
    "key": "<string>",
    "keyPrefix": "<string>"
  }
}

Authorizations

Authorization
string
header
required

JWT token authentication (for user sessions)

Body

application/json
name
string
required
Required string length: 1 - 100
Example:

"Production API Key"

permissions
string[]
required
Example:
["read:conversations", "write:customers"]
environment
enum<string>
default:production
Available options:
production,
staging
expiresAt
string<date-time>
rotationPolicy
object
rateLimit
object
ipWhitelist
string[]

Response

201 - application/json

API key created successfully

success
boolean
data
object