---
name: oblien-api
description: >-
  Oblien control-plane API at api.oblien.com - create, manage, and monitor workspaces. Covers CRUD, lifecycle (start/stop/restart), resources (CPU/memory/disk), snapshots, workloads, images, logs, metrics, metadata, filesystem, and usage endpoints. Authenticate with API key headers.
license: MIT
compatibility:
  - claude-code
  - cursor
  - openclaw
  - goose
  - jetbrains-ai
metadata:
  author: oblien
  version: 1.0.0
  source: https://oblien.com/docs
---

# Oblien Control-Plane API

The Oblien API at `https://api.oblien.com` lets you create, manage, and monitor **workspaces** - isolated Firecracker microVMs with their own Linux kernel, filesystem, and network.

## What you can do

- **Create workspaces** from base images (Node, Python, Go, Rust, Ubuntu, etc.) with custom CPU/memory/disk
- **Control lifecycle** - start, stop, restart, set permanent or temporary mode with TTL
- **Configure networking** - firewall, public access, private links between workspaces, dedicated outbound IPs
- **Manage resources** - scale CPU, memory, and disk (hot or on next restart)
- **Snapshot and restore** - full VM snapshots or disk-only versioned archives
- **Run workloads** - managed background processes with lifecycle control
- **Monitor** - real-time CPU/memory/network metrics via SSE, logs, usage data

## Authentication

All requests require API key headers:

```
X-Client-ID: your-client-id
X-Client-Secret: your-client-secret
```

Get credentials from Dashboard → Settings → API Credentials.

## Common workflow

1. Create a workspace: `POST /workspace` with image, resources, and config
2. Wait for it to start (or set `wait_for_init: true`)
3. Enable the Runtime API: `POST /workspace/:id/runtime-api-access/enable` → get a Gateway JWT
4. Use the JWT to call the workspace's runtime API at `workspace.oblien.com`
5. When done: stop, snapshot, or delete the workspace

---

The reference below covers every control-plane endpoint.

## Reference files

Each section below is loaded on demand. Read only what you need for the current task.

- **[API Overview](references/index.md)** (198 lines)
- **[Workspaces (CRUD)](references/workspaces.md)** (603 lines)
- **[Lifecycle & Power](references/lifecycle.md)** (470 lines)
- **[Resources](references/resources.md)** (150 lines)
- **[Snapshots & Archives](references/snapshots.md)** (288 lines)
- **[Workloads](references/workloads.md)** (411 lines)
- **[Images](references/images.md)** (88 lines)
- **[Namespaces](references/namespaces.md)** (1077 lines)
- **[Logs](references/logs.md)** (217 lines)
- **[Metrics & Stats](references/metrics.md)** (186 lines)
- **[Metadata](references/metadata.md)** (99 lines)
- **[Usage](references/usage.md)** (344 lines)

### Quick search

Find specific endpoints, methods, or parameters across all references:

```bash
grep -ri "keyword" references/
```