API basics: endpoints, pagination and errors
Conventions that apply to every endpoint, so you only learn them once.
The API is REST over HTTPS. Requests and responses are JSON. The base is https://api.webvuecloud.com/v1.
Common endpoints
| Method and path | Does |
|---|---|
GET /sites | List sites |
GET /sites/{id} | One site with its domains and plan |
POST /sites/{id}/cache/purge | Purge everything, or a list of URLs |
POST /sites/{id}/backups | Take a manual backup |
GET /domains/{domain}/dns | List DNS records |
POST /domains/{domain}/dns | Create a record |
Pagination
List endpoints return 25 items by default and accept ?page= and ?per_page= up to 100. The total is in the X-Total-Count header.
Errors
{
"error": {
"code": "validation_failed",
"message": "The record type is not supported.",
"field": "type"
}
}Rate limits
600 requests per minute per token. The remaining allowance is in X-RateLimit-Remaining. Over the limit returns 429 with a Retry-After header; respect it rather than retrying in a tight loop.