Skip to main content
POST
/
v1
/
api-keys
Create an API key
curl --request POST \
  --url https://api.wavix.com/v1/api-keys \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "Production API Key",
  "is_active": true,
  "is_restriction": true,
  "permitted_ips": [
    "192.168.1.1",
    "10.0.0.1"
  ]
}
'
{
  "id": 123,
  "label": "Production API Key",
  "value": "abc123def456ghi789jkl012mno345pqr678stu901vwx234yz",
  "is_active": true,
  "is_restriction": true,
  "permitted_ips": [
    "192.168.1.1",
    "10.0.0.1"
  ],
  "created_at": "2024-01-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Bearer token using appid (Authorization: Bearer )

Body

application/json
​
label
string

API key label.

Example:

"My API key"

​
is_active
boolean
default:true

Indicates whether the API key should be activated upon creation.

Example:

true

​
is_restriction
boolean
default:false

Indicates whether to restrict API key access by IP address. When enabled, only requests from IP addresses listed in permitted_ips are allowed.

Example:

true

​
permitted_ips
string[]

List of permitted IP addresses for this API key. Each must be a valid IPv4 address. Required when is_restriction is true.

Example:
["192.168.1.1", "10.0.0.1"]

Response

API key created.

API key details including IP restrictions.

​
id
integer

API key ID.

Example:

123

​
label
string

API key label.

Example:

"Production API Key"

​
value
string

API key value.

Example:

"abc123def456ghi789jkl012mno345pqr678stu901vwx234yz"

​
is_active
boolean

Indicates whether the API key is active.

Example:

true

​
is_restriction
boolean

Indicates whether IP restrictions are enabled. When enabled, the API key works only from IP addresses in permitted_ips.

Example:

true

​
permitted_ips
string[]

List of permitted IP addresses. If is_restriction is false, an empty list means no IP restrictions. If is_restriction is true, an empty list prevents all requests.

Example:
["192.168.1.1", "10.0.0.1"]
​
created_at
string<date-time>

Creation date and time in ISO 8601 format.

Example:

"2024-01-15T10:30:00Z"