Skip to main content
GET
Get port

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

port_id
string<uuid4>
required

Port ID

Example:

"1f0ca628-a73b-42c0-bdac-7b10d023e097"

Response

Port

allowed_address_pairs
AllowedAddressPairsResponseSerializer · object[]
required

List of allowed address pairs. Sorted by ip_address for stable client refreshes.

attached_to
PortAttachmentSerializer · object | null
required

The compute resource this port is attached to, including trunk role for trunk parents and sub-ports. null when the port is standalone (unattached).

capabilities
PortCapabilitiesSerializer · object | null
required

What the driver enforces. null when the port is unattached or managed, or when the project sees the port only because it owns the network of the port. null also when this API version does not know the manager type. Such a port is read-only: a change or a delete returns permission-denied.

created_at
string<date-time>
required

Datetime when the port was created.

Example:

"2024-01-15T10:30:00Z"

id
string<uuid4>
required

Port ID

Example:

"1f0ca628-a73b-42c0-bdac-7b10d023e097"

ip_assignments
IpAssignmentSerializer · object[]
required

List of IP addresses assigned to the port.

mac_address
string
required

MAC address of the port

Example:

"fa:16:3e:f2:87:16"

managed_by
GlobalPortManagedBySerializer · object | null
required

Service managing this port. null if customer-operated. null also when this API version does not know the manager type. Such a port is read-only: a change or a delete returns permission-denied.

network_id
string<uuid4>
required

ID of the network the port belongs to

Example:

"bc688791-f1b0-44eb-97d4-07697294b1e1"

port_security_enabled
boolean
required

When true, the driver enforces port security on this port (anti-spoofing checks and security-group filtering apply). When false, all traffic is allowed and security groups are not applied.

Example:

true

region_id
integer
required

Region ID.

Example:

1

security_group_ids
string<uuid4>[]
required

List of security group IDs applied to the port. Sorted lexicographically for stable client refreshes.

Example:
system_tags
System Tags · object
required

Read-only key-value tags on the port, set by the platform and not modifiable by the user

Example:
tags
Tags · object
required

Key-value tags on the port

Example:
updated_at
string<date-time>
required

Datetime when the port was last updated.

Example:

"2025-11-18T10:22:00Z"