Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Returns public configuration of Onezone service.

GET /configuration

Returns public information about the Onezone service.

This endpoint does not require authentication.

Example cURL requests

Get public information about the Onezone service

curl https://$ZONE_HOST/api/v3/onezone/configuration

{
  "name": "Example zone",
  "domain": "zone.example.com",
  "version": "25.1",
  "build": "g52dbeca23",
  "subdomainDelegationSupported": true,
  "compatibleOneproviderVersions": [
      "20.02.1",
      "20.02.2",
      "25.1"
  ],
  "compatibilityRegistryRevision": 2022122100,
  "supportedIdPs": [
    {
      "id": "google",
      "offlineAccess": true
    },
    {
      "id": "basicAuth",
      "offlineAccess": false
    }
  ],
  "availableSpaceTags": {
    "general": [
        "big-data",
        "demo",
        "open-data",
        "simulation"
    ],
    "domains": [
        "agriculture",
        "forestry",
        "justice",
        "science"
    ]
  }
}

Request Examples

Shell
onezone-rest-cli getConfiguration

Responses

application/json
200

Configuration returned successfully.

Property
Type & Description
name
string

Onezone's name

domain
string

Onezone's cluster domain

version
string

Version of this Onezone service

build
string

Build number of this Onezone service

subdomainDelegationSupported
boolean

If true, registering Oneproviders are allowed to request subdomains of the Onezone domain for use as their domains.

compatibleOneproviderVersions
array of strings

List of compatible Oneprovider versions

compatibilityRegistryRevision
integer

Revision of the compatibility registry enforced by this Onezone service

supportedIdPs
array of objects

List of IdPs supported by Onezone
id
string

The identifier of the IdP

offlineAccess
boolean

Determines whether given IdP can be used in the offline access flow, i.e. Onezone can acquire access tokens in the IdP without the user being logged in.

availableSpaceTags
object

A map of tag categories and corresponding available tags for each category.

Space tag is a short keyword or phrase that helps to understand the purpose of a space. Tag categories and available tags are arbitrary strings configured by the Onezone admin.

Example

application/json
{
  "name": "Example zone",
  "domain": "zone.example.com",
  "version": "25.1",
  "build": "g52dbeca23",
  "subdomainDelegationSupported": true,
  "compatibleOneproviderVersions": [
    "20.02.1",
    "20.02.2",
    "25.1"
  ],
  "compatibilityRegistryRevision": 2022122100,
  "supportedIdPs": [
    {
      "id": "google",
      "offlineAccess": true
    },
    {
      "id": "basicAuth",
      "offlineAccess": false
    }
  ],
  "availableSpaceTags": {
    "general": [
      "big-data",
      "demo",
      "open-data",
      "simulation"
    ],
    "domains": [
      "agriculture",
      "forestry",
      "justice",
      "science"
    ]
  }
}
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."
  }
}