Sign in
Node

Modify Node

Update a node's details. Only accessible to sudo admins.

put/api/node/{node_id}

Path parameters

node_idinteger required

Request body

namestring nullable
addressstring nullable
portinteger nullable
api_portinteger nullable
usage_coefficientnumber nullable
status'connected' | 'connecting' | 'error' | 'disabled'

Example request

{
  "address": "192.168.1.1",
  "api_port": 62051,
  "name": "DE node",
  "port": 62050,
  "status": "disabled",
  "usage_coefficient": 1
}

Response

Successful Response

namestring required
addressstring required
portinteger
api_portinteger
usage_coefficientnumber
idinteger required
xray_versionstring nullable
status'connected' | 'connecting' | 'error' | 'disabled' required
messagestring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.