Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get details of a remote Oneprovider.

GET /providers/{id}

Returns the details of given provider. Only users belonging to that Oneprovider's cluster can fetch its details.

Path parameters

Parameter	Type & Description
id required	string Id of requested Oneprovider.

Request Examples

Shell

onepanel-rest-cli getRemoteProvider id=VAiDGZbs3k0FD8jPhyU1 --host https://$HOST:9443 -H "x-auth-token: $TOKEN"

Responses

application/json

200

The Oneprovider details.

Property	Type & Description
id string The Oneprovider Id assigned by Onezone.
name string The name under which the Oneprovider has been registered in Onezone.
domain string The fully qualified domain name of the Oneprovider.
geoLongitude number The geographical longitude of the provider.
geoLatitude number The geographical latitude of the provider.
cluster string The Id of the corresponding cluster record.
online boolean Indicates if the Oneprovider is currently online.

Example

application/json

{
  "id": "VAiDGZbs3k0FD8jPhyU1",
  "name": "Provider 1",
  "domain": "provider.example.com",
  "geoLongitude": -24.3776025,
  "geoLatitude": -128.3519364,
  "cluster": "kas90GcjRa9352ndfCxhGyYY9dx",
  "online": true
}

400

Invalid request.

Property

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

403

Forbidden request.

404

Request client is not member of given Oneprovider's cluster.

500

Internal server error.

Property

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