Authentication

All API requests require authentication using an API key. Include your API key in the X-API-Key header of every request.

Getting Your API Key

  1. Log in to your Cipres dashboard
  2. Navigate to Settings → API Keys
  3. Click Create API Key
  4. Give your key a descriptive name (e.g., "Production Server")
  5. Copy the key immediately — it won't be shown again

Security Warning: Never expose your API key in client-side code, public repositories, or logs. Always make API calls from your backend server.

Using Your API Key

Include the API key in the X-API-Key header:

cURL 
curl https://cipres.tech/api/v1/users \
  -H "X-API-Key: sk_a1b2c3d4..." \
  -H "Content-Type: application/json" \
  -d '{"project_id": 1, "users": [...]}'

API Key Format

Prefix Description
sk_ API key prefix, followed by an 8-character identifier and full key

Response Codes

Authentication errors return the following responses:

{
  "status": "ok"
}

Best Practices

  • Use environment variables to store API keys
  • Create separate keys for development and production
  • Rotate keys periodically
  • Delete unused keys from your dashboard
  • Monitor your API usage for unusual activity