Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get public information

GET /configuration

Returns public information about the Oneprovider service.

This endpoint does not require authentication.

Example cURL requests

Get public information about the Oneprovider service

curl "https://$HOST/api/v3/oneprovider/configuration"

{
  "providerId": "c4798eb2dbd2486fae940e6fa0a5071d",
  "name": "ProviderName",
  "domain": "zone.domain.org",
  "onezoneDomain": "example.domain.org",
  "version": "R14B04",
  "build": "14-g0d0fd5b",
  "compatibleOnezoneVersions": ["R13B04, R14B04"],
  "compatibleOneproviderVersions": ["R14B04"],
  "compatibleOneclientVersions": ["R14B04"]
}

Request Examples

Shell
oneprovider-rest-cli getConfiguration

Responses

application/json
200

Configuration returned successfully.

PropertyType & Description
providerId
string

Id of the Oneprovider

name
string

Oneprovider's name

domain
string

Oneprovider's domain

onezoneDomain
string

Domain of the Onezone where this Oneprovider is registered

version
string

Version of this Oneprovider

build
string

Build number of this Oneprovider

compatibleOnezoneVersions
array of strings

List of compatible Onezone versions

compatibleOneproviderVersions
array of strings

List of compatible Oneprovider versions

compatibleOneclientVersions
array of strings

List of compatible Oneclient versions

500

Internal server error.

PropertyType & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}