Skip to main content

Rigbox API home page

Workspaces

GET
List Workspaces
POST
Create Workspace
GET
Get Workspace
DEL
Delete Workspace
POST
Start Workspace
POST
Stop Workspace
POST
Update Environment Variables
PUT
Update Workspace Resources
GET
Get Workspace Metrics
GET
Get Workspace Logs
GET
Stream Workspace Logs
GET
Get Workspace Tasks

Apps

GET
List Apps
POST
Create App
GET
Get App
PATCH
Update App
DEL
Delete App
POST
Start App Service
POST
Stop App Service
POST
Restart App Service
GET
Get App Parameters
PATCH
Update App Parameters
PUT
Update App Visibility
PUT
Update App Status
GET
Check App Health
POST
Expose Port
POST
Reconcile Apps
GET
Get Listening Ports

App Logs

GET
Get App Logs
GET
Stream App Logs
GET
List Log Sources
POST
Create Log Source
PATCH
Update Log Source
DEL
Delete Log Source

Snapshots

GET
List Workspace Snapshots
POST
Create Snapshot
DEL
Delete Workspace Snapshot
POST
Restore Workspace Snapshot
GET
List All Snapshots
DEL
Delete Snapshot
POST
Restore Snapshot

SSH Keys

GET
List SSH Keys
POST
Add SSH Key
DEL
Delete SSH Key
GET
List Workspace SSH Keys
POST
Sync Workspace SSH Keys

Templates

GET
List Templates
POST
Quick Deploy

AI

GET
Get AI Credits
GET
Get User Limits
GET
Get AI Usage
GET
Get AI Defaults
PUT
Update AI Defaults
PUT
Update AI Mode
GET
Get Workspace AI Config
PUT
Update Workspace AI Config

Tools

GET
List Tools
GET
Get Tool Status
POST
Launch Tool
POST
Stop Tool
POST
Install Tool
GET
Get Install Status

Setup Scripts

GET
List Setup Scripts
POST
Create Setup Script
GET
Get Setup Script
PUT
Update Setup Script
DEL
Delete Setup Script

Service Specs

GET
List Service Specs
POST
Create Service Spec
GET
Get Service Spec
PUT
Update Service Spec
DEL
Delete Service Spec

App Catalog

GET
List App Catalog
POST
Install App
GET
Get Job Status

Roadmap

GET
Get Roadmap Votes
POST
Toggle Vote

System

GET
Get Feature Flags

User Settings

GET
Get User Settings
PUT
Update User Settings
GET
List Regions

Access Control

GET
Search Principals
GET
List Bindings
POST
Create Binding
PATCH
Update Binding
DEL
Delete Binding
GET
Get Tags
PUT
Update Tags
GET
Get Throttle Binding
PUT
Update Throttle Binding
GET
List Throttle Presets
GET
List Role Presets
POST
Simulate Access

API Keys

GET
List API Keys
POST
Create API Key
DEL
Delete API Key

Other

GET
Server Capacity
GET
List Images

Apps

Reconcile Apps

Ensure all expected template apps exist for a workspace.

Call this after quick-deploy or workspace start to make sure template-defined apps are created and routed.

Expose Port Get Listening Ports

⌘I

Powered byThis documentation is built and hosted on Mintlify, a developer documentation platform

Assistant

Responses are generated using AI and may contain mistakes.