Onedata API Reference

REST API references for Onezone, Oneprovider, and Onepanel.

Version:

Onezone REST API Oneprovider REST API Onepanel REST API

Version:

Modify space details

PATCH /spaces/{id}

Updates the details about a space.

This operation requires space_update privilege or oz_spaces_update admin privilege.

Example cURL requests

Change space name

curl -u username:password -H "Content-type: application/json" \
-X PATCH -d '{"name": "new_space12"}' \
https://$ZONE_HOST/api/v3/onezone/spaces/$SPACE_ID

Path parameters

Parameter	Type & Description
id required	string Space Id.

Request body

application/json

Space parameters

Property	Type & Description
name string The new 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.

Request Examples

Shell

onezone-rest-cli modifySpace id=b752ceafabb662b4e5728b2ded25cdd1 name=="New Space Name"

Responses

application/json

204

Space has been updated successfully.

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