Support for Server products ended Feb. 15, 2024. Learn what this means for you.

Server

Jira Data Center / / Modules

cluster

Operations

PUT/api/2/cluster/index-snapshot/{nodeId}DEL/api/2/cluster/node/{nodeId}PUT/api/2/cluster/node/{nodeId}/offline GET/api/2/cluster/nodes POST/api/2/cluster/zdu/approve POST/api/2/cluster/zdu/cancel POST/api/2/cluster/zdu/retryUpgrade POST/api/2/cluster/zdu/start GET/api/2/cluster/zdu/state

PUT

Request node index snapshot

Request current index from node (the request is processed asynchronously)

Request

Path parameters

nodeId

string

Required

Responses

Request was successful

PUT/api/2/cluster/index-snapshot/{nodeId}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'http://{baseurl}/rest/api/2/cluster/index-snapshot/{nodeId}' \
  --user 'email@example.com:<api_token>'

DEL

Delete a cluster node

Delete the node from the cluster if state of node is OFFLINE.

Request

Path parameters

nodeId

string

Required

Responses

Removal was successful

DEL/api/2/cluster/node/{nodeId}

curl

Node.js

Java

Python

PHP

1
2
3

curl --request DELETE \
  --url 'http://{baseurl}/rest/api/2/cluster/node/{nodeId}' \
  --user 'email@example.com:<api_token>'

PUT

Update node state to offline

Change the node's state to offline if the node is reporting as active, but is not alive.

Request

Path parameters

nodeId

string

Required

Responses

State change was successful

PUT/api/2/cluster/node/{nodeId}/offline

curl

Node.js

Java

Python

PHP

1
2
3

curl --request PUT \
  --url 'http://{baseurl}/rest/api/2/cluster/node/{nodeId}/offline' \
  --user 'email@example.com:<api_token>'

GET

Get all cluster nodes

Returns all nodes in cluster.

Request

This request has no parameters.

Responses

Returns a list of all nodes in the cluster.

application/json

NodeBean

GET/api/2/cluster/nodes

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/cluster/nodes' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'

POST

Approve cluster upgrade

Approves the cluster upgrade.

Request

This request has no parameters.

Responses

Upgrade approval was successful

POST/api/2/cluster/zdu/approve

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/2/cluster/zdu/approve' \
  --user 'email@example.com:<api_token>'

POST

Cancel cluster upgrade

Cancels the ongoing cluster upgrade.

Request

This request has no parameters.

Responses

Upgrade cancellation was successful

POST/api/2/cluster/zdu/cancel

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/2/cluster/zdu/cancel' \
  --user 'email@example.com:<api_token>'

POST

Retry cluster upgrade

Retries the cluster upgrade.

Request

This request has no parameters.

Responses

Upgrade retry was successful

POST/api/2/cluster/zdu/retryUpgrade

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/2/cluster/zdu/retryUpgrade' \
  --user 'email@example.com:<api_token>'

POST

Start cluster upgrade

Starts the cluster upgrade.

Request

This request has no parameters.

Responses

Upgrade start was successful

POST/api/2/cluster/zdu/start

curl

Node.js

Java

Python

PHP

1
2
3

curl --request POST \
  --url 'http://{baseurl}/rest/api/2/cluster/zdu/start' \
  --user 'email@example.com:<api_token>'

GET

Get cluster upgrade state

Returns the current state of the cluster upgrade.

Request

This request has no parameters.

Responses

Returns the current state of the cluster upgrade.

application/json

ClusterState

GET/api/2/cluster/zdu/state

curl

Node.js

Java

Python

PHP

curl --request GET \
  --url 'http://{baseurl}/rest/api/2/cluster/zdu/state' \
  --user 'email@example.com:<api_token>' \
  --header 'Accept: application/json'