Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get public configuration

GET /configuration

Returns public configuration details.

Responses

application/json
200

Configuration details.

Property
Type & Description
clusterId
string

The Id of cluster record for this cluster. null if the cluster is not registered.

version
string

Version of this Onepanel.

build
string

Build number of this Onepanel.

deployed
boolean

True when cluster deployment is finished.

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