Create interface

POST

/api/interfaces

curl --request POST \
  --url http://localhost:3000/api/interfaces \
  --header 'Content-Type: application/json' \
  --cookie session=<session> \
  --data '{ "deviceId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "name": "example", "portType": "1000base-t", "status": "enabled", "linkStatus": "up", "description": "example", "portGroupLabel": "example", "portIndex": 1, "connectorType": "example", "speeds": [ "example" ], "poeStandard": "example", "poeWatts": 1, "transceiver": "example", "mgig": false, "breakoutCapable": false, "moduleSlot": "example", "macAddress": "example", "vlan": "example" }'

• Local development
• Dedicated / self-hosted instance

Authorizations

• cookieAuth

Request Body ^required

Media type application/json

object

deviceId

required

string format: uuid

name

required

string

portType

string

default: 1000base-t

status

string

default: enabled

Allowed values: enabled disabled planned

linkStatus

string

default: up

Allowed values: up down unknown

description

string

portGroupLabel

string

portIndex

integer

connectorType

string

speeds

Array<string>

poeStandard

string

poeWatts

integer

<= 1000

transceiver

string

mgig

boolean

breakoutCapable

boolean

moduleSlot

string

macAddress

string

vlan

string

Responses

201

Interface created

Media type application/json

object

data

object

id

required

string format: uuid

deviceId

required

string format: uuid

name

required

string

portType

required

string

default: 1000base-t

status

required

string

Allowed values: enabled disabled planned

linkStatus

required

string

Allowed values: up down unknown

peer

string

nullable

vlan

string

nullable

lldp

string

nullable

errs

integer

description

string

nullable

portGroupLabel

string

nullable

portIndex

integer

nullable

connectorType

string

nullable

speeds

Array<string>

poeStandard

string

nullable

poeWatts

integer

nullable

transceiver

string

nullable

mgig

boolean

breakoutCapable

boolean

moduleSlot

string

nullable

macAddress

string

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

Example

{
  "data": {
    "portType": "1000base-t",
    "status": "enabled",
    "linkStatus": "up"
  }
}

400

Validation error

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}

401

Not authenticated

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}