Update a node

/v1.33

POST

/nodes/{id}/update

Node

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST '/v1.33/nodes//update?version=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "Availability": "active",
    "Labels": {
        "foo": "bar"
    },
    "Name": "node-name",
    "Role": "manager"
}'

Response Example

200 - Example 1

{}

Request

Path Params

string

required

The ID of the node

Query Params

version

integer

required

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

Body Params application/json

Availability

enum<string>

optional

Availability of the node.

Allowed values:

activepausedrain

Example:

active

Labels

object

optional

User-defined key/value metadata.

Additional properties

string

optional

Name

string

optional

Name for the node.

Example:

my-node

Role

enum<string>

optional

Role of the node.

Allowed values:

workermanager

Example:

manager

Examples

Responses

🟢200no error

application/json

Body

object {0}

🟠400bad parameter

🟠404no such node

🔴500server error

🔴503node is not part of a swarm

Modified at 2022-09-10 17:56:06

Inspect a node

List plugins