Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Support space

POST /provider/spaces

Supports an existing space.

Request body

application/json

Specification of the space support request including support size and token.

Property

Type & Description

token

string

The token for space creation or support.

size

integer

The storage space size in bytes that provider is willing to assign to the space.

storageId

string

The Id of the storage resource where the space data should be stored.

storageImport

object (StorageImportDetails)

The storage import configuration. Storage import allows to import data from storage to space without need for copying the data.

strategy required string The import strategy. One of no_import, simple_scan.
maxDepth integer Maximum depth of filesystem tree that will be traversed during storage synchronization.
syncAcl boolean Flag that enables synchronization of NFSv4 ACLs.

storageUpdate

object (StorageUpdateDetails)

The storage update configuration. Storage update ensures that all changes on storage will be reflected in space.

strategy required string The update strategy. One of no_update, simple_scan.
maxDepth integer Maximum depth of filesystem tree that will be traversed during storage synchronization.
scanInterval integer Period between subsequent scans in seconds (counted from end of one scan till beginning of the following).
writeOnce boolean Flag determining that synchronized storage will be treated as immutable (only creations and deletions of files on storage will be detected).
deleteEnable boolean Flag determining that deletions of files will be detected.
syncAcl boolean Flag that enables synchronization of NFSv4 ACLs.

Request Examples

application/json

{
  "token": "ASDJNASD87687ASDMNBMNASD87786asd",
  "size": 1024000,
  "storageId": "x7It3cpgNgLZ8RwOrOoW"
}

Responses

application/json

201

Created space support relation.

Property	Type & Description
id string Resource Id.

Example

application/json

{
  "id": "26cbc2b20f92416eb9f3cba65e50c1d2"
}

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.