API Keys

Overview

Datachecks now supports API Key-based authentication for secure, programmatic access to its platform services. This allows developers and system integrators to integrate Datachecks into CI/CD pipelines, orchestrators, or custom data pipelines with ease and security.

🔧 Getting Started

Generate an API Key

To create a new API Key:

1. Log in to your Datachecks Dashboard
2. Navigate to Settings > Tokens
3. Click “Generate New Token”
4. Name your key (e.g., prod_pipeline_key) and optionally set:
   • Expiry Date • Scope (read/write)
5. Click Create Key and copy the key securely.

⚠️ Keep it secret, keep it safe.

Using the API Key

Include the API Key in the Authorization header as a Bearer token:

GET /v1/test-runs/1234 HTTP/1.1
Host: api.datachecks.ai
Authorization: Bearer YOUR_API_KEY

curl -X GET https://api.datachecks.ai/v1/test-runs \
  -H "Authorization: Bearer YOUR_API_KEY"

🔁 Enable/Disable Keys

You can enable or disable the keys regularly for improved security.

• Disabling a key immediately invalidates it.
• Enabling a key allows the key to be active again

🔍 Best Practices

• 🔑 Use different keys for dev/staging/prod.
• 📆 Set expiry dates for temporary keys.
• 👥 Rotate keys periodically.
• 🚫 Revoke keys when no longer needed or if exposed.
• 🔐 Store secrets securely (e.g., AWS Secrets Manager, Vault)