Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Start/stop zone cluster workers

PATCH /zone/workers

Starts or stops cluster worker service on all hosts in the local deployment.

Query parameters

Parameter	Type & Description
started	boolean Defines the intended state of the cluster worker service. The service will be started or stopped in order to match the requested state.

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE startStopZoneWorkers started=false --host https://$OZ_PANEL_HOST:9443

Responses

application/json

204

Cluster worker service state changed successfully.

401

Unauthorized request.

403

Forbidden request.

404

Cluster worker service has not been deployed.

500

Internal server error.

Property

Type & Description

error

object (ErrorDetails)

Object describing an error.

id required

string

String identifying the error type. Does not change between error instances.

description required

string

Human readable error description. May contain information specific to given error instance.

details

object

Details about the error instance. The object schema is specific to each error type.

Example

application/json

{
  "error": {
    "id": "badValueString",
    "details": {
      "key": "name"
    },
    "description": "Bad value: provided \"name\" must be a string."
  }
}