Skip to main content
GET
/
cloud
/
v1
/
ports
/
{project_id}
/
{region_id}
/
{port_id}
Get port
curl --request GET \
  --url https://api.gcore.com/cloud/v1/ports/{project_id}/{region_id}/{port_id} \
  --header 'Authorization: <api-key>'
{
  "allowed_address_pairs": [
    {
      "ip_address": "192.168.123.20"
    }
  ],
  "capabilities": {
    "allowed_address_pairs": true,
    "port_security": true,
    "security_groups": true
  },
  "created_at": "2024-01-15T10:30:00Z",
  "id": "1f0ca628-a73b-42c0-bdac-7b10d023e097",
  "ip_assignments": [
    {
      "ip_address": "192.168.123.20",
      "subnet_id": "351b0dd7-ca09-431c-be53-935db3785067"
    }
  ],
  "mac_address": "fa:16:3e:f2:87:16",
  "network_id": "bc688791-f1b0-44eb-97d4-07697294b1e1",
  "port_security_enabled": true,
  "security_group_ids": [
    "bc688791-f1b0-44eb-97d4-07697294b1e1"
  ],
  "tags": {
    "env": "prod",
    "team": "platform"
  }
}

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

​
port_id
string<uuid4>
required

Port ID

Example:

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

Response

200 - application/json

OK

​
allowed_address_pairs
AllowedAddressPairsResponseSerializer · object[]
required

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

​
capabilities
PortCapabilitiesSerializer · object
required

What the driver enforces. null when the port is unattached (driver unknown).

​
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
enum<string>
required

Who manages this port: 'user' (full CRUD allowed) or 'system' (read-only)

Available options:
system,
user
Example:

"user"

​
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

​
security_group_ids
string<uuid4>[]
required

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

Example:
["bc688791-f1b0-44eb-97d4-07697294b1e1"]
​
tags
Tags · object
required

Key-value tags on the port

Example:
{ "env": "prod", "team": "platform" }