Update device port

PATCH

/api/devices/{id}/ports/{portId}

curl --request PATCH \
  --url http://localhost:3000/api/devices/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/ports/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Content-Type: application/json' \
  --cookie session=<session> \
  --data '{}'

• Local development
• Dedicated / self-hosted instance

Authorizations

• cookieAuth

Parameters

Path Parameters

id

required

string format: uuid

portId

required

string format: uuid

Request Body ^required

Media type application/json

Any subset of the port create body

object

Example ^generated

{}

Responses

200

Port updated

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"
}

404

Port not found

Media type application/json

object

error

required

string

Example

{
  "error": "Not found"
}