Skip to main content
Manage Duckie API keys from Settings -> API Access. The API Access section shows each key’s name, preview, scopes, creator, created time, last-used time, expiration, and status.

Create a Key

1

Open API Access

Go to Settings -> API Access.
2

Create a key

Click Create key.
3

Name the key

Use a name that identifies the integration or environment, such as Warehouse export or Production reporting.
4

Choose scopes

Select the read scopes this key should have. All read scopes are selected by default.
5

Choose an expiration

Select No expiration, 90 days, or 1 year.
6

Store the key

Copy the full key from the one-time reveal dialog and store it in your secret manager.
The full API key is shown only once. Duckie stores a hash and a preview after creation.

Scopes

Scope labelScope value
Runsapi:runs:read
Toolsapi:tools:read
Agentsapi:agents:read
Guidelinesapi:guidelines:read
Guardrailsapi:guardrails:read
Runbooksapi:runbooks:read
Create separate keys for separate integrations when they need different scopes or rotation schedules.

Rename a Key

Use rename when the integration name changes or you want a clearer label. Renaming changes only the display name. The API key value and scopes stay the same.

Revoke a Key

Revoking a key stops new requests with that key immediately.
1

Find the key

Go to Settings -> API Access and find the key in the table.
2

Revoke

Click the revoke action and confirm.
3

Rotate integrations

Update any integration that used the revoked key with a newly created key.

Statuses

StatusMeaning
ActiveThe key can authenticate requests until it expires or is revoked
ExpiredThe key is past its configured expiration
RevokedThe key was manually revoked