Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Modify storage config

PATCH /provider/storages/{id}

Modifies storage configuration.

Path parameters

Parameter Type & Description
id required
string

The Id of the storage resource which details should be modified.

Request body

application/json

An object with one key - the current name of the storage that is being modified - and its value set to an object with updated parameters.

No schema provided.

Request Examples

application/json 
{
  "Old storage name": {
    "type": "s3",
    "name": "New storage name",
    "accessKey": "4efb70ad3e1fc8dd73c721b8f683b2e831503892"
  }
}

Responses

application/json
200

The storage resources have been successfully modified. Response contains current storage params and report of file creation test.

PropertyType & Description
name
string

The name of storage.

timeout
integer

Storage operation timeout in milliseconds.

skipStorageDetection
boolean

If true, detecting whether storage is directly accessible by the Oneclient will not be performed. This option should be set to true on readonly storages.

lumaFeed
string

Type of feed for LUMA DB. Feed is a source of user/group mappings used to populate the LUMA DB. For more info please read: https://onedata.org/#/home/documentation/doc/administering_onedata/luma.html

Enum:
autolocalexternal
lumaFeedUrl
string

URL of external feed for LUMA DB. Relevant only if lumaFeed equals external.

lumaFeedApiKey
string

API key checked by external service used as feed for LUMA DB. Relevant only if lumaFeed equals external.

qosParameters
object

Map with key-value pairs used for describing storage QoS parameters. Overrides all previously set parameters.

importedStorage
boolean

Defines whether storage contains existing data to be imported.

readonly
boolean

Defines whether the storage is readonly. If enabled, Oneprovider will block any operation that writes, modifies or deletes data on the storage. Such storage can only be used to import data into the space. Mandatory to ensure proper behaviour if the backend storage is actually configured as readonly. This option is available only for imported storages.

401

Unauthorized request.

403

Forbidden request.

500

Internal server error.

PropertyType & 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.