Modify space details
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
Space parameters
The new name of the space.
Space description in markdown (.md) format.
Name of the organization responsible for space management.
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.
Specifies whether the space should be publicly advertised in the Space Marketplace.
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
onezone-rest-cli modifySpace id=b752ceafabb662b4e5728b2ded25cdd1 name=="New Space Name"Responses
Space has been updated successfully.
Invalid request.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authentication error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Authorization error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Resource not found.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}Internal server Error.
error Object describing an error.
Object describing an error.
String identifying the error type. Does not change between error instances.
Human readable error description. May contain information specific to given error instance.
Details about the error instance. The object schema is specific to each error type.
Example
{
"error": {
"id": "badValueString",
"details": {
"key": "name"
},
"description": "Bad value: provided \"name\" must be a string."
}
}