apunkt/dograh
1
0
Fork 0
mirror of https://github.com/dograh-hq/dograh.git synced 2026-06-07 07:55:16 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: add developer and api reference tabs (#190)

Browse source 
* docs: add developer and api reference tabs

* fix: remove duplicate image
This commit is contained in:
Sabiha Khan 2026-03-14 16:30:02 +05:30 • committed by GitHub
parent 1b03191cf8
commit f075bcb623
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
57 changed files with 1609 additions and 57 deletions
Download patch file Download diff file Expand all files Collapse all files

21
docs/api-reference/api-keys.mdx Normal file
View file

@ -0,0 +1,21 @@
---
title: "Overview"
description: "Create and manage API keys for programmatic access"
---
API keys authenticate requests from your applications and services. Each key is scoped to your organization — all API calls made with a key create and access resources within that organization.
| Method | Endpoint | Quick Link |
|---|---|---|
| `POST` | `/user/api-keys` | [Create an API key](/api-reference/api-keys/create) |
| `GET` | `/user/api-keys` | [List API keys](/api-reference/api-keys/list) |
| `DELETE` | `/user/api-keys/{api_key_id}` | [Archive an API key](/api-reference/api-keys/archive) |
| `PUT` | `/user/api-keys/{api_key_id}/reactivate` | [Reactivate an API key](/api-reference/api-keys/reactivate) |
## Best practices
- **Use one key per environment** — separate keys for development, staging, and production make rotation easy and limit blast radius if a key is compromised.
- **Use one key per service** — this allows you to revoke a single service's access without affecting others.
- **Rotate keys regularly** — create a new key, update your secret store, then archive the old key.
- **Never hardcode keys** — use environment variables or a secrets manager. Never commit keys to version control.
- **Monitor `last_used_at`** — keys with no recent activity may be safe to archive.