Huddle01 Cloud
Instances

List instances

List all instances for the authenticated user.

GET
/instances
x-api-key<token>

In: header

Query Parameters

regionstring

Region code where the resource exists (e.g., eu2).

limit?integer

Number of records to return (1-20). Defaults to 10.

Default10
Range1 <= value <= 20
offset?integer

Zero-based index for paginated results.

Range0 <= value

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://cloud.huddleapis.com/api/v1/instances?region=eu2"
{
  "instances": [
    {
      "id": "inst_12345",
      "name": "video-node",
      "vcpus": 2,
      "ram": 4096,
      "status": "ACTIVE",
      "created_at": "2024-03-18T10:20:00Z",
      "image": {
        "id": "img-ubuntu-22-04",
        "name": "Ubuntu 22.04 LTS",
        "distribution": "ubuntu",
        "distribution_version": "22.04"
      },
      "networks": {
        "v4": [
          {
            "ip_address": "203.0.113.10",
            "type": "floating"
          }
        ],
        "v6": []
      },
      "region": {
        "name": "eu2"
      }
    }
  ]
}
{
  "message": "Bad request",
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request body",
    "type": "client"
  },
  "timestamp": "2024-03-18T10:22:00Z"
}
{
  "message": "Unauthorized",
  "error": {
    "code": "UNAUTHORIZED",
    "message": "x-api-key header missing",
    "type": "auth"
  },
  "timestamp": "2024-03-18T10:22:00Z"
}
{
  "message": "Internal server error",
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Failed to create instance",
    "type": "server"
  },
  "timestamp": "2024-03-18T10:22:00Z"
}