ByCloud Docs
GuidesCLIAPISDK
get/v1/instances

List instances

List all instances in the current organization

Query Parameters

limit

integeroptional

query

Maximum number of items to return

Default: 20

Example: 20

marker

string<uuid>optional

query

ID of the last item from the previous page (for pagination)

Example: "550e8400-e29b-41d4-a716-446655440000"

name

stringoptional

query

Filter by name (exact match or prefix with *)

Example: "web-*"

status

stringoptional

query

Filter by status

Example: "ACTIVE"

tags

stringoptional

query

Filter by tags (comma-separated)

Example: "web,production"

flavor_id

string<uuid>optional

query

Filter by flavor ID

image_id

string<uuid>optional

query

Filter by image ID

Responses

200

List of instances

Content-Type: application/json

instances

arrayoptional

meta

objectoptional

links

objectoptional
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X GET "https://api.spo1.mycloud.com/v1/instances" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Response

List of instances

{
  "instances": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "crn": "crn:spo1:compute:instance:550e8400-e29b-41d4-a716-446655440000",
      "name": "web-server-01",
      "description": "Primary web server",
      "status": "ACTIVE",
      "power_state": "RUNNING",
      "task_state": null,
      "vm_state": "ACTIVE",
      "flavor": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "m1.medium",
        "vcpus": 2,
        "ram": 4096,
        "disk": 40
      },
      "image": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Ubuntu 22.04 LTS"
      },
      "addresses": {
        "private-network": [
          {
            "addr": "192.168.1.10",
            "version": 4,
            "type": "fixed",
            "mac_addr": "fa:16:3e:4f:5a:2b"
          }
        ]
      },
      "security_groups": [
        {
          "name": "default"
        }
      ],
      "volumes_attached": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000",
          "device": "/dev/vdb",
          "delete_on_termination": false
        }
      ],
      "key_names": [
        "my-keypair",
        "backup-key"
      ],
      "metadata": {
        "environment": "production",
        "team": "backend"
      },
      "tags": [
        "web",
        "frontend"
      ],
      "fault": {
        "code": 500,
        "message": "No valid host was found",
        "details": "string",
        "created": "2024-01-15T10:30:00Z"
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z",
      "launched_at": "2024-01-15T10:30:00Z",
      "terminated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "meta": {
    "total": 150,
    "limit": 20,
    "marker": "550e8400-e29b-41d4-a716-446655440000",
    "has_more": true
  },
  "links": {
    "self": "https://api.spo1.mycloud.com/v1/instances?limit=20",
    "next": "https://api.spo1.mycloud.com/v1/instances?limit=20&marker=550e8400-e29b-41d4-a716-446655440000",
    "previous": "https://api.spo1.mycloud.com/v1/instances?limit=20&marker=440e8400-e29b-41d4-a716-446655440000"
  }
}