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 by provider

GET /provider/spaces/{sid}

Returns information about a specific space supported by the Oneprovider that performed the request.

This operation requires provider authentication - see provider auth token.

Example cURL requests

Get space details

curl -H "x-auth-token: $TOKEN" -X GET \
https://$ZONE_HOST/api/v3/onezone/provider/spaces/$SPACE_ID

{
  "spaceId": "2c0160248ba9a66f45da751ca459535a",
  "name": "new_space1",
  "providers": {
    "296ebe3c20e9666dc489b647f8647f12" : 5368709120
  },
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebfc1a770c3"
  },
  "creationTime": 1576152793
}

Path parameters

Parameter	Type & Description
sid required	string Space Id.

Request Examples

Shell

onezone-rest-cli getSupportedSpace sid=WEavnRE7c49EU2sjF0Rz7l_kpiA1IBrwbDxNfH87Plc

Responses

application/json

200

Returns the information about a specific space.

Property Type & Description

spaceId

string

Unique Id of the space.

name

string

The name of the space.

description

string (SpaceDescription)

Space description in markdown (.md) format.

organizationName

string (SpaceOrganizationName)

Name of the organization responsible for space management.

tags

array of strings

A list of short keywords or phrases that helps to understand the purpose of a space. Available space tags can be retrieved from the configuration endpoint.

advertisedInMarketplace

boolean (SpaceAdvertisedInMarketplace)

Specifies whether the space should be publicly advertised in the Space Marketplace.

marketplaceContactEmail

string (SpaceMarketplaceContactEmail)

Email address that will be used for notifying the person responsible for space management in the Marketplace about new membership requests. This field is visible only to space members with both space_view and space_manage_in_marketplace privileges, otherwise an empty string is returned. Similarly, it can be modified only by users with the space_manage_in_marketplace privilege.

providers

object

A map of provider Ids supporting this space and corresponding size of provisioned storage in bytes.

supportParametersRegistry

object

A map of provider Ids supporting this space and corresponding support parameters of the provider.

creator

object (Subject)

Object representing a subject in the system, can be perceived as client (actor) identity.

type string Type of the subject Enum: nobodyuseroneprovider
id string Id of the subject (`null` for nobody)

creationTime

integer (Timestamp)

Timestamp in seconds (UNIX epoch), e.g. 1563819329.

Example

application/json

{
  "spaceId": "2c0160248ba9a66f45da751ca459535a",
  "name": "My Private space",
  "description": "My Private data",
  "organizationName": "",
  "tags": [
    "images",
    "sport"
  ],
  "advertisedInMarketplace": false,
  "marketplaceContactEmail": "",
  "providers": {
    "296ebe3c20e9666dc489b647f8647f12": 5368709120,
    "dcf12429647c204896eebe3b6f686967": 14400000
  },
  "supportParametersRegistry": {
    "296ebe3c20e9666dc489b647f8647f12": {
      "accountingEnabled": false,
      "dirStatsServiceEnabled": true,
      "dirStatsServiceStatus": "enabled"
    },
    "dcf12429647c204896eebe3b6f686967": {
      "accountingEnabled": false,
      "dirStatsServiceEnabled": false,
      "dirStatsServiceStatus": "stopping"
    }
  },
  "creator": {
    "type": "user",
    "id": "7434b256e71e1052e0d5e3e9da657ebf"
  },
  "creationTime": 1576152793
}

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