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 -X GET "https://$PROVIDER_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

Oneprovider configuration.

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
object (ErrorJson)

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.

ctx required
object (ErrorJsonCtx)

Technical information about error.

timestamp required
integer

Timestamp in milliseconds.

serviceReleaseVersion required
string

Release version of a product, for example "25.0".

serviceId required
string

Identifier of a service instance — either Oneprovider Id or "onezone".

serviceDomain required
string

Domain of the service.

serviceBuildVersion required
string

Build version of the service.

service required
string

Short name of service.

Enum:
ozwopwozpopp
onedataErrorsRevision required
string

Revision of onedata-errors repo, where the error is defined.

module required
string

Module where the error occurred.

line required
integer

Line number in the module where the error occurred.

Example

application/json
{
  "error": {
    "id": "example",
    "description": "This is an example error.",
    "ctx": {
      "timestamp": 1750762637248,
      "serviceReleaseVersion": "25.0",
      "serviceId": "a7ee2722915b8bf7fb064eb65087cc61ch9357",
      "serviceDomain": "dev-oneprovider-krakow.default.svc.cluster.local",
      "serviceBuildVersion": "231-g8d26f953c3",
      "service": "opw",
      "onedataErrorsRevision": "ca3af8cb",
      "module": "metadata_req",
      "line": 45
    }
  }
}