Set network config overrides

PUT

/v1/networks/{networkID}/config-overrides

• Default server

Replace the Nebula config overrides set directly on this network. Pass an empty list to remove them all.

Token scope required: networks:update

Authorizations

• ApiToken
  networks:update

Parameters

Path Parameters

networkID

required

string

Example

network-ZJOW3QUQUX5ZAVPVYRHDQUAEIY

Request Body ^required

object

overrides

required

List of config overrides for the nebula config. Each key may appear at most once. Responses may include keys that aren’t documented; since setting overrides replaces the whole list, keep entries you don’t recognize when writing a list back.

Array<object>

ConfigOverride

A single Nebula config override. key names the Nebula config option and determines the type of value; see Config override keys for the documented keys and their value types, and the Nebula config reference for what each option does.

object

key

required

string

Example

tun.mtu

value

required

The override’s value. Its type depends on key.

Example

1300

Example

{
  "overrides": [
    {
      "key": "logging.level",
      "value": "debug"
    },
    {
      "key": "tun.mtu",
      "value": 1300
    }
  ]
}

Responses

200

Successful operation

object

data

required

object

overrides

required

List of config overrides for the nebula config. Each key may appear at most once. Responses may include keys that aren’t documented; since setting overrides replaces the whole list, keep entries you don’t recognize when writing a list back.

Array<object>

ConfigOverride

A single Nebula config override. key names the Nebula config option and determines the type of value; see Config override keys for the documented keys and their value types, and the Nebula config reference for what each option does.

object

key

required

string

Example

tun.mtu

value

required

The override’s value. Its type depends on key.

Example

1300

Example

{
  "data": {
    "overrides": [
      {
        "key": "logging.level",
        "value": "debug"
      },
      {
        "key": "tun.mtu",
        "value": 1300
      }
    ]
  }
}

400

Validation error

object

errors

required

Array<object>

object

code

required

A static name for the error type

string

message

required

A short human readable description of the error

string

path

Describes the variable missing or malformed

string

param

The query parameter the error relates to, such as filter.targetType

string

extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object

limit

The maximum number of resources allowed

integer

limitName

The kind of resource the limit applies to

string

key

additional properties

any

Examples

The key is not an allowed override.

{
  "errors": [
    {
      "code": "ERR_INVALID_VALUE",
      "message": "must be an allowed override option",
      "path": "overrides[0].key"
    }
  ]
}

The same key appears more than once.

{
  "errors": [
    {
      "code": "ERR_INVALID_VALUE",
      "message": "must not be duplicated",
      "path": "overrides[1].key"
    }
  ]
}

The value is not valid for the key.

{
  "errors": [
    {
      "code": "ERR_INVALID_VALUE",
      "message": "must be one of: trace, debug, info, warning, error, fatal, panic",
      "path": "overrides[0].value"
    }
  ]
}

401

The API key is missing, invalid or expired.

object

errors

required

Array<object>

object

code

required

A static name for the error type

string

message

required

A short human readable description of the error

string

path

Describes the variable missing or malformed

string

param

The query parameter the error relates to, such as filter.targetType

string

extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object

limit

The maximum number of resources allowed

integer

limitName

The kind of resource the limit applies to

string

key

additional properties

any

Example

{
  "errors": [
    {
      "code": "ERR_UNAUTHORIZED",
      "message": "unauthorized"
    }
  ]
}

403

The API key lacks a required scope.

object

errors

required

Array<object>

object

code

required

A static name for the error type

string

message

required

A short human readable description of the error

string

path

Describes the variable missing or malformed

string

param

The query parameter the error relates to, such as filter.targetType

string

extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object

limit

The maximum number of resources allowed

integer

limitName

The kind of resource the limit applies to

string

key

additional properties

any

Examples

The API key lacks a required scope.

{
  "errors": [
    {
      "code": "ERR_FORBIDDEN",
      "message": "api key must support the following scopes: hosts:read"
    }
  ]
}

404

Network not found

object

errors

required

Array<object>

object

code

required

A static name for the error type

string

message

required

A short human readable description of the error

string

path

Describes the variable missing or malformed

string

param

The query parameter the error relates to, such as filter.targetType

string

extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object

limit

The maximum number of resources allowed

integer

limitName

The kind of resource the limit applies to

string

key

additional properties

any

Example

{
  "errors": [
    {
      "code": "ERR_NOT_FOUND",
      "message": "resource not found"
    }
  ]
}

429

The organization has exceeded its API request rate limit. Retry the request after a short delay.

object

errors

required

Array<object>

object

code

required

A static name for the error type

string

message

required

A short human readable description of the error

string

path

Describes the variable missing or malformed

string

param

The query parameter the error relates to, such as filter.targetType

string

extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object

limit

The maximum number of resources allowed

integer

limitName

The kind of resource the limit applies to

string

key

additional properties

any

Example

{
  "errors": [
    {
      "code": "ERR_TOO_MANY_REQUESTS",
      "message": "too many requests"
    }
  ]
}