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

Query Parameters

attached
boolean

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

attached_to_resource_ids
string<uuid4>[]

Filter by attached resource ID(s). Matches ports attached to any of the given resources.

Maximum array length: 20
attached_to_resource_types
enum<string>[]

Filter by attachment resource type(s). A port matches if its type is any of the given values.

Maximum array length: 10
Available options:
baremetal_server,
basic_vm,
dhcp,
gpu_baremetal_server,
gpu_virtual_server,
instance,
load_balancer,
router
created_at
DateTimeRangeFilter · object

Range filter on creation time.

ids
string<uuid4>[]

Filter by port UUID(s).

ip_address
IpAddressFilter · object

Filter by fixed IP address.

limit
integer
default:100

Max items to return.

Required range: x <= 1000
managed
boolean

Filter by managed status. true = managed by a service, false = customer-operated. A port with a manager type that this API version does not know counts as managed, but its managed_by is null. Cannot be combined with managed_by when false.

managed_by
enum<string>

Filter by manager type, e.g. system or k8s_cluster.

Available options:
file_share,
gpu_baremetal_cluster,
gpu_virtual_cluster,
k8s_cluster,
load_balancer,
network,
router,
system
managed_by_resource_ids
string[]

Filter by managing resource ID(s).

Maximum array length: 20
managed_by_resource_names
string[]

Filter by managing resource name(s).

Maximum array length: 20
network_ids
string<uuid4>[]

Filter by network ID(s).

offset
integer
default:0

Items to skip.

Required range: x >= 0
order_by
enum<string>
default:created_at.desc

Sort field and direction. network_grouping.asc keeps the ports of one network together. In each region, the networks shared with the project come first, in the order of the share. If no shared network is public, the default public network of the region comes next. Then come other public networks, then all other networks.

Available options:
created_at.asc,
created_at.desc,
network_grouping.asc,
region_id.asc,
region_id.desc,
updated_at.asc,
updated_at.desc
public
boolean

Filter ports on networks that give publicly routed address space (true) or not (false).

region_ids
integer[]

Filter by region ID(s). Omit = all regions.

security_group_ids
string<uuid4>[]

Filter by security group ID(s). A port matches if it has any of the given security groups.

subnet_ids
string<uuid4>[]

Filter by subnet ID(s). A port matches if it has a fixed IP in any of the given subnets.

tag_key
StringFilter · object

Filter by tag key regardless of value, e.g. tag_key[contains]=team.

tag_value
StringFilter · object

Filter by tag value regardless of key, e.g. tag_value[prefix]=prod.

tags
TagFilter · object

Filter by exact tag key-value pairs, e.g. tags[env]=prod&tags[team]=core. Repeat a key to match any of several values for it, e.g. tags[env]=prod&tags[env]=dev. Values for one key are ORed, different keys are ANDed; values match case-insensitively.

Example:
updated_at
DateTimeRangeFilter · object

Range filter on last-update time.

Response

Ports

count
integer
required

Number of objects

Required range: x >= 0
Example:

1

results
GlobalPortSerializer · object[]
required

Objects