Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Modify provider details

PATCH /provider

Modifies basic provider details in the zone.

Request body

application/json

New values for provider configuration parameters which should be changed.

Property	Type & Description
name string The name under which the provider has been registered in a zone.
subdomainDelegation boolean If enabled, the storage provider will be assigned a subdomain in onezone's domain and 'subdomain' property must be provided. If disabled, 'domain' property should be provided.
subdomain string Unique subdomain in onezone's domain for the provider. This property is required only if subdomain delegation is enabled. Otherwise it is ignored.
domain string The fully qualified domain name of the provider or its IP address (only for single-node deployments or clusters with a reverse proxy). This property is required only if subdomain delegation is disabled. Otherwise it is ignored.
geoLongitude number The geographical longitude of the provider.
geoLatitude number The geographical latitude of the provider.
adminEmail string Email address of the oneprovider administrator.

Request Examples

application/json

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

Responses

application/json

204

Provider details has been successfully modified.

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

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.