Networking

Create segment

POST/v1/baremetal/{id}/segments

Creates a segment from the given interfaces, queues the switch reconfiguration and returns the new segment.

curl --request POST \
  --url https://api.serverside.com/v1/baremetal/{id}/segments \
  --header 'Authorization: Bearer <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "interfaceIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}
'

{
  "success": true,
  "data": {
    "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "bondMode": "LACP",
    "physicalInterfaces": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "macAddress": "<string>",
        "speedMbps": 123,
        "segmentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "networks": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "type": "PRIVATE",
        "managedBy": "CUSTOMER",
        "localVlanId": 123,
        "provisioningVlanId": 123,
        "isNative": true,
        "prefixes": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "createdAt": "2026-01-15T09:30:00Z",
            "cidr": "<string>",
            "gateway": "<string>",
            "subnetMask": "<string>",
            "prefixLength": 123,
            "addresses": [
              "<string>"
            ]
          }
        ]
      }
    ]
  }
}

Authorizations

Authorizationstringheaderrequired
Organization API key (org_...), created in the cloud console at https://cloud.serverside.com and shown once, sent as Authorization: Bearer <key>. It authenticates as the organization.

Required permission: organization.baremetal.networking

Path parameters

idstring<uuid>required

Body

application/json

interfaceIdsstring<uuid>[]required
Limits:items >= 1

Response

201 · application/json

Created

successbooleanrequired
Allowed values:true
dataobject | nullrequired

Authorizations

Path parameters

Body

Response

Footer