Skip to main content
POST
Create a private network

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

name
string
required

The name shown to customers.

Required string length: 1 - 64
Pattern: ^[\w\-. ]+$
location_id
integer
required

The location id ID.

subnet
string | null

The value of subnet.

Response

The record, as a JSON object. There is no envelope.

An isolated segment carrying traffic between the account's own servers in one city.

id
string
required

The id ID.

Example:

"5220f263-0e8e-4917-bf4f-4cae109ca4c5"

name
string
required

The name shown to customers.

Example:

"Sector C backbone"

subnet
string | null
required

The range members are addressed out of, and below, the address each one holds on it.

Example:

"10.24.0.0/24"

location
string | null
required

The network's city name, shared by locations in the same city. Used in the account-wide network list.

Example:

"Kansas City, MO"

attached
boolean
required

Whether the requested server is attached to this network.

Example:

true

attachment_status
enum<string> | null
required

The requested server's attachment status, or null when it is not attached.

Available options:
attaching,
attached,
detaching,
null
Example:

"attached"

members
PrivateNetworkMemberData · object[]
required

The value of members.

Example:
created_at
string | null
required

The date and time for created at, in UTC.

Example:

"2026-05-11T09:20:47+00:00"