Authentication

Use a Ferndesk API key to authenticate every API request. Send the key as a Bearer token in the Authorization header.

Add the Authorization header

Include your API key in this format:

Authorization: Bearer fdsk_your_api_key

Here is a complete example:

curl -H "Authorization: Bearer fdsk_your_api_key" \
  https://api.ferndesk.com/articles

Keep your key secure

Treat your API key like a password. Store it in a secrets manager or environment variable, and never commit it to source control or share it in client-side code.

If a key is exposed, revoke it and create a new one.

Manage API keys

For step-by-step instructions to create, view, and revoke keys, see Manage API keys.