Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get deployment progress

GET /progress

Returns deployment markers state.

Responses

application/json
200

The progress markers.

PropertyType & Description
clusterNodes
boolean

True after user assigned services to cluster nodes and they were deployed.

clusterIps
boolean

True after user provided public IPs of cluster nodes or confirmed autodetected defaults. Also true if interactiveDeployment was disabled.

webCertificate
boolean

True after user decided whether to use Let's Encrypt certificates or if interactiveDeployment was disabled.

dnsCheck
boolean

True after user reviewed results of DNS check or if interactiveDeployment was disabled.

storageSetup
boolean

True after at least one storage was added to op_worker. Omitted in Onezone panel.

isRegistered
boolean

True if the Oneprovider is registered at Onezone. Omitted in Onezone panel.

400

Invalid request.

PropertyType & Description
error
object

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."
  }
}
401

Unauthorized request.

403

Forbidden request.

500

Internal server error.

PropertyType & Description
error
object

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."
  }
}