Skip to main content
PUT
/
v1
/
api-keys
Modify an API key
curl --request PUT \
  --url https://api.waterfall.io/v1/api-keys \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "api_key": "ad18e456-0dd7-45e1-b094-43a0361aedfa",
  "notes": "updated note",
  "active": true,
  "per_interval": 25
}
'
{
  "api_key": "ad18e456-0dd7-45e1-b094-43a0361aedfa",
  "active": true,
  "notes": "updated note",
  "master": false,
  "per_interval": 25
}
Requires your master API key in the x-api-key header.

​
What can be changed

FieldEditableNotes
notesYesUpdate the label for any sub-key
activeYesSet to false to deactivate, true to reactivate
per_intervalYesCannot exceed the master key’s per_interval. If omitted, current value is kept.
api_keyNoRead-only identifier
masterNoCannot promote or demote a key
The master key cannot be modified with this endpoint. Attempts to edit it will be rejected.

Authorizations

​
x-api-key
string
header
required

To access the API, provide your API key in x-api-key.

Body

application/json

Update API key payload. api_key, notes, and active are required. Optional per_interval updates the sub-key rate limit; if omitted, current per_interval is retained.

Request payload to update an existing API key.

​
api_key
string<uuid>
required

API key to edit.

Example:

"ad18e456-0dd7-45e1-b094-43a0361aedfa"

​
notes
string
required

Notes associated with the API key.

Required string length: 1 - 250
Example:

"My API key"

​
active
boolean
default:true
required

Set to true to keep or mark the target sub-key active.

​
per_interval
integer<int32>

Optional per-interval request limit for the target sub-key. If not provided, current value is not changed. It cannot exceed the master key's per_interval.

Required range: x >= 1
Example:

25

Response

API key succesfully updated.

Response payload for a successful API key update.

​
api_key
string<uuid>
required

A UUID.

Example:

"7d44db58-5de3-4e92-a2fb-8325d12c2e8b"

​
active
boolean | null
required
Example:

true

​
notes
string
required

Notes associated with the API key.

Required string length: 1 - 250
Example:

"My API key"

​
master
boolean
required
Example:

false

​
per_interval
integer<int32>
Required range: x >= 1
Example:

25