Skip to main content
POST
Create an API key that grants access to one or more instances within your organization. Every key is scoped with explicit permissions so you can hand out only the access that’s actually needed.

Authorization

Requires an organization-level API key in the Authorization header.

Request Body

string
required
A human-readable name for the key. Pick something descriptive — you’ll thank yourself later when you’re staring at a list of keys.
string[]
required
Array of instance IDs this key should have access to.
string[]
required
Array of permission scopes to grant. Valid values:
string
Optional ISO 8601 datetime string. If set, the key automatically becomes inactive after this time. If omitted, the key lives until you revoke it.

Response

string
Unique identifier for the key.
string
The organization this key belongs to.
string
The name you gave the key.
string
Always chd_sk_. Useful for identifying Chowder keys in your configs.
boolean
Whether the key is currently active.
string | null
Expiration datetime, if one was set.
string
When the key was created.
string
The full API key, prefixed with chd_sk_. This is the value you’ll use in Authorization headers.
Store the raw_key immediately. This is the only time the full key is returned. We store a hash on our end — there’s no way to retrieve the raw value after this response.