ByCloud Docs
GuidesCLIAPISDK
get/v1/ports

List ports

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

network_id

string<uuid>optional

query

Filter by network ID

device_id

stringoptional

query

Filter by device ID (instance, router, etc.)

device_owner

stringoptional

query

Filter by device owner

mac_address

stringoptional

query

Filter by MAC address

Responses

200

List of ports

Content-Type: application/json

ports

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

Response

List of ports

{
  "ports": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "crn": "crn:spo1:network:port:550e8400-e29b-41d4-a716-446655440000",
      "name": "web-server-port",
      "description": "string",
      "network_id": "550e8400-e29b-41d4-a716-446655440001",
      "status": "ACTIVE",
      "mac_address": "fa:16:3e:4f:5a:2b",
      "fixed_ips": [
        {
          "subnet_id": "550e8400-e29b-41d4-a716-446655440000",
          "ip_address": "192.168.1.10"
        }
      ],
      "device_id": "string",
      "device_owner": "compute:nova",
      "security_groups": [
        "550e8400-e29b-41d4-a716-446655440000"
      ],
      "port_security_enabled": true,
      "allowed_address_pairs": [
        {
          "ip_address": "192.168.1.100",
          "mac_address": "fa:16:3e:4f:5a:2b"
        }
      ],
      "dns_name": "string",
      "dns_assignment": [
        {
          "hostname": "string",
          "ip_address": "string",
          "fqdn": "string"
        }
      ],
      "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"
  }
}