Sign in
Node

Modify Node

Modify 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
usage_coefficientnumber nullable
connection_type'grpc' | 'rest'
server_castring nullable
keep_aliveinteger nullable
core_config_idinteger nullable
api_keystring nullable
data_limitinteger nullable
data_limit_reset_strategy'no_reset' | 'day' | 'week' | 'month' | 'year'
reset_timeinteger nullable
default_timeoutinteger nullable
internal_timeoutinteger nullable
proxy_urlstring nullable
status'connected' | 'connecting' | 'error' | 'disabled' | 'limited'

Example request

{
  "address": "192.168.1.1",
  "api_key": "valid uuid",
  "connection_type": "grpc",
  "core_config_id": 1,
  "keep_alive": 60,
  "name": "DE node",
  "port": 62050,
  "server_ca": "-----BEGIN CERTIFICATE-----\n...\n-----END CERTIFICATE-----",
  "status": "disabled",
  "usage_coefficient": 1
}

Response

Successful Response

namestring required
addressstring required
portinteger
api_portinteger
usage_coefficientnumber
connection_type'grpc' | 'rest' required
server_castring required
keep_aliveinteger required
core_config_idinteger nullable required
api_keystring nullable required
data_limitinteger
data_limit_reset_strategy'no_reset' | 'day' | 'week' | 'month' | 'year'
reset_timeinteger
default_timeoutinteger
internal_timeoutinteger
proxy_urlstring nullable
idinteger required
xray_versionstring nullable required
node_versionstring nullable required
status'connected' | 'connecting' | 'error' | 'disabled' | 'limited' required
messagestring nullable required
uplinkinteger
downlinkinteger
lifetime_uplinkinteger nullable
lifetime_downlinkinteger nullable
core_versionstring nullable required

Changes