Authentication
How to authenticate requests to the Paladin API
API key authentication#
API keys are the recommended way to authenticate programmatic requests. Pass your key in the X-API-Key request header.
bash
curl https://app.paladin.northmanngrp.com/api/v1/workflow/fetch \
-H "X-API-Key: YOUR_API_KEY"API keys are scoped to an organization. All resources created or accessed using a key belong to that organization.
Create an API key#
Create keys in the dashboard under Settings → API Keys. The full key is shown only once at creation time — store it immediately in a secrets manager or environment variable.
Manage API keys#
| Action | Method | Path |
|---|---|---|
| List keys | GET | /user/api-keys |
| Create key | POST | /user/api-keys |
| Archive key | DELETE | /user/api-keys/{api_key_id} |
| Reactivate key | PUT | /user/api-keys/{api_key_id}/reactivate |
Archiving a key immediately revokes it. All subsequent requests using that key return 401.
---
Error responses#
| Status | Cause |
|---|---|
401 Unauthorized | Missing, invalid, or expired credentials |
403 Forbidden | Valid credentials but insufficient permissions for the resource |
json
{
"detail": "Invalid or expired API key"
}How to use this reference#
Use this page as the entry point for the related API endpoints. Open the endpoint-specific page when you need the exact method, path, request body, response schema, and OpenAPI details.
Implementation checklist#
- Start with the overview table to choose the correct endpoint.
- Confirm authentication and organization scope before calling the endpoint from code.
- Test with a small request first, then inspect the response and error handling path.