Create static route

POST

/network/route

curl --request POST \
  --url https://sylve.lan:8181/api/network/route \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "example", "destination": "example", "destinationObjId": 1, "destinationRaw": "example", "destinationType": "host", "enabled": true, "family": "inet", "fib": 1, "gateway": "example", "gatewayObjId": 1, "gatewayRaw": "example", "gatewayZone": "example", "interface": "example", "name": "example", "nextHopMode": "gateway" }'

Create and apply a static route

Authorizations

• BearerAuth

Request Body

Static Route Request

Media typeapplication/json

object

description

string

<= 2048 characters

destination

string

<= 256 characters

destinationObjId

integer

destinationRaw

string

<= 256 characters

destinationType

required

string

Allowed values: host network

enabled

boolean

family

required

string

Allowed values: inet inet6

fib

integer

gateway

string

<= 256 characters

gatewayObjId

integer

gatewayRaw

string

<= 256 characters

gatewayZone

string

<= 64 characters

interface

string

<= 64 characters

name

required

string

<= 128 characters

nextHopMode

required

string

Allowed values: gateway interface

Responses

201

Created

Media typeapplication/json

object

data

integer

error

string

message

string

status

string

Example^generated

{
  "data": 1,
  "error": "example",
  "message": "example",
  "status": "example"
}

400

Bad Request

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

401

Unauthorized

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

403

Forbidden

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

409

Conflict

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

413

Request Entity Too Large

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}

500

Internal Server Error

Media typeapplication/json

object

data

error

string

message

string

status

string

Example^generated

{
  "data": "example",
  "error": "example",
  "message": "example",
  "status": "example"
}