Huddle01 Cloud
Instances

Get instance

Retrieve details of a specific instance.

GET
/instances/{id}
x-api-key<token>

In: header

Path Parameters

idstring

Unique identifier of the instance.

Query Parameters

regionstring

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

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://cloud.huddleapis.com/api/v1/instances/inst_12345?region=eu2"
{
  "instance": {
    "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": [
        {
          "ip_address": "203.0.113.10",
          "type": "floating"
        }
      ]
    },
    "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": "Resource not found",
  "error": {
    "code": "NOT_FOUND",
    "message": "Instance not found",
    "type": "not_found"
  },
  "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"
}