API Keys

API Keys provide programmatic access to write, update, and delete data in your Data Buckets.

Key Features

• Dashboard-Scoped Access - Each key grants access to all buckets within a specific dashboard
• Write Operations - Create, update, and delete records via API
• Secure Authentication - Keys use the X-API-Key header for authentication
• Owner/Admin Management - Only users with Owner or Admin roles can create and manage keys

Scope and Permissions

API Keys are scoped per dashboard:

• A key grants full access to write, update, and delete operations for all buckets within that dashboard
• Keys cannot access buckets from other dashboards
• Only users with Owner or Admin roles can create, view, or revoke API keys

Creating API Keys

To create an API key:

1. Navigate to your dashboard
2. Go to the API Keys tab
3. Click Create
4. Give your key a clear name
5. Select the Key Type: Production or Development (for easier management and organization)
6. Copy the key immediately - it will only be shown once

Important: Store your API key securely. You cannot retrieve it again after creation.

Using API Keys

Include your API key in the X-API-Key header for all API requests:

curl -X POST https://data.dashgrid.com/api/buckets/{BUCKET_ID} \
  -H "X-API-Key: {YOUR_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '[{"key": "2025-01-20T10:00:00Z", "data": [{"series_key": 1, "value": 42}]}]'

For complete API docs, see Data Buckets API.

Security Best Practices

• Never expose keys in public repositories, frontend code, or client-side applications
• Use environment variables to store API keys in your backend services
• Rotate keys regularly for production environments
• Create separate keys for different services or environments (development, staging, testing, production)
• Revoke compromised keys immediately and generate new ones
• Use clear, descriptive key names to track which service or device uses each key

Revoking API Keys

If a key is compromised or no longer needed:

1. Go to the Keys tab in your dashboard
2. Select the key in the list, and switch to the Danger tab
3. Follow the instructions to permanently disable the key