Skip to main content
POST
/
api
/
v1
/
user
/
api-keys
Create Api Key
curl --request POST \
  --url https://app.dograh.com/api/v1/user/api-keys \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "key_prefix": "<string>",
  "api_key": "<string>",
  "created_at": "2023-11-07T05:31:56Z"
}
The full key is only returned once at creation. Store it immediately in a secrets manager or environment variable — it cannot be retrieved again.

​
Authentication

This endpoint requires a valid user session token. If you do not yet have an API key, obtain a session token by logging in first and pass it as a Bearer token in the Authorization header. Step 1 — Log in to get a session token 
curl -X POST https://your-dograh-instance/api/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "you@example.com", "password": "your-password"}'
The response contains a token field. Use it in the next step. Step 2 — Create an API key 
curl -X POST https://your-dograh-instance/api/v1/user/api-keys \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "my-api-key"}'
Once you have an API key, you can use X-API-Key: <key> in place of Authorization: Bearer for all subsequent requests.

Headers

​
authorization
string | null
​
X-API-Key
string | null

Body

application/json
​
name
string
required

Response

Successful Response

​
id
integer
required
​
name
string
required
​
key_prefix
string
required
​
api_key
string
required
​
created_at
string<date-time>
required