Skip to content
catchook
Documentation

API reference

API Keys

Every API Keys endpoint in the Catchook API.

Generated from Catchook API 0.1.0 · OpenAPI 3.1.0 ·openapi.json

get/projects/{projectId}/api-keys

List a project's API keys

Path parameters

projectIdrequired
string

min length 1

Query parameters

pageoptional
integer

default 1 · min 1

limitoptional
integer

default 50 · min 1 · max 100

Request

curl -X GET https://api.catchook.com/projects/{projectId}/api-keys \
  -H "Authorization: Bearer $CATCHOOK_API_KEY"

200List of API keys (no secret)

datarequired
object[]
data[].idrequired
string
data[].project_idrequired
string

nullable

data[].namerequired
string

nullable

data[].prefixrequired
string

nullable

data[].startrequired
string

nullable

data[].enabledrequired
boolean
data[].expires_atrequired
string

nullable

data[].created_atrequired
string
data[].updated_atrequired
string
paginationrequired
object
pagination.pagerequired
number
pagination.limitrequired
number
pagination.totalrequired
number
pagination.total_pagesrequired
number
pagination.has_nextrequired
boolean
pagination.has_prevrequired
boolean
timestamprequired
string

401Requires a signed-in session

errorrequired
object
error.coderequired
string
error.messagerequired
string
timestamprequired
string

404Project not found

errorrequired
object
error.coderequired
string
error.messagerequired
string
timestamprequired
string

post/projects/{projectId}/api-keys

Create an API key for a project

Path parameters

projectIdrequired
string

min length 1

Request body

nameoptional
string

min length 1

Request

curl -X POST https://api.catchook.com/projects/{projectId}/api-keys \
  -H "Authorization: Bearer $CATCHOOK_API_KEY" \
  -H "Content-Type: application/json" \ \
  -d '{ … }'

201The created API key (secret shown once)

datarequired
object
timestamprequired
string

401Requires a signed-in session

errorrequired
object
error.coderequired
string
error.messagerequired
string
timestamprequired
string

404Project not found

errorrequired
object
error.coderequired
string
error.messagerequired
string
timestamprequired
string

get/api-keys/{id}

Get an API key (no secret)

Path parameters

idrequired
string

min length 1

Request

curl -X GET https://api.catchook.com/api-keys/{id} \
  -H "Authorization: Bearer $CATCHOOK_API_KEY"

200The API key

datarequired
object
data.idrequired
string
data.project_idrequired
string

nullable

data.namerequired
string

nullable

data.prefixrequired
string

nullable

data.startrequired
string

nullable

data.enabledrequired
boolean
data.expires_atrequired
string

nullable

data.created_atrequired
string
data.updated_atrequired
string
timestamprequired
string

401Requires a signed-in session

errorrequired
object
error.coderequired
string
error.messagerequired
string
timestamprequired
string

404API key not found

errorrequired
object
error.coderequired
string
error.messagerequired
string
timestamprequired
string

delete/api-keys/{id}

Revoke an API key

Path parameters

idrequired
string

min length 1

Request

curl -X DELETE https://api.catchook.com/api-keys/{id} \
  -H "Authorization: Bearer $CATCHOOK_API_KEY"

204API key revoked

401Requires a signed-in session

errorrequired
object
error.coderequired
string
error.messagerequired
string
timestamprequired
string

404API key not found

errorrequired
object
error.coderequired
string
error.messagerequired
string
timestamprequired
string