Enable port security for instance interface

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
instance_interface = client.cloud.instances.enable_port_security(
    port_id="port_id",
    project_id=0,
    region_id=0,
)
print(instance_interface.network_id)

{
  "allowed_address_pairs": [
    {
      "ip_address": "<string>",
      "mac_address": "<string>"
    }
  ],
  "floatingip_details": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
      "fixed_ip_address": "192.168.10.15",
      "floating_ip_address": "172.24.4.34",
      "id": "<string>",
      "port_id": "ee2402d0-f0cd-4503-9b75-69be1d11c5f1",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "router_id": "11005a33-c5ac-4c96-ab6f-8f2827cc7da6",
      "status": "ACTIVE",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "task_id": "a4eb4b29-048e-42f6-a5e1-2c18bc001c45",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "ip_assignments": [
    {
      "ip_address": "<string>",
      "subnet_id": "<string>"
    }
  ],
  "network_details": {
    "created_at": "2023-11-07T05:31:56Z",
    "creator_task_id": "fd50fdd1-0482-4c9b-b847-fc9924665af6",
    "default": true,
    "external": true,
    "id": "<string>",
    "mtu": 123,
    "name": "<string>",
    "port_security_enabled": true,
    "project_id": 1337,
    "region": "<string>",
    "region_id": 123,
    "segmentation_id": 9,
    "shared": true,
    "subnets": [
      {
        "cidr": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "enable_dhcp": true,
        "ip_version": 4,
        "name": "<string>",
        "network_id": "<string>",
        "project_id": 123,
        "region": "<string>",
        "region_id": 123,
        "tags": [
          {
            "key": "<string>",
            "read_only": true,
            "value": "<string>"
          }
        ],
        "updated_at": "2023-11-07T05:31:56Z",
        "available_ips": 250,
        "creator_task_id": "5cc890da-d031-4a23-ac31-625edfa22812",
        "dns_nameservers": [
          "8.8.8.8",
          "8.8.4.4"
        ],
        "gateway_ip": "192.168.13.1",
        "has_router": false,
        "host_routes": [],
        "id": "b39792c3-3160-4356-912e-ba396c95cdcf",
        "task_id": null,
        "total_ips": 253
      }
    ],
    "tags": [
      {
        "key": "<string>",
        "read_only": true,
        "value": "<string>"
      }
    ],
    "task_id": null,
    "type": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "network_id": "<string>",
  "port_id": "<string>",
  "port_security_enabled": true,
  "interface_name": "my-interface",
  "mac_address": "00:16:3e:f2:87:16"
}

POST

cloud

ports

{project_id}

{region_id}

{port_id}

enable_port_security

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
instance_interface = client.cloud.instances.enable_port_security(
    port_id="port_id",
    project_id=0,
    region_id=0,
)
print(instance_interface.network_id)

{
  "allowed_address_pairs": [
    {
      "ip_address": "<string>",
      "mac_address": "<string>"
    }
  ],
  "floatingip_details": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "creator_task_id": "d1e1500b-e2be-40aa-9a4b-cc493fa1af30",
      "fixed_ip_address": "192.168.10.15",
      "floating_ip_address": "172.24.4.34",
      "id": "<string>",
      "port_id": "ee2402d0-f0cd-4503-9b75-69be1d11c5f1",
      "project_id": 123,
      "region": "<string>",
      "region_id": 123,
      "router_id": "11005a33-c5ac-4c96-ab6f-8f2827cc7da6",
      "status": "ACTIVE",
      "tags": [
        {
          "key": "<string>",
          "read_only": true,
          "value": "<string>"
        }
      ],
      "task_id": "a4eb4b29-048e-42f6-a5e1-2c18bc001c45",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "ip_assignments": [
    {
      "ip_address": "<string>",
      "subnet_id": "<string>"
    }
  ],
  "network_details": {
    "created_at": "2023-11-07T05:31:56Z",
    "creator_task_id": "fd50fdd1-0482-4c9b-b847-fc9924665af6",
    "default": true,
    "external": true,
    "id": "<string>",
    "mtu": 123,
    "name": "<string>",
    "port_security_enabled": true,
    "project_id": 1337,
    "region": "<string>",
    "region_id": 123,
    "segmentation_id": 9,
    "shared": true,
    "subnets": [
      {
        "cidr": "<string>",
        "created_at": "2023-11-07T05:31:56Z",
        "enable_dhcp": true,
        "ip_version": 4,
        "name": "<string>",
        "network_id": "<string>",
        "project_id": 123,
        "region": "<string>",
        "region_id": 123,
        "tags": [
          {
            "key": "<string>",
            "read_only": true,
            "value": "<string>"
          }
        ],
        "updated_at": "2023-11-07T05:31:56Z",
        "available_ips": 250,
        "creator_task_id": "5cc890da-d031-4a23-ac31-625edfa22812",
        "dns_nameservers": [
          "8.8.8.8",
          "8.8.4.4"
        ],
        "gateway_ip": "192.168.13.1",
        "has_router": false,
        "host_routes": [],
        "id": "b39792c3-3160-4356-912e-ba396c95cdcf",
        "task_id": null,
        "total_ips": 253
      }
    ],
    "tags": [
      {
        "key": "<string>",
        "read_only": true,
        "value": "<string>"
      }
    ],
    "task_id": null,
    "type": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "network_id": "<string>",
  "port_id": "<string>",
  "port_security_enabled": true,
  "interface_name": "my-interface",
  "mac_address": "00:16:3e:f2:87:16"
}

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

region_id

integer

required

Region ID

port_id

string

required

Port ID

Response

200 - application/json

Instance network interface

allowed_address_pairs

AllowedAddressPairsSerializer · object[]

required

Group of subnet masks and/or IP addresses that share the current IP as VIP

Show child attributes

allowed_address_pairs.ip_address

required

Subnet mask or IP address of the port specified in allowed_address_pairs

allowed_address_pairs.mac_address

string | null

MAC address of the port specified in allowed_address_pairs

floatingip_details

FloatingIPSerializer · object[]

required

Bodies of floating IPs that are NAT-ing IPs of this port

Show child attributes

floatingip_details.created_at

string<date-time>

required

Datetime when the floating IP was created

floatingip_details.creator_task_id

string<uuid4> | null

required

Task that created this entity

Example:

"d1e1500b-e2be-40aa-9a4b-cc493fa1af30"

floatingip_details.fixed_ip_address

string<ipvanyaddress> | null

required

IP address of the port the floating IP is attached to

Example:

"192.168.10.15"

floatingip_details.floating_ip_address

string<ipvanyaddress> | null

required

IP Address of the floating IP

Example:

"172.24.4.34"

floatingip_details.id

string<uuid4>

required

Floating IP ID

floatingip_details.port_id

string<uuid4> | null

required

Port ID the floating IP is attached to. The fixed_ip_address is the IP address of the port.

Example:

"ee2402d0-f0cd-4503-9b75-69be1d11c5f1"

floatingip_details.project_id

integer

required

Project ID

floatingip_details.region

string

required

Region name

floatingip_details.region_id

integer

required

Region ID

floatingip_details.router_id

string<uuid4> | null

required

Router ID

Example:

"11005a33-c5ac-4c96-ab6f-8f2827cc7da6"

floatingip_details.status

enum<string> | null

required

Floating IP status. DOWN - unassigned (available). ACTIVE - attached to a port (in use). ERROR - error state.

Available options:

ACTIVE,

DOWN,

ERROR

Example:

"ACTIVE"

floatingip_details.tags

TagSerializer · object[]

required

List of key-value tags associated with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

Show child attributes

floatingip_details.tags.key

string

required

Tag key. The maximum size for a key is 255 characters.

floatingip_details.tags.read_only

boolean

required

If true, the tag is read-only and cannot be modified by the user

floatingip_details.tags.value

string

required

Tag value. The maximum size for a value is 255 characters.

floatingip_details.task_id

string<uuid4> | null

required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

Example:

"a4eb4b29-048e-42f6-a5e1-2c18bc001c45"

floatingip_details.updated_at

string<date-time>

required

Datetime when the floating IP was last updated

ip_assignments

PortIpSubnetIdSerializer · object[]

required

IP addresses assigned to this port

Show child attributes

ip_assignments.ip_address

string<ipvanyaddress>

required

IP address

ip_assignments.subnet_id

string<uuid4>

required

ID of the subnet that allocated the IP

network_details

NetworkSubnetworkSerializer · object

required

Body of the network this port is attached to

Show child attributes

network_details.created_at

string<date-time>

required

Datetime when the network was created

network_details.creator_task_id

string<uuid4> | null

required

Task that created this entity

Example:

"fd50fdd1-0482-4c9b-b847-fc9924665af6"

network_details.default

boolean | null

required

True if network has is_default attribute

Example:

true

network_details.external

boolean

required

True if the network router:external attribute

network_details.id

string<uuid4>

required

Network ID

network_details.mtu

integer

required

MTU (maximum transmission unit). Default value is 1450

network_details.name

string

required

Network name

network_details.port_security_enabled

boolean

required

Indicates port_security_enabled status of all newly created in the network ports.

network_details.project_id

integer | null

required

Project ID

Example:

1337

network_details.region

string

required

Region name

network_details.region_id

integer

required

Region ID

network_details.segmentation_id

integer | null

required

Id of network segment

Example:

9

network_details.shared

boolean

required

True when the network is shared with your project by external owner

network_details.subnets

SubnetSerializer · object[]

required

List of subnets associated with the network

Show child attributes

network_details.subnets.cidr

string<ipvanynetwork>

required

CIDR

network_details.subnets.created_at

string<date-time>

required

Datetime when the subnet was created

network_details.subnets.enable_dhcp

boolean

required

True if DHCP should be enabled

network_details.subnets.ip_version

enum<integer>

required

IP version

Available options:

4,

6

network_details.subnets.name

string

required

Subnet name

network_details.subnets.network_id

string<uuid4>

required

Network ID

network_details.subnets.project_id

integer

required

Project ID

network_details.subnets.region

string

required

Region name

network_details.subnets.region_id

integer

required

Region ID

network_details.subnets.tags

TagSerializer · object[]

required

Show child attributes

network_details.subnets.tags.key

string

required

Tag key. The maximum size for a key is 255 characters.

network_details.subnets.tags.read_only

boolean

required

If true, the tag is read-only and cannot be modified by the user

network_details.subnets.tags.value

string

required

Tag value. The maximum size for a value is 255 characters.

network_details.subnets.updated_at

string<date-time>

required

Datetime when the subnet was last updated

network_details.subnets.available_ips

integer | null

Number of available ips in subnet

Example:

250

network_details.subnets.creator_task_id

string<uuid4> | null

Task that created this entity

Example:

"5cc890da-d031-4a23-ac31-625edfa22812"

network_details.subnets.dns_nameservers

string<ipvanyaddress>[] | null

List IP addresses of a DNS resolver reachable from the network

Example:

["8.8.8.8", "8.8.4.4"]

network_details.subnets.gateway_ip

string<ipvanyaddress> | null

Default GW IPv4 address, advertised in DHCP routes of this subnet. If null, no gateway is advertised by this subnet.

Example:

"192.168.13.1"

network_details.subnets.has_router

boolean

default:false

deprecated

Deprecated. Always returns false.

network_details.subnets.host_routes

RouteOutSerializer · object[] | null

List of custom static routes to advertise via DHCP.

Show child attributes

network_details.subnets.host_routes.destination

string<ipvanynetwork>

required

CIDR of destination IPv4 subnet.

network_details.subnets.host_routes.nexthop

string<ipvanyaddress>

required

IPv4 address to forward traffic to if it's destination IP matches 'destination' CIDR.

Example:

[]

network_details.subnets.id

string<uuid4> | null

Subnet id.

Example:

"b39792c3-3160-4356-912e-ba396c95cdcf"

network_details.subnets.task_id

string<uuid4> | null

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

Example:

null

network_details.subnets.total_ips

integer | null

Total number of ips in subnet

Example:

253

network_details.tags

TagSerializer · object[]

required

Show child attributes

network_details.tags.key

string

required

Tag key. The maximum size for a key is 255 characters.

network_details.tags.read_only

boolean

required

If true, the tag is read-only and cannot be modified by the user

network_details.tags.value

string

required

Tag value. The maximum size for a value is 255 characters.

network_details.task_id

string<uuid4> | null

required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

Example:

null

network_details.type

string

required

Network type (vlan, vxlan)

network_details.updated_at

string<date-time>

required

Datetime when the network was last updated

network_id

string<uuid4>

required

ID of the network the port is attached to

port_id

string<uuid4>

required

ID of virtual ethernet port object

port_security_enabled

boolean

required

Port security status

interface_name

string | null

Interface name

Example:

"my-interface"

mac_address

string | null

MAC address of the virtual port

Example:

"00:16:3e:f2:87:16"

Disable port security for instance interface Preview instance price

⌘I

Overview

IAM

CDN

Managed DNS

Cloud

DDoS Protection

FastEdge

WAAP

Streaming

Object Storage

Resellers

Enable port security for instance interface

Authorizations

Path Parameters

Response