Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get Onezone information

GET /provider/onezone_info

Get information about a Onezone. Before registration, this endpoint requires a registration token and returns information about the Onezone which issued the token. If the Oneprovider is registered, returns information about the Onezone at which the provider is registered.

Query parameters

Parameter Type & Description
token
string

Oneprovider registration token obtained from Onezone. Required if the Oneprovider is not registered.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE getOnezoneInfo --host https://$HOST:9443

Responses

application/json
200

Information about Onezone.

PropertyType & Description
online
boolean

True if connection to the Onezone was achieved. If false, fields other than 'domain' will not be sent.

version
string

Onezone cluster version.

domain
string

Domain of the Onezone.

name
string

Name of the Onezone cluster.

compatible
boolean

True if versions of this Oneprovider and the Onezone are compatible.

subdomainDelegationSupported
boolean

Whether given Onezone allows subdomain delegation.

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