Introduction
This site documents the APIs behind Sabay Cloud Services: your account, object storage, media transcoding, containerized apps, managed databases and virtual private servers. Every operation shown here is checked against the GraphQL gateway's schema.
How the APIs work
All services are served by one GraphQL gateway:
https://cloud-gateway.sabay.com/graphql
Operations are grouped by a name prefix, so you can tell which service an operation belongs to:
| Service | Prefix |
|---|---|
| Profile & Account | sso_ (plus mysabay_chatbot_listChatBotByUser) |
| Storage | s3_ |
| Transcoder | s3_ (shared with Storage) |
| Run App | container_ |
| Database | db_ |
| VPS | instance_ |
Every request carries the same two headers:
| Header | Value |
|---|---|
service-code | cloud_user |
Authorization | Bearer {token} |
VPS operations also send VPS-specific headers. See VPS headers.
Replace {token} with your own access token. Never commit tokens to source
control.
Profile & Account
Manage the signed-in user's own account. Overview →
- Profile: read the profile, edit personal details and set the profile picture.
- Security: change the login password, add or change the security password, and toggle password recovery.
- Verification: add and verify the account email and phone number, including the messenger bots that deliver phone codes.
Storage
S3-compatible object storage for files, backups and media. Overview →
- Buckets: create, list and delete buckets.
- Bucket settings: configure each bucket's privacy, policy and CORS.
- Credentials: read and reset your S3 access keys.
- Usage: summarise storage and network usage.
- Sub-users: create additional S3 identities with their own keys and per-bucket permissions.
- Upload files: upload objects with an S3-compatible client such as the AWS CLI.
Storage requires an active cloud_s3 subscription. See
Subscription requirement.
Transcoder
Convert media files between formats and resolutions. Overview →
Run App
Deploy and manage containerized (Docker) applications. Apps are organized as stacks, and each stack holds one or more services. Overview →
- Stacks: create, update, list, inspect and remove stacks; start, stop and restart them; and pull and redeploy them.
- Services: list, start and stop the services in a stack, and read their logs.
- Resources & policy: look up the available CPU and memory options and restart conditions.
- Container registry: manage the registries that stacks pull private images from.
Database
Managed MySQL, MongoDB, PostgreSQL and MariaDB instances, with backups. Overview →
- Instances: create, update, restore, get and list database instances.
- Backups: read an instance's backup history and backup log.
- Types: shared response types, pagination and enums are collected on Types.
VPS
Run a virtual machine (virtual private server) on Sabay infrastructure. Overview →
- Instances: list, get and create VPS instances.
- Lifecycle: instance changes (create, delete, start, stop, restart, resize, rebuild) run in the background and return an operation object. See Async operation model.
Next steps
- Get an access token and set the two request headers above.
- Pick a service from the sidebar and read its Overview page first. It covers that service's headers, subscription rules and status values.
- Use the per-operation pages. Each one shows the arguments, variables, request and response.
New to Storage? Start with Upload Files.