Endpoint

/v1/cluster/nodes/{id}/uid-light

GET

Status of the identification (UID) light for this node.

Parameters

Name Description Required
id The unique ID of the node Yes

Response

Codes

Code Description
200 Return value on success

Schema

{
  "description": "api_node_uid_light",
  "type": "object",
  "properties": {
    "light_visible": {
      "description": "Visibility of the node identifier light",
      "type": "boolean"
    }
  }
}

POST

Turn the identification light on the node on or off. There may be a slight delay for the change to take effect.

Parameters

Name Description Required
id The unique ID of the node Yes

Request

Schema

{
  "description": "api_node_uid_light",
  "type": "object",
  "properties": {
    "light_visible": {
      "description": "Visibility of the node identifier light",
      "type": "boolean"
    }
  }
}

Response

Codes

Code Description
200 Return value on success