Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get provider details

GET /provider

Returns the basic configuration information of the provider.

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE getProvider --host https://$HOST:9443

Responses

application/json

200

The provider configuration details.

Property	Type & Description
id string The Id assigned by a zone.
name string The name under which the Oneprovider has been registered in a zone.
subdomainDelegation boolean If enabled, the storage Oneprovider has a subdomain in onezone's domain and 'subdomain' property must be provided.
subdomain string Unique subdomain in onezone's domain for the Oneprovider. Required if subdomain delegation is enabled.
domain string The fully qualified domain name of the Oneprovider or its IP address (only for single-node deployments or clusters with a reverse proxy).
adminEmail string Email address of the Oneprovider administrator. Omitted if it could not be retrievied.
geoLongitude number The geographical longitude of the Oneprovider.
geoLatitude number The geographical latitude of the Oneprovider.
onezoneDomainName string The domain name of a zone where this storage Oneprovider is registered.

Example

application/json

{
  "id": "VAiDGZbs3k0FD8jPhyU1",
  "name": "Provider1",
  "subdomainDelegation": false,
  "domain": "provider.example.com",
  "geoLongitude": -24.3776025,
  "geoLatitude": -128.3519364,
  "onezoneDomainName": "onezone2.example.com"
}

401

Unauthorized request.

403

Forbidden request.

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

503

Services needed to fulfill this request are not running.