Create network
POST /v2/networks
Create a new IPv6-capable network. The IPv6 CIDR is generated automatically. Optionally supply an IPv4 CIDR to make the network dual-stack.
Token scope required: networks:create
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”object
Name of the network
Example
ManagementOptional description of the network
Example
This network allows the ops team to manage infrastructureAt most one IPv4 CIDR to assign to the network. It must be a private or carrier-grade NAT range with a mask between /8 and /30. Do not supply an IPv6 CIDR; one is generated for every network.
Example
[ "100.100.0.0/22"]Should the lighthouses in this network be configured as relays? Defaults to true.
This applies to the managed lighthouse as well as to any lighthouse you run yourself. When enabled on a network using the managed lighthouse, traffic between hosts that cannot connect directly may be relayed through Defined Networking’s infrastructure. Relayed traffic remains encrypted end-to-end between the two hosts.
Example
trueCryptographic curve used by the network’s certificates. Defaults to 25519.
Example
25519Opt this network out of the managed lighthouse. Defaults to false, meaning
Defined Networking runs a lighthouse for the network.
Set this to true only if you run your own lighthouses; a network with no
reachable lighthouse cannot perform peer discovery.
Responses
Section titled “ Responses ”Successful operation
object
object
The ID of the Certificate Authority being used.
List of CIDR prefixes assigned to this network. IPv4-only networks have exactly one IPv4 entry. IPv6-capable networks always have an IPv6 CIDR and optionally an IPv4 CIDR.
Certificate version used by this network. Version 2 is required for IPv6 support. Known values are 1 and 2. New values may be added, so clients should accept values not listed here.
Whether this network has opted out of the managed lighthouse. When false, Defined
Networking runs a lighthouse for the network and no lighthouse of your own is required.
Cryptographic curve used by the network’s certificates. Known values are 25519 and P256. New values may be added, so clients should accept values not listed here.
Example
{ "data": { "id": "network-ZJOW3QUQUX5ZAVPVYRHDQUAEIY", "organizationID": "org-F63A24JGCLJV3ZEUTLCBISGETA", "signingCAID": "ca-TRJSVAAAPJXTOICJMG2KZBKQEE", "name": "Management", "description": "This network allows the ops team to manage infrastructure", "cidrs": [ "100.100.0.0/22", "fdef:c0:c0:1::/80" ], "certVersion": 2, "hostCount": 0, "lighthousesAsRelays": true, "disableManagedLighthouses": false, "curve": "25519", "createdAt": "2023-02-14T20:34:59Z" }}Validation error
object
object
A static name for the error type
A short human readable description of the error
Describes the variable missing or malformed
The query parameter the error relates to, such as filter.targetType
Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.
object
The maximum number of resources allowed
The kind of resource the limit applies to
Examples
A network already exists with the name.
{ "errors": [ { "code": "ERR_DUPLICATE_VALUE", "message": "value already exists", "path": "name" } ]}An IPv6 CIDR was supplied in `cidrs`.
{ "errors": [ { "code": "ERR_INVALID_IPV4_CIDR", "message": "only IPv4 CIDR prefixes may be specified; IPv6 is auto-generated", "path": "cidrs[0]" } ]}The IPv4 CIDR is not in private or carrier-grade NAT address space.
{ "errors": [ { "code": "ERR_INVALID_PRIVATE_NETWORK_CIDR", "message": "must describe a private or carrier-grade NAT range", "path": "cidrs[0]" } ]}The organization has reached its network limit.
{ "errors": [ { "code": "ERR_LIMIT_EXCEEDED", "message": "no more than 10 networks are allowed", "extra": { "limit": 10, "limitName": "networks" } } ]}The API key is missing, invalid or expired.
object
object
A static name for the error type
A short human readable description of the error
Describes the variable missing or malformed
The query parameter the error relates to, such as filter.targetType
Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.
object
The maximum number of resources allowed
The kind of resource the limit applies to
Example
{ "errors": [ { "code": "ERR_UNAUTHORIZED", "message": "unauthorized" } ]}The API key lacks a required scope.
object
object
A static name for the error type
A short human readable description of the error
Describes the variable missing or malformed
The query parameter the error relates to, such as filter.targetType
Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.
object
The maximum number of resources allowed
The kind of resource the limit applies to
Examples
The API key lacks a required scope.
{ "errors": [ { "code": "ERR_FORBIDDEN", "message": "api key must support the following scopes: hosts:read" } ]}The organization has exceeded its API request rate limit. Retry the request after a short delay.
object
object
A static name for the error type
A short human readable description of the error
Describes the variable missing or malformed
The query parameter the error relates to, such as filter.targetType
Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.
object
The maximum number of resources allowed
The kind of resource the limit applies to
Example
{ "errors": [ { "code": "ERR_TOO_MANY_REQUESTS", "message": "too many requests" } ]}