Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get storage details

GET /provider/storages/{id}

Returns the details of the selected storage.

Path parameters

Parameter	Type & Description
id required	string The Id of a storage resource, which details should be returned.

Request Examples

Shell

onepanel-rest-cli -u onepanel:$PASSPHRASE getStorageDetails id=$STORAGE_ID --host https://$HOST:9443

Responses

application/json

200

The details of a selected storage.

Property	Type & Description
type string
id string The Id of storage.
name string The name of storage.
verificationPassed boolean Result of storage verification (reading and writing a file). Returned only on PATCH requests for read-write storages.
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.
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.

404

Storage does not exist.

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.