Change the cluster mode of one or every physical tenant Added in 8.10

PATCH 
/cluster/v2/mode

Strongly Consistent About endpoint data consistency

Transitions physical tenants between processing and recovery mode.

If the physicalTenantId parameter is not provided, all available physical tenants are transitioned individually.

Requires the cluster-admin security chain. Although this operation lists bearerAuth / basicAuth like the rest of the Orchestration Cluster API, it does not accept an Orchestration Cluster user's credentials — only the separate cluster-admin credentials are valid here.

Required permissions

Even when authorization is enabled, this endpoint requires no specific permission. See resources and permissions to learn more.

Request

Responses

200

The mode change request was accepted; returns the planned cluster change covering every requested physical tenant.

400

The provided data is not valid.

401

The request lacks valid authentication credentials.

Response Headers

WWW-Authenticate

404

The requested physicalTenantId does not exist in this cluster.

409

The mode change conflicts with the cluster state, for example because another configuration change is in progress.

500

An internal error occurred while processing the request.