Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Modify space details

PATCH /provider/spaces/{id}

Modifies the space import/update strategies.

Path parameters

Parameter Type & Description
id required
string

The Id of a space which details should be modified.

Request body

application/json
PropertyType & Description
size
integer

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

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.

Responses

application/json
204

The space details has been successfully changed.

400

Invalid request.

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

Unauthorized request.

403

Forbidden request.

404

The user does not exist.

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.