Loading ...

REST API: Check Space Name Availability | Axero Documentation

Home » axero documentation » Wiki » Documentation » REST API Overview » REST API: Spaces » REST API: Check Space Name Availability
Axero Documentation  Wiki
Public Space
Activity Stream Content
Version 43

REST API: Check Space Name Availability

0 
 /5
0 (0votes)
Open API Guide
GET/api/spaces/availability

Check whether a space name can be used. ResponseData is the string True when the name is free and False when it is taken, which is the opposite of the file directory name check.

Request

Request Header

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

Required Parameters

ParameterTypeRequiredLocationDescription
SpaceNameStringYESQueryName to check. It must match an existing space name exactly to count as taken, but letter case is ignored. 

Example

Request Header

Authorization: Bearer YOUR_TOKEN

Request URL

https://your-site.com/api/spaces/availability?spacename=Customers

Success Response

{
  "IsError": false,
  "ResponseMessage": "Customers",
  "ResponseData": "True"
}

Error Response

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

Error Handling

Status CodeLikely CauseNext Action
400 Bad RequestSpaceName was left out of the query string.Verify the request payload against the required parameters
401 UnauthorizedMissing or invalid Bearer tokenCheck token validity. Learn how to create Bearer tokens →
403 ForbiddenNot returned: the endpoint makes no permission check.No action needed.
500 Server ErrorSpaceName is empty or only spaces; the response body is empty. Otherwise, an internal failure.Send a SpaceName with at least one character that is not a space. For any other 500, retry later.

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