ByCloud Docs
GuidesCLIAPISDK
get/v1/pools

List pools

List all pools 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-*"

tags

stringoptional

query

Filter by tags (comma-separated)

Example: "web,production"

load_balancer_id

string<uuid>optional

query

Filter by load balancer ID

protocol

stringoptional

query

Filter by protocol

Responses

200

List of pools

Content-Type: application/json

pools

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

Response

List of pools

{
  "pools": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "crn": "crn:spo1:loadbalancer:pool:550e8400-e29b-41d4-a716-446655440000",
      "name": "web-pool",
      "description": "string",
      "provisioning_status": "ACTIVE",
      "operating_status": "ONLINE",
      "protocol": "HTTP",
      "lb_algorithm": "ROUND_ROBIN",
      "session_persistence": {
        "type": "HTTP_COOKIE",
        "cookie_name": "string",
        "persistence_timeout": 0,
        "persistence_granularity": "string"
      },
      "listeners": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "members": [
        {
          "id": "550e8400-e29b-41d4-a716-446655440000"
        }
      ],
      "healthmonitor_id": "550e8400-e29b-41d4-a716-446655440000",
      "load_balancer_id": "550e8400-e29b-41d4-a716-446655440000",
      "tags": [
        "web",
        "frontend"
      ],
      "created_at": "2024-01-15T10:30:00Z",
      "updated_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"
  }
}