ByCloud Docs
GuidesCLIAPISDK
patch/v1/networks/{network_id}

Update network

Update a network

Path Parameters

network_id

string<uuid>required

path

Network ID

Example: "550e8400-e29b-41d4-a716-446655440000"

Request Body

required

Content-Type: application/json

name

stringoptional

description

stringoptional

mtu

integeroptional

port_security_enabled

booleanoptional

dns_domain

stringoptional

tags

arrayoptional

Responses

200

Network updated

Content-Type: application/json

network

objectoptional
400

Invalid request parameters

Content-Type: application/json

error

objectrequired
401

Authentication required or token invalid

Content-Type: application/json

error

objectrequired
404

Resource not found

Content-Type: application/json

error

objectrequired
500

Internal server error

Content-Type: application/json

error

objectrequired
curl -X PATCH "https://api.spo1.mycloud.com/v1/networks/550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "description": "string",
    "mtu": 1,
    "port_security_enabled": true,
    "dns_domain": "string",
    "tags": [
      "web",
      "frontend"
    ]
  }'

Response

Network updated

{
  "network": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "crn": "crn:spo1:network:network:550e8400-e29b-41d4-a716-446655440000",
    "name": "private-network",
    "description": "Internal private network",
    "status": "ACTIVE",
    "mtu": 1500,
    "port_security_enabled": true,
    "dns_domain": "mycloud.local",
    "subnets": [
      "550e8400-e29b-41d4-a716-446655440000"
    ],
    "tags": [
      "web",
      "frontend"
    ],
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
}