Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get information about current onepanel node

GET /node

Returns information about current onepanel node.

Request Examples

Shell
onepanel-rest-cli -u onepanel:$PASSPHRASE getHostname --host https://$PANEL_HOST:9443

Responses

application/json
200

Details of this onepanel node.

Property
Type & Description
hostname
string

Hostname of the node.

clusterType
string

Type of Onedata cluster managed by this onepanel.

Enum:
oneprovider onezone
403

Forbidden request.

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