Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get provider details

GET /providers/{id}

Returns the information about a specific Oneprovider service that is registered in Onezone.

This operation requires any of the following authentication:

  • as any provider (providers are allowed to view each other's data),
  • as user who is an effective member in a space supported by the subject provider,
  • as user who has oz_providers_view admin privilege.

Example cURL requests

Get specific provider details

curl -H "x-auth-token: $TOKEN" -X GET  \
https://$ZONE_HOST/api/v3/onezone/providers/$PROVIDER_ID

{
  "providerId": "6b9bc70630547d925861a27e1f050dfe",
  "name": "Example provider",
  "domain": "provider1.example.com",
  "latitude": 50.0647,
  "longitude": 19.945,
  "clusterId": "6b9bc70630547d925861a27e1f050dfe",
  "online": true,
  "creationTime": 1576152793
}

Path parameters

Parameter Type & Description
id required
string

Provider Id.

Request Examples

Shell
onezone-rest-cli getProviderDetails id=WEavnRE7c49EU2sjF0Rz7l_kpiA1IBrwbDxNfH87Plc

Responses

application/json
200

Information about a provider.

Property
Type & Description
providerId
string

The Oneprovider Id.

name
string

Oneprovider name.

domain
string

The fully qualified domain name of the Oneprovider. In rare cases, the domain may have the form of an IP address instead of an FQDN.

latitude
number

The geographical latitude of the Oneprovider's data center location.

longitude
number

The geographical longitude of the Oneprovider's data center location.

clusterId
string

The Id of the corresponding Oneprovider cluster.

online
boolean

True if this Oneprovider is online - connected to Onezone.

creationTime
integer (Timestamp)

Timestamp in seconds (UNIX epoch), e.g. 1563819329.

Example

application/json
{
  "providerId": "6b9bc70630547d925861a27e1f050dfe",
  "name": "Example provider",
  "domain": "provider1.example.com",
  "latitude": 50.0647,
  "longitude": 19.945,
  "clusterId": "6b9bc70630547d925861a27e1f050dfe",
  "online": true,
  "creationTime": 1576152793
}
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."
  }
}
401

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

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

Resource not found.

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