Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get cluster hosts

GET /hosts

Returns the list of administrative cluster hosts.

Request Examples

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

Responses

application/json
200

The list of administrative cluster hosts.

No schema provided.

Example

application/json
[
  "host1.example.org",
  "host2.example.org",
  "host3.example.org"
]
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."
  }
}