ByCloud Docs
GuidesCLIAPISDK
get/v1/subnets

List subnets

List all subnets 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"

network_id

string<uuid>optional

query

Filter by network ID

ip_version

integeroptional

query

Filter by IP version

Enum: 4, 6

cidr

stringoptional

query

Filter by CIDR

Responses

200

List of subnets

Content-Type: application/json

subnets

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

Response

List of subnets

{
  "subnets": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "crn": "crn:spo1:network:subnet:550e8400-e29b-41d4-a716-446655440000",
      "name": "private-subnet",
      "description": "string",
      "network_id": "550e8400-e29b-41d4-a716-446655440001",
      "ip_version": 4,
      "cidr": "192.168.1.0/24",
      "gateway_ip": "192.168.1.1",
      "dns_nameservers": [
        "8.8.8.8",
        "8.8.4.4"
      ],
      "allocation_pools": [
        {
          "start": "192.168.1.100",
          "end": "192.168.1.200"
        }
      ],
      "host_routes": [
        {
          "destination": "10.0.0.0/8",
          "nexthop": "192.168.1.1"
        }
      ],
      "enable_dhcp": true,
      "ipv6_ra_mode": "slaac",
      "ipv6_address_mode": "slaac",
      "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"
  }
}