ByCloud Docs
GuidesCLIAPISDK
get/v1/routers

List routers

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

Header Parameters

X-Region

stringrequired

header

Region code to query resources from. Required for all resource operations.

Example: "sao1"

Responses

200

List of routers

Content-Type: application/json

routers

arrayoptional

meta

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

Response

List of routers

{
  "routers": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "crn": "crn:spo1:network:router:550e8400-e29b-41d4-a716-446655440000",
      "name": "main-router",
      "description": "string",
      "status": "ACTIVE",
      "external_gateway_info": {
        "enable_snat": true,
        "external_fixed_ips": [
          {
            "ip_address": "string"
          }
        ]
      },
      "routes": [
        {
          "destination": "10.0.0.0/8",
          "nexthop": "192.168.1.1"
        }
      ],
      "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
  }
}