Create an API key

Mints a prowl_... key, optionally scoped to categories, spend limits and an IP allowlist. The secret is returned once and is never retrievable again — store it when you receive it.

post/api/v1/keys

Request

Base URL: https://prowl.chat
URL: https://prowl.chat/api/v1/keys
Auth: HTTP bearer

Headers

authorizationstring nullable

Cookies

prowl_sessionstring nullable

Request body

namestring

allowed_categoriesstring[]

denied_categoriesstring[]

daily_spend_limit_usdnumber nullable

total_spend_limit_usdnumber nullable

ip_allowliststring[]

Response

Successful Response

idstring required

keystring required

The secret. Shown exactly once; store it now.

prefixstring required

namestring required

allowed_categoriesstring[] nullable

denied_categoriesstring[] nullable

daily_spend_limit_usdnumber nullable

total_spend_limit_usdnumber nullable

ip_allowliststring[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.