API Reference — Rails Cloud

Base URL

            https://api.railscloud.co/v1
        

Authentication

Two methods are supported. JWT Bearer tokens for user sessions, and dk_ API keys for programmatic access.

# JWT Bearer token (dashboard sessions)
Authorization: Bearer <jwt_token>

# API key (programmatic access)
Authorization: Bearer dk_live_your_api_key

Cloud Platform

Infrastructure and deployment products you manage via API or CLI.

VPS

Create, manage, and scale virtual private servers. Start/stop, resize, snapshots, console access, and metrics.

View docs

Launchpad

Deploy apps from Git. Push code, auto-build, scale horizontally, custom domains, environment variables, and rollbacks.

View docs

Co-Stream

Live streaming rooms, recordings, and participant management. Build video conferencing or live events into your app.

View docs

Developer APIs

Provision any of these APIs from your dashboard, get a dk_ key, and start making requests immediately.

Rails Auth

auth.railscloud.co

OTP authentication, sessions, KYC, 2FA

View docs

Rails Pay

pay.railscloud.co

Wallets, transfers, holds, escrow

View docs

Rails Media

media.railscloud.co

Upload, transcode, stream video

View docs

Rails Vault

vault.railscloud.co

Documents, photos, notes, tasks, calendar

View docs

Rails Messaging

messaging.railscloud.co

Email, SMS, push, WhatsApp

View docs

Rails Location

location.railscloud.co

Geocoding, routing, places, tracking

View docs

Quick Start

Provision an API product from the dashboard, grab your key, and make your first call:

# Create a VPS
curl -X POST https://api.railscloud.co/v1/projects/my-project/vps \
  -H "Authorization: Bearer dk_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "web-01", "size": "sm", "image": "ubuntu-24.04"}'

# Request OTP via Rails Auth API
curl -X POST https://auth.railscloud.co/api/v1/auth/otp/request \
  -H "Authorization: Bearer dk_live_your_key" \
  -H "Content-Type: application/json" \
  -d '{"phone": "+263771234567"}'

CLI Tool

The rc command-line tool provides full API access from your terminal.

# Login
rc auth login

# Create a VPS
rc vps create --name web-01 --size sm --image ubuntu-24.04

# Deploy an app
rc app deploy --repo github.com/user/app --branch main

# List resources
rc vps list
rc app list
rc costream list

Response Format

All responses use a standard JSON envelope.

{
  "data": { ... },
  "meta": { "request_id": "..." }
}

Get an API Key