Edit Network

PUT 
https://api.defined.net/v1/networks/:networkID

Edit an existing network.

Token scope required: networks:update

caution

Any properties not provided in the request will be reset to their default values.

Request

Path Parameters

networkID stringrequired
Example: network-ZJOW3QUQUX5ZAVPVYRHDQUAEIY

application/json

Bodyrequired

namestringrequired
Name of the network
Possible values: non-empty and <= 50 characters
Example: Management
descriptionstring
Optional description of the network
Example: This network allows the ops team to manage infrastructure
lighthousesAsRelaysboolean
Should the lighthouses in this network be configured as relays?
Example: false

Responses

200

Successful operation

application/json

Schema

Schema

data object
idstring
cidripv4/cidr
organizationIDstring
signingCAIDstring
The ID of the Certificate Authority being used.
createdAtdate-time
namestring
Default value: Network1
lighthousesAsRelaysboolean
curvestring
Possible values: [25519, P256]
metadataobject

Example (auto)

{
  "data": {
    "id": "network-KAOWMXZHZWCVMGGFKM22XEGYLE",
    "createdAt": "2023-02-14T20:34:59Z",
    "organizationID": "org-F63A24JGCLJV3ZEUTLCBISGETA",
    "signingCAID": "ca-TRJSVAAAPJXTOICJMG2KZBKQEE",
    "name": "Management",
    "description": "This network allows the ops team to manage infrastructure",
    "cidr": "192.168.4.0/22",
    "hostCount": 27,
    "lighthousesAsRelays": false,
    "curve": "25519"
  }
}

400

Validation error

application/json

Schema

Schema

errors object[]
Array [
codestringrequired
A static name for the error type
messagestringrequired
A short human readable description of the error
pathstringnullable
Describes the variable missing or malformed
]

Example (auto)

{
  "errors": [
    {
      "code": "string",
      "message": "string",
      "path": "string"
    }
  ]
}

existingNetworkName

A network already exists with the name.

{
  "errors": [
    {
      "code": "ERR_DUPLICATE_VALUE",
      "message": "value already exists",
      "path": "name"
    }
  ]
}

Authorization: http

name: ApiTokentype: httpdescription: Get an api key from https://admin.defined.net/settings/api-keys with the permission scopes required.
scheme: bearerbearerFormat: dnkey

• curl
• python
• go
• nodejs

• CURL

curl -L -X PUT 'https://api.defined.net/v1/networks/:networkID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "name": "Management",
  "description": "This network allows the ops team to manage infrastructure",
  "lighthousesAsRelays": false
}'

Request Collapse all

Base URL

https://api.defined.net

Auth

Bearer Token

Parameters

networkID — pathrequired

Body required

{
  "name": "Management",
  "description": "This network allows the ops team to manage infrastructure",
  "lighthousesAsRelays": false
}

ResponseClear

Click the Send API Request button above and see the response here!