Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Onezone REST API Oneprovider REST API Onepanel REST API

Get basic space information

GET /spaces/{sid}

Returns the basic information about space with given Id.

Example cURL requests

Get information about a specific space

curl -H "X-Auth-Token: $TOKEN" -X GET "https://$HOST/api/v3/oneprovider/spaces/$SPACE_ID"

{
    "name": "My Space 1",
    "providers": [
        {
            "providerId": "a0b1d2e6ad583ba1b14caf3b71bc6129ch4f74",
            "providerName": "MyPrivateCloud"
        },
        {
            "providerId": "b107606a22f006b82f6f665a9e6f116cch0500",
            "providerName": "PublicCloud1"
        }
    ],
    "spaceId": "fb519d81146bcc635b890ff03a5da0fdch34fe",
    "fileId": "094576776E667431723230677767776C6B497031394E445F6E3868677873..."
}

Path parameters

Parameter Type & Description
sid required
string

Space Id.

Request Examples

Shell
oneprovider-rest-cli getSpace sid=$SPACE_ID

Responses

application/json
200

The space information.

Property
Type & Description
name
string

Name of the space.

spaceId
string

Id of the space.

fileId
string

Id of space directory.

providers
array of objects (Provider)

The list of providers who support this space.
providerId
string

The Id of the provider supporting the space.

providerName
string

The name of the provider

Example

application/json
{
  "name": "My Space 1",
  "spaceId": "cda5d1bd-ca13-40ef-95e6-51fc1cc3b322",
  "fileId": "094576776E667431723230677767776C6B497031394E445F6E3868677873",
  "providers": [
    {
      "providerId": "c40a3a39-0bbc-41cd-878f-5591f8c55014",
      "providerName": "MyPrivateCloud"
    },
    {
      "providerId": "27d58af6-82ef-4bdd-a596-c4ff080fbde6",
      "providerName": "PublicCloud1"
    }
  ]
}
400

Invalid request.

Property
Type & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}
403

Forbidden request.

Property
Type & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}
404

Oneprovider REST API not available.

Property
Type & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}
500

Internal server error.

Property
Type & Description
error
string

Identifier representing internal error code.

error_description
string

Detailed error message.

Example

application/json
{
  "error": "invalid_token",
  "error_description": "Provided token could not be validated."
}