Introduction
Manage VPSBG servers, backups, networking, billing, and more through a JSON REST API.
The VPSBG API lets you manage servers, backups, SSH keys, floating IPs, network protection, billing, and other account resources programmatically.
API v1 is in beta. Behavior may change as the API evolves.
Getting startedCopy link
Send requests over HTTPS to the following base URL:
https://api.vpsbg.eu/v1Requests and responses use JSON. Authenticate every request with a bearer token created in the VPSBG Console:
curl "https://api.vpsbg.eu/v1/servers?per_page=1" \
--header "Accept: application/json" \
--header "Authorization: Bearer ${VPSBG_API_TOKEN}"See Authentication for token creation, abilities, and security guidance.
ResponsesCopy link
Resource envelopes are unwrapped:
- A single resource returns a bare JSON object.
- A paginated list returns a
dataarray pluslinksandmetaobjects.
See Pagination for the complete list response shape.
The API uses standard HTTP status codes:
| Status | Meaning |
|---|---|
200–204 | The request succeeded. |
401 | The token is missing, invalid, or lacks the write ability. |
403 | The resource does not belong to the authenticated account. |
404 | The resource was not found. |
422 | The request failed validation. |
423 | The target service is locked by an operation in progress. |
429 | A rate limit was exceeded. |
Validation errors include a message and errors keyed by field:
{
"message": "The selected plan is invalid.",
"errors": {
"plan": ["The selected plan is invalid."]
}
}Rate limitingCopy link
The global limit is 200 requests per minute per account. Responses include
X-RateLimit-Limit and X-RateLimit-Remaining. A 429 Too Many Requests
response also includes Retry-After.
Some sensitive endpoints have tighter limits documented in their endpoint reference.
Service operationsCopy link
A server, floating IP, or other service may be locked while an operation is in
progress. A conflicting mutation returns 423 Locked; retry it after the
active lock clears. Read requests remain available.