API REST UBQT v1
Authentication is done via Bearer token. Include your API key in the Authorization header of each request.
curl https://api.can-qc01.ubqt.cloud/v1/vms \
-H "Authorization: Bearer ubqt-sk-xxxxxxxxxxxx" \
-H "Content-Type: application/json"| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/vms | List VMs |
| POST | /v1/vms | Create a VM |
| GET | /v1/vms/{id} | Details of a VM |
| DELETE | /v1/vms/{id} | Delete a VM |
| POST | /v1/vms/{id}/actions/start | Start a VM |
| POST | /v1/vms/{id}/actions/stop | Stop a VM |
| POST | /v1/vms/{id}/actions/reboot | Reboot a VM |
| Method | Endpoint | Description |
|---|---|---|
| — | s3.can-qc01.ubqt.cloud | S3-compatible endpoint |
| GET | /v1/storage/buckets | List buckets |
| POST | /v1/storage/buckets | Create a bucket |
| DELETE | /v1/storage/buckets/{name} | Delete a bucket |
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/volumes | List volumes |
| POST | /v1/volumes | Create a volume |
| GET | /v1/volumes/{id} | Details |
| POST | /v1/volumes/{id}/attach | Attach to an instance |
| POST | /v1/volumes/{id}/detach | Detach |
| POST | /v1/volumes/{id}/snapshots | Create a snapshot |
| DELETE | /v1/volumes/{id} | Delete |
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/kubernetes/namespaces | List namespaces |
| POST | /v1/kubernetes/namespaces | Create a namespace |
| GET | /v1/kubernetes/namespaces/{id}/kubeconfig | Download kubeconfig |
| DELETE | /v1/kubernetes/namespaces/{id} | Delete a namespace |
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/databases | List instances |
| POST | /v1/databases | Create an instance |
| GET | /v1/databases/{id} | Instance details |
| GET | /v1/databases/{id}/credentials | Get credentials |
| DELETE | /v1/databases/{id} | Delete an instance |
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/dns/zones | List zones |
| POST | /v1/dns/zones | Create a zone |
| GET | /v1/dns/zones/{id}/records | List records |
| POST | /v1/dns/zones/{id}/records | Add a record |
| DELETE | /v1/dns/zones/{id}/records/{rid} | Delete a record |
| Method | Endpoint | Description |
|---|---|---|
| GET | /v1/gpu/instances | List GPU instances |
| POST | /v1/gpu/instances | Create a GPU instance |
| POST | /v1/ai/chat/completions | Inference API (compatible OpenAI) |
| GET | /v1/ai/models | List available models |
| Code | Meaning |
|---|---|
| 200 | Success |
| 201 | Created successfully |
| 400 | Bad request |
| 401 | Unauthenticated |
| 403 | Unauthorized |
| 404 | Resource not found |
| 429 | Too many requests (rate limit) |
| 500 | Server Error |
100 requests per minute by default. The X-RateLimit-Remaining header is included in each response to track your usage.
Need higher limits? Contact Us.
pip install ubqt Coming Soonnpm install @ubqt/sdk Coming Soongo get github.com/ubqt-cloud/sdk-go Coming Soon