ByCloud Docs
GuidesCLIAPISDK
get/v1/images

List images

List all available images

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"

visibility

stringoptional

query

Filter by visibility

Enum: "public", "private", "shared", "community"

os_distro

stringoptional

query

Filter by OS distribution

Example: "ubuntu"

os_version

stringoptional

query

Filter by OS version

Example: "22.04"

architecture

stringoptional

query

Filter by architecture

Example: "x86_64"

Responses

200

List of images

Content-Type: application/json

images

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/images" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json"

Response

List of images

{
  "images": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "crn": "crn:spo1:compute:image:550e8400-e29b-41d4-a716-446655440000",
      "name": "Ubuntu 22.04 LTS",
      "description": "Ubuntu 22.04 LTS (Jammy Jellyfish)",
      "min_disk": 10,
      "min_ram": 1024,
      "os_distro": "ubuntu",
      "os_version": "22.04",
      "architecture": "x86_64",
      "tags": [
        "web",
        "frontend"
      ]
    }
  ],
  "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"
  }
}