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:

ServicePrefix
Profile & Accountsso_ (plus mysabay_chatbot_listChatBotByUser)
Storages3_
Transcoders3_ (shared with Storage)
Run Appcontainer_
Databasedb_
VPSinstance_

Every request carries the same two headers:

HeaderValue
service-codecloud_user
AuthorizationBearer {token}

VPS operations also send VPS-specific headers. See VPS headers.

Profile & Account

Manage the signed-in user's own account. Overview →

Storage

S3-compatible object storage for files, backups and media. Overview →

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 →

Database

Managed MySQL, MongoDB, PostgreSQL and MariaDB instances, with backups. Overview →

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

  1. Get an access token and set the two request headers above.
  2. Pick a service from the sidebar and read its Overview page first. It covers that service's headers, subscription rules and status values.
  3. Use the per-operation pages. Each one shows the arguments, variables, request and response.

New to Storage? Start with Upload Files.