Skip to main content

​
Prerequisites

Create an API key in the Rigbox console, or use rig login for CLI-mediated requests. Keep the key outside source control. Run the following locally or on your backend; never embed the key in browser JavaScript.

​
Use the CLI

This reuses the CLI’s authentication and prints the response. Consult CLI output before assuming every command emits a single JSON document.

​
Use HTTP directly

Set RIG_API_KEY through your environment or secret manager, then run:
Read the response envelope and pagination fields shown in List Workspaces. An empty collection is a valid result for a new account.

​
Resolve failures

A 401 indicates missing or invalid credentials. A 403 indicates the caller cannot perform the operation. Check the request URL and authorization header rather than retrying indefinitely. See authentication and API conventions.

​
Next step

Manage a workspace lifecycle and persist the returned IDs in your application’s database.