Create Space

Last Updated on : 2024-06-28 23:01:22download

Create a space subordinate to the specified parent space.

API address

POST: /v2.0/cloud/space/creation

Request parameter

Description of body

Parameter nameTypeINRequiredDescription
nameStringbodytrueThe name of the specified space.
parent_idLongbodyfalseThe ID of the specified parent space.
descriptionStringbodyfalseThe description of the specified space.

Return parameter

Parameter nameTypeDescription
successBooleanIndicates whether the operation is successful. Valid values:
  • true: The operation succeeded.
  • false: The operation failed.
error_codeStringThe error code.
error_msgStringThe error message.
resultLongThe ID of the specified space.

Request example

POST: /v2.0/cloud/space/creation
{
  "name": "Test Space",
  "parent_id": 150000002,
  "description":"Description of the space",
}

Return example

{
    "result": 150000001,
    "success": true
}

Error code

For more information, see error code.

Limits on API Request Frequency

For more information, see Limits on API Request Frequency.