Skip to main content
GET
List ports

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

project_id
integer
required

Project ID

Example:

1

region_id
integer
required

Region ID

Example:

1

Query Parameters

attached
boolean

Filter attached (true) or standalone (false) ports.

ids
string<uuid4>[]

Filter by port ID(s). Exact match.

ip_addresses
string<ipvanyaddress>[]

Filter by IP address(es). Exact match.

limit
integer
default:100

Optional. Limit the number of returned items

Required range: x <= 1000
Example:

100

managed_by
enum<string>

Filter ports managed by the user or system.

Available options:
system,
user
network_ids
string<uuid4>[]

Filter by network ID(s). Exact match.

offset
integer
default:0

Optional. Offset value is used to exclude the first set of records from the result

Required range: x >= 0
Example:

0

order_by
enum<string>
default:created_at.desc

Sort field and direction, e.g. created_at.desc or network_id.asc

Available options:
created_at.asc,
created_at.desc,
network_id.asc,
network_id.desc
parent_port_id
string<uuid4>

Filter trunk sub-ports by their parent port ID.

resource_id
string<uuid4>

Filter by attached compute resource ID.

resource_type
enum<string>

Filter by attachment resource type.

Available options:
baremetal,
basic_vm,
dhcp,
gpu_baremetal_server,
gpu_virtual_server,
instance,
load_balancer,
router
subnet_ids
string<uuid4>[]

Filter by subnet ID(s). Exact match.

Response

200 - application/json

OK

count
integer
required

Number of objects

Required range: x >= 0
Example:

1

results
PortDetailSerializer · object[]
required

Objects