API Reference

API Reference

For the full API reference, including all endpoints, sample requests, error responses, and schema details, visit:

Aluvia API reference documentation.

Quick Start Example

Use this quick start request to verify your API key and retrieve all connectivity credentials in your account.

curl https://api.aluvia.io/credentials \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "success": true,
  "data": [
    {
      "username": "username1",
      "total_data_used": 2.5,
      "created_at": 1705478400,
      "updated_at": 1705564800,
      "options": {
        "use_sticky": true
      }
    },
    {
      "username": "username2",
      "total_data_used": 1.8,
      "created_at": 1705478460,
      "updated_at": 1705564860,
      "options": {}
    }
  ]
}