Authentication

The Symplax API uses API keys to authenticate requests. All API requests must include your API key in the Authorization header.

Base URL

Getting Your API Key

You can generate API keys from your dashboard settings. Each key can be given specific permissions and can be revoked at any time.

Authentication Header

Include your API key in the Authorization header with the Bearer prefix:

Example Request

Here's an example of authenticating a request to list all servers:

curl https://api.symplax.com/v1/servers \
  -H "Authorization: Bearer YOUR_API_KEY"

const response = await fetch('https://api.symplax.com/v1/servers', {
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});

const data = await response.json();

import requests

headers = {
    'Authorization': 'Bearer YOUR_API_KEY'
}

response = requests.get(
    'https://api.symplax.com/v1/servers',
    headers=headers
)

Example Response

{
  "success": true,
  "data": {
    "servers": [
      {
        "id": "srv_1234567890",
        "name": "prod-01",
        "ip": "192.168.1.100",
        "status": "running",
        "created_at": "2026-02-01T10:00:00Z"
      }
    ]
  }
}

Authentication Errors

If authentication fails, you'll receive a 401 Unauthorized response:

{
  "success": false,
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid or missing API key"
  }
}

Rate Limiting

API requests are rate limited to prevent abuse. Current limits:

Rate limit information is included in response headers:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 45
X-RateLimit-Reset: 1612345678