Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Get space details

GET /user/spaces/{sid}

Returns the details of a specific space.

This operation can be invoked on behalf of the current user only.

Example cURL requests

Get space details

curl -u username:password -X GET \
https://$HOST/api/v3/onezone/user/spaces/$SPACE_ID

{
   "providers" : {
      "296ebe3c20e9666dc489b647f8647f12" : 5368709120
   },
   "spaceId" : "f8d843beda24e54545455ecc0f4b8886",
   "name" : "Test"
}

Path parameters

Parameter	Type & Description
sid required	string Space Id.

Request Examples

Shell

onezone-rest-cli getUserSpace sid=95b663a6467c72ab1256865efef9e387

Responses

application/json

200

Returns the details of a specific space.

Property	Type & Description
spaceId string Unique Id of the space.
name string The name of the space.
providers object A map of provider Ids supporting this space and corresponding size of provisioned storage in bytes.

Example

application/json

{
  "spaceId": "2c0160248ba9a66f45da751ca459535a",
  "name": "My Private space",
  "providers": {
    "296ebe3c20e9666dc489b647f8647f12": 5368709120,
    "dcf12429647c204896eebe3b6f686967": 14400000
  }
}

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

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

403

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

404

Resource not found.

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

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