Get API keys
curl --request GET \
--url https://api.waterfall.io/v1/api-keys \
--header 'x-api-key: <api-key>'import requests
url = "https://api.waterfall.io/v1/api-keys"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.waterfall.io/v1/api-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.waterfall.io/v1/api-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.waterfall.io/v1/api-keys"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.waterfall.io/v1/api-keys")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.waterfall.io/v1/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"api_keys": [
{
"api_key": "ad18e456-0dd7-45e1-b094-43a0361aedfa",
"active": true,
"notes": "team-a",
"master": false,
"per_interval": 30,
"interval_seconds": 60
}
]
}{
"status": "error",
"message": "Missing api key",
"category": "AUTH",
"code": "AUTH_MISSING_API_KEY",
"error": "Missing api key"
}{
"status": "error",
"message": "Your account is over its quota. Please contact your account manager to discuss an upgrade.",
"category": "QUOTA",
"code": "QUOTA_ACCOUNT_OVER_QUOTA"
}{
"status": "error",
"message": "Bad api key",
"category": "AUTH",
"code": "AUTH_BAD_API_KEY",
"error": "Bad api key"
}{
"status": "error",
"message": "Too many requests. Try again after 12.34 seconds",
"error": "Rate limit exceeded",
"category": "RATE_LIMIT",
"code": "RATE_LIMIT_RATE_LIMIT_EXCEEDED"
}{
"status": "<string>",
"message": "<string>",
"error": "Rate limit exceeded"
}Account
API Keys - List
Get a list of all API keys under your account.
GET
/
v1
/
api-keys
Get API keys
curl --request GET \
--url https://api.waterfall.io/v1/api-keys \
--header 'x-api-key: <api-key>'import requests
url = "https://api.waterfall.io/v1/api-keys"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.waterfall.io/v1/api-keys', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.waterfall.io/v1/api-keys",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.waterfall.io/v1/api-keys"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.waterfall.io/v1/api-keys")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.waterfall.io/v1/api-keys")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"api_keys": [
{
"api_key": "ad18e456-0dd7-45e1-b094-43a0361aedfa",
"active": true,
"notes": "team-a",
"master": false,
"per_interval": 30,
"interval_seconds": 60
}
]
}{
"status": "error",
"message": "Missing api key",
"category": "AUTH",
"code": "AUTH_MISSING_API_KEY",
"error": "Missing api key"
}{
"status": "error",
"message": "Your account is over its quota. Please contact your account manager to discuss an upgrade.",
"category": "QUOTA",
"code": "QUOTA_ACCOUNT_OVER_QUOTA"
}{
"status": "error",
"message": "Bad api key",
"category": "AUTH",
"code": "AUTH_BAD_API_KEY",
"error": "Bad api key"
}{
"status": "error",
"message": "Too many requests. Try again after 12.34 seconds",
"error": "Rate limit exceeded",
"category": "RATE_LIMIT",
"code": "RATE_LIMIT_RATE_LIMIT_EXCEEDED"
}{
"status": "<string>",
"message": "<string>",
"error": "Rate limit exceeded"
}Requires your master API key in the
x-api-key header.What this endpoint does
Returns all API keys on your account — including the master key and all sub-keys — with their current status, notes, and rate-limit settings. Use this to audit which keys are active, check their rate limits, or find the UUID of a key you want to modify.Authorizations
To access the API, provide your API key in x-api-key.
Response
API keys list returned
Response containing the list of API keys for the authenticated account.
Your account API keys
Show child attributes
Show child attributes
Example:
[
{
"api_key": "ad18e456-0dd7-45e1-b094-43a0361aedfa",
"active": true,
"notes": "team-a",
"master": false,
"per_interval": 30,
"interval_seconds": 60
}
]
⌘I