Loading ...

REST API: Delete Space | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Spaces » REST API: Delete Space
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 36

REST API: Delete Space

0 
 /5
0 (0votes)
Open API Guide
DELETE/api/spaces/{spaceid}

Delete a space and everything in it. The delete cannot be undone. ResponseData is 2 (ToBeDeleted): the space is marked for deletion at once, and its content is removed in the background. To confirm the delete, check that the space no longer appears in the spaces list (GET /api/spaces). A direct read of the deleted ID with Get Space does not answer 404. It answers 200 with IsError false, no ResponseData, and the ResponseMessage Content not found.

Request

Request Header

HeaderRequiredValueDescription
AuthorizationYESBearer YOUR_TOKENBearer token for the authenticated user. Learn how to create Bearer tokens.

Required Parameters

ParameterTypeRequiredLocationDescription
SpaceIDIntegerYESPathUnique identifier for a particular space

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/spaces/13

Success Response

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": 2
}

Error Response

{
  "Message": "The request is invalid."
}

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestSpaceID in the path is not an integer.Send the space's numeric ID.
401 UnauthorizedMissing or invalid Bearer token.Check token validity. Learn how to create Bearer tokens →
403 ForbiddenThe caller does not have permission to delete spaces. A site administrator has it.Confirm the user has the required roles for this action.
500 Server ErrorInternal failure.Retry later.
200 with ResponseData 3SpaceID is 0, or no space has that ID (3 is Error). Nothing is deleted.Check the SpaceID.

Rate Limits

While Axero does not enforce hard rate limits by default, we recommend the following best practices to ensure optimal performance:

  • Sustained Request Rate: Do not exceed 5 API calls per second
  • Sequential Processing: Wait for each request to complete before sending the next in automated workflows
  • Concurrent Connections: If parallel processing is required, limit to 3 or fewer simultaneous requests
  • Response Timeout: Ensure API responses complete within 15 seconds during testing

Axero may implement temporary rate restrictions if excessive API usage affects overall site performance. For high-volume integrations, contact Axero to discuss your requirements.

Wiki Index

Pages