HEhexlet
Node

Update a node

Changed on
post/nodes/{id}/update

Request

  • Base URL
    /v1.57 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    none declared

Path parameters

idstring required

The ID of the node

Query parameters

versioninteger required

The version number of the node object being updated. This is required to avoid conflicting writes.

Request body

Namestring

Name for the node.

Labelsobject

User-defined key/value metadata.

Role'worker' | 'manager'

Role of the node.

Availability'active' | 'pause' | 'drain'

Availability of the node.

Example request

{
  "Availability": "active",
  "Name": "node-name",
  "Role": "manager",
  "Labels": {
    "foo": "bar"
  }
}

Response

no error

Changes

  • 6df97b60796cRevision changes
    • breaking

      removed the request body

    • breaking

      removed the success response with the status

    • info

      api tag Node added

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the success response with the status

  • 31f80d10d31aRevision changes
    • breaking

      request body became required

    • breaking

      removed the media type text/plain from the request body

    • breaking

      removed the success response with the status

    • info

      api tag Node removed

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      added the success response with the status