ByCloud Docs
GuidesCLIAPISDK
post/v1/ports

Create port

Create a new port on a network

Request Body

required

Content-Type: application/json

name

stringoptional

description

stringoptional

network_id

string<uuid>required

mac_address

stringoptional

MAC address (auto-generated if omitted)

fixed_ips

arrayoptional

security_groups

arrayoptional

port_security_enabled

booleanoptional

Default: true

allowed_address_pairs

arrayoptional

dns_name

stringoptional

tags

arrayoptional

Responses

201

Port created

Content-Type: application/json

port

objectoptional
400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
404

Network not found

Content-Type: application/json

error

objectrequired
409

Resource conflict (e.g., already exists, invalid state)

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X POST "https://api.spo1.mycloud.com/v1/ports" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "network_id": "550e8400-e29b-41d4-a716-446655440000",
    "mac_address": "string",
    "fixed_ips": [
      {
        "subnet_id": "550e8400-e29b-41d4-a716-446655440000",
        "ip_address": "string"
      }
    ],
    "security_groups": [
      "550e8400-e29b-41d4-a716-446655440000"
    ],
    "port_security_enabled": true,
    "allowed_address_pairs": [
      {
        "ip_address": "192.168.1.100",
        "mac_address": "fa:16:3e:4f:5a:2b"
      }
    ],
    "dns_name": "string",
    "tags": [
      "web",
      "frontend"
    ]
  }'

Response

Port created

{
  "port": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "crn": "crn:spo1:network:port:550e8400-e29b-41d4-a716-446655440000",
    "name": "web-server-port",
    "description": "string",
    "network_id": "550e8400-e29b-41d4-a716-446655440001",
    "status": "ACTIVE",
    "mac_address": "fa:16:3e:4f:5a:2b",
    "fixed_ips": [
      {
        "subnet_id": "550e8400-e29b-41d4-a716-446655440000",
        "ip_address": "192.168.1.10"
      }
    ],
    "device_id": "string",
    "device_owner": "compute:nova",
    "security_groups": [
      "550e8400-e29b-41d4-a716-446655440000"
    ],
    "port_security_enabled": true,
    "allowed_address_pairs": [
      {
        "ip_address": "192.168.1.100",
        "mac_address": "fa:16:3e:4f:5a:2b"
      }
    ],
    "dns_name": "string",
    "dns_assignment": [
      {
        "hostname": "string",
        "ip_address": "string",
        "fqdn": "string"
      }
    ],
    "tags": [
      "web",
      "frontend"
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}