Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

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 -X GET -H "X-Auth-Token: $TOKEN" \
"https://$HOST/api/v3/oneprovider/spaces/$SPACE_ID"

{
    "name": "My Space 1",
    "providers": [
        {
            "providerId": "51306215-674a-47b7-afd1-54fa45bcaff7",
            "providerName": "MyPrivateCloud"
        },
        {
            "providerId": "0a568302-0f5e-454d-a6bc-7da7e1bfb985",
            "providerName": "PublicCloud1"
        }
    ],
    "spaceId": "8f4b1e94-fdf8-4754-9962-edb01b2ee0f7"
}

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

spaceId

string

Id of the space.

name

string

Name of the space.

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

{
  "spaceId": "cda5d1bd-ca13-40ef-95e6-51fc1cc3b322",
  "name": "My Space 1",
  "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."
}