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

Last updated Apr 3, 2024

Rolling Upgrades

Provides Rolling Upgrade capabilities.

General information about using the REST APIs can be found at Using the REST API and Authenticating with the REST API.

Servers
Paths
Schemas
- ClusterStateResponse
- Link
- NodeInfoDTO
- Cluster

Servers

URL	Description
/rest/zdu	The ZDU REST resource for the server

Paths

`GET` /state

Gets the Cluster State

Gets the State of the Cluster and the responding Node's information.

Responses

▶ 200 - Returns full JSON representation of cluster state

Headers

No headers specified

application/json

Name	Type	Description	Accepted values
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
buildInfo	object	Represents a Cluster Node and its current state.	Any
buildInfo.id	string	The id of the Node in cluster.	Any
buildInfo.name	string	The name of the Node.	Any
buildInfo.ipAddress	string	The IP address of the Node.	Any
buildInfo.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
buildInfo.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
buildInfo.version	string	The version of the Node's installed Product.	Any
buildInfo.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
buildInfo.portNumber	integer		Any
buildInfo.links	array(object)	Hypermedia links	Any
buildInfo.links.rel	string	rel	Any
buildInfo.links.href	string	uri	Any

Example (generated)

1
2
{
  "state": "STABLE",
  "buildInfo": {
    "id": "string",
    "name": "string",
    "ipAddress": "string",
    "state": "STARTING",
    "buildNumber": "string",
    "version": "string",
    "local": true,
    "portNumber": 0,
    "links": [
      {
        "rel": "string",
        "href": "http://example.com"
      }
    ]
  }
}

▶ 401 - Returned if user is not authenticated

Headers

No headers specified

▶ 403 - Returned if the calling user does not have permission to view the content

Headers

No headers specified

`GET` /nodes/{nodeId}

Gets the Node's overview

Gets the requested Node's information.

Path parameters

▷ nodeId

Name	Type	In	Description	Accepted values
nodeId (required)	string	path		Any

Responses

▶ 200 - Returns full JSON representation of the cluster node

Headers

No headers specified

application/json

Name	Type	Description	Accepted values
id	string	The id of the Node in cluster.	Any
name	string	The name of the Node.	Any
ipAddress	string	The IP address of the Node.	Any
state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
version	string	The version of the Node's installed Product.	Any
local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
portNumber	integer		Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

Example (generated)

1
2
{
  "id": "string",
  "name": "string",
  "ipAddress": "string",
  "state": "STARTING",
  "buildNumber": "string",
  "version": "string",
  "local": true,
  "portNumber": 0,
  "links": [
    {
      "rel": "string",
      "href": "http://example.com"
    }
  ]
}

▶ 401 - Returned if user is not authenticated

Headers

No headers specified

▶ 403 - Returned if the calling user does not have permission to view the content

Headers

No headers specified

▶ 404 - Returned if there is no content with the given id

Headers

No headers specified

`GET` /cluster

Gets the Cluster overview

Gets an overview of a Cluster including its current state and composition of Nodes.

Responses

▶ 200 - Returns full JSON representation of the cluster

Headers

No headers specified

application/json

Name	Type	Description	Accepted values
upgradeModeEnabled	boolean	If true, it's safe to upgrade the nodes of the cluster	Any
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
originalVersion	string	The original product version when ZDU was enabled	Any
nodes	array(object)	The nodes which form the Cluster.	Any
nodes.id	string	The id of the Node in cluster.	Any
nodes.name	string	The name of the Node.	Any
nodes.ipAddress	string	The IP address of the Node.	Any
nodes.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
nodes.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
nodes.version	string	The version of the Node's installed Product.	Any
nodes.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
nodes.portNumber	integer		Any
nodes.links	array(object)	Hypermedia links	Any
nodes.links.rel	string	rel	Any
nodes.links.href	string	uri	Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

Example (generated)

1
2
{
  "upgradeModeEnabled": true,
  "state": "STABLE",
  "originalVersion": "string",
  "nodes": [
    {
      "id": "string",
      "name": "string",
      "ipAddress": "string",
      "state": "STARTING",
      "buildNumber": "string",
      "version": "string",
      "local": true,
      "portNumber": 0,
      "links": [
        {
          "rel": "string",
          "href": "http://example.com"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "string",
      "href": "http://example.com"
    }
  ]
}

▶ 401 - Returned if user is not authenticated

Headers

No headers specified

▶ 403 - Returned if the calling user does not have permission to view the content

Headers

No headers specified

`POST` /start

Start ZDU upgrade

Enables Upgrading of individual Nodes within the Cluster, allowing a heterogeneous Cluster formation.

Responses

▶ 200 - Returns full JSON representation of the cluster

Headers

No headers specified

application/json

Name	Type	Description	Accepted values
upgradeModeEnabled	boolean	If true, it's safe to upgrade the nodes of the cluster	Any
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
originalVersion	string	The original product version when ZDU was enabled	Any
nodes	array(object)	The nodes which form the Cluster.	Any
nodes.id	string	The id of the Node in cluster.	Any
nodes.name	string	The name of the Node.	Any
nodes.ipAddress	string	The IP address of the Node.	Any
nodes.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
nodes.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
nodes.version	string	The version of the Node's installed Product.	Any
nodes.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
nodes.portNumber	integer		Any
nodes.links	array(object)	Hypermedia links	Any
nodes.links.rel	string	rel	Any
nodes.links.href	string	uri	Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

Example (generated)

1
2
{
  "upgradeModeEnabled": true,
  "state": "STABLE",
  "originalVersion": "string",
  "nodes": [
    {
      "id": "string",
      "name": "string",
      "ipAddress": "string",
      "state": "STARTING",
      "buildNumber": "string",
      "version": "string",
      "local": true,
      "portNumber": 0,
      "links": [
        {
          "rel": "string",
          "href": "http://example.com"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "string",
      "href": "http://example.com"
    }
  ]
}

▶ 401 - Returned if user is not authenticated

Headers

No headers specified

▶ 403 - Returned if the calling user does not have permission to view the content

Headers

No headers specified

▶ 409 - Returned if the cluster is not in a valid state

Headers

No headers specified

`POST` /cancel

Cancel ZDU upgrade

Prohibits the Upgrading of individual Nodes within the Cluster. All Nodes need to be on the same version before performing this request.

Responses

▶ 200 - Returns full JSON representation of the cluster

Headers

No headers specified

application/json

Name	Type	Description	Accepted values
upgradeModeEnabled	boolean	If true, it's safe to upgrade the nodes of the cluster	Any
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
originalVersion	string	The original product version when ZDU was enabled	Any
nodes	array(object)	The nodes which form the Cluster.	Any
nodes.id	string	The id of the Node in cluster.	Any
nodes.name	string	The name of the Node.	Any
nodes.ipAddress	string	The IP address of the Node.	Any
nodes.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
nodes.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
nodes.version	string	The version of the Node's installed Product.	Any
nodes.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
nodes.portNumber	integer		Any
nodes.links	array(object)	Hypermedia links	Any
nodes.links.rel	string	rel	Any
nodes.links.href	string	uri	Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

Example (generated)

1
2
{
  "upgradeModeEnabled": true,
  "state": "STABLE",
  "originalVersion": "string",
  "nodes": [
    {
      "id": "string",
      "name": "string",
      "ipAddress": "string",
      "state": "STARTING",
      "buildNumber": "string",
      "version": "string",
      "local": true,
      "portNumber": 0,
      "links": [
        {
          "rel": "string",
          "href": "http://example.com"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "string",
      "href": "http://example.com"
    }
  ]
}

▶ 401 - Returned if user is not authenticated

Headers

No headers specified

▶ 403 - Returned if the calling user does not have permission to view the content

Headers

No headers specified

▶ 409 - Returned if the cluster is not in a valid state

Headers

No headers specified

`POST` /approve

Approve the ZDU upgrade

Finalizes the ZDU upgrade and runs specific tasks such as cleanup scripts.

Responses

▶ 200 - Returns full JSON representation of the cluster

Headers

No headers specified

application/json

Name	Type	Description	Accepted values
upgradeModeEnabled	boolean	If true, it's safe to upgrade the nodes of the cluster	Any
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
originalVersion	string	The original product version when ZDU was enabled	Any
nodes	array(object)	The nodes which form the Cluster.	Any
nodes.id	string	The id of the Node in cluster.	Any
nodes.name	string	The name of the Node.	Any
nodes.ipAddress	string	The IP address of the Node.	Any
nodes.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
nodes.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
nodes.version	string	The version of the Node's installed Product.	Any
nodes.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
nodes.portNumber	integer		Any
nodes.links	array(object)	Hypermedia links	Any
nodes.links.rel	string	rel	Any
nodes.links.href	string	uri	Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

Example (generated)

1
2
{
  "upgradeModeEnabled": true,
  "state": "STABLE",
  "originalVersion": "string",
  "nodes": [
    {
      "id": "string",
      "name": "string",
      "ipAddress": "string",
      "state": "STARTING",
      "buildNumber": "string",
      "version": "string",
      "local": true,
      "portNumber": 0,
      "links": [
        {
          "rel": "string",
          "href": "http://example.com"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "string",
      "href": "http://example.com"
    }
  ]
}

▶ 401 - Returned if user is not authenticated

Headers

No headers specified

▶ 403 - Returned if the calling user does not have permission to view the content

Headers

No headers specified

▶ 409 - Returned if the cluster is not in a valid state

Headers

No headers specified

▶ 500 - Internal Error

Headers

No headers specified

Schemas

ClusterStateResponse

Name	Type	Description	Accepted values
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
buildInfo	object	Represents a Cluster Node and its current state.	Any
buildInfo.id	string	The id of the Node in cluster.	Any
buildInfo.name	string	The name of the Node.	Any
buildInfo.ipAddress	string	The IP address of the Node.	Any
buildInfo.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
buildInfo.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
buildInfo.version	string	The version of the Node's installed Product.	Any
buildInfo.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
buildInfo.portNumber	integer		Any
buildInfo.links	array(object)	Hypermedia links	Any
buildInfo.links.rel	string	rel	Any
buildInfo.links.href	string	uri	Any

Example (generated)

1
2
{
  "state": "STABLE",
  "buildInfo": {
    "id": "string",
    "name": "string",
    "ipAddress": "string",
    "state": "STARTING",
    "buildNumber": "string",
    "version": "string",
    "local": true,
    "portNumber": 0,
    "links": [
      {
        "rel": "string",
        "href": "http://example.com"
      }
    ]
  }
}

Link

Name	Type	Description	Accepted values
rel	string	rel	Any
href	string	uri	Any

Example (generated)

1
2
{
  "rel": "string",
  "href": "http://example.com"
}

NodeInfoDTO

Name	Type	Description	Accepted values
id	string	The id of the Node in cluster.	Any
name	string	The name of the Node.	Any
ipAddress	string	The IP address of the Node.	Any
state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
version	string	The version of the Node's installed Product.	Any
local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
portNumber	integer		Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

Example (generated)

1
2
{
  "id": "string",
  "name": "string",
  "ipAddress": "string",
  "state": "STARTING",
  "buildNumber": "string",
  "version": "string",
  "local": true,
  "portNumber": 0,
  "links": [
    {
      "rel": "string",
      "href": "http://example.com"
    }
  ]
}

Cluster

Name	Type	Description	Accepted values
upgradeModeEnabled	boolean	If true, it's safe to upgrade the nodes of the cluster	Any
state	string	The current state of the Cluster.	`STABLE`, `READY_TO_UPGRADE`, `MIXED`, `READY_TO_RUN_UPGRADE_TASKS`, `RUNNING_UPGRADE_TASKS`, `UPGRADE_TASKS_FAILED`
originalVersion	string	The original product version when ZDU was enabled	Any
nodes	array(object)	The nodes which form the Cluster.	Any
nodes.id	string	The id of the Node in cluster.	Any
nodes.name	string	The name of the Node.	Any
nodes.ipAddress	string	The IP address of the Node.	Any
nodes.state	string	The current state of the Node.	`STARTING`, `ACTIVE`, `DRAINING`, `TERMINATING`, `OFFLINE`, `ERROR`
nodes.buildNumber	string	The build number (DB schema version) of the Node's installed Product.	Any
nodes.version	string	The version of the Node's installed Product.	Any
nodes.local	boolean	True if this is the local node for the current session; otherwise false for remote nodes.	Any
nodes.portNumber	integer		Any
nodes.links	array(object)	Hypermedia links	Any
nodes.links.rel	string	rel	Any
nodes.links.href	string	uri	Any
links	array(object)	Hypermedia links	Any
links.rel	string	rel	Any
links.href	string	uri	Any

Example (generated)

1
2
{
  "upgradeModeEnabled": true,
  "state": "STABLE",
  "originalVersion": "string",
  "nodes": [
    {
      "id": "string",
      "name": "string",
      "ipAddress": "string",
      "state": "STARTING",
      "buildNumber": "string",
      "version": "string",
      "local": true,
      "portNumber": 0,
      "links": [
        {
          "rel": "string",
          "href": "http://example.com"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "string",
      "href": "http://example.com"
    }
  ]
}