API Reference

API Reference Overview

Base URL, authentication, rate limits, pagination, and errors. Browse all endpoints below or try the API in the Playground.

Quick reference

Base URL	`https://api.mudbase.dev/api/sandboxes`
Authentication	`Authorization: Bearer YOUR_API_KEY` or `X-API-Key`
Rate limit	Per API key, configurable - see Rate Limits
Spec	Download OpenAPI

Base URL

text

https://api.mudbase.dev/api/sandboxes
https://api.mudbase.dev/api/sandboxes

Authentication

Send your API key in the Authorization: Bearer YOUR_API_KEY header, or use X-API-Key for server-to-server. See Authentication (Concepts) and User Authentication.

Get your API key

Create and manage API keys in the Mudbase Console under your project settings.

Rate limits

Limits are set per API key and vary by endpoint - auth endpoints are stricter than general traffic. When exceeded, the API returns 429 Too Many Requests. See Rate Limits.

Pagination

List endpoints support limit and cursor (or offset). Responses include next_page when more results exist. See Pagination.

Errors

Standard HTTP status codes: 400 Bad Request, 401 Unauthorized, 403 Forbidden, 404 Not Found, 429 Rate limited, 5xx Server error. See Error Explorer for full reference.

Try the API

Use the Playground to send live requests, or import the OpenAPI spec into Postman.

Open API Playground Run in Postman Download OpenAPI

Endpoints

All API operations grouped by tag. Filter by path, method, or tag, or click any endpoint for parameters, request/response schemas, and try-it-live.

24 endpoints

Sessions

GET/projects/{projectId}

List sessions

POST/projects/{projectId}

Create a session

GET/projects/{projectId}/sessions/{sessionId}

Get a session

PATCH/projects/{projectId}/sessions/{sessionId}

Update session metadata

DELETE/projects/{projectId}/sessions/{sessionId}

Close a session

POST/projects/{projectId}/sessions/{sessionId}/connect-token

Get a connect token

POST/projects/{projectId}/sessions/{sessionId}/suspend

Suspend a session

POST/projects/{projectId}/sessions/{sessionId}/resume

Resume a session

POST/projects/{projectId}/sessions/{sessionId}/expose

Expose a port

DELETE/projects/{projectId}/sessions/{sessionId}/volume

Delete a cell's persistent volume

Execution

POST/projects/{projectId}/sessions/{sessionId}/exec

Run a command (streaming SSE)

Files

GET/projects/{projectId}/sessions/{sessionId}/files

Read a file

POST/projects/{projectId}/sessions/{sessionId}/files

Write files

Services

GET/projects/{projectId}/sessions/{sessionId}/services

List services

POST/projects/{projectId}/sessions/{sessionId}/services

Start a service

DELETE/projects/{projectId}/sessions/{sessionId}/services/{name}

Stop a service

GET/projects/{projectId}/sessions/{sessionId}/services/{name}/logs

Get service logs (snapshot)

GET/projects/{projectId}/sessions/{sessionId}/services/{name}/logs/stream

Stream service logs (SSE)

Checkpoints

POST/projects/{projectId}/sessions/{sessionId}/checkpoint

Create a checkpoint

GET/projects/{projectId}/sessions/{sessionId}/checkpoints

List checkpoints

POST/projects/{projectId}/sessions/{sessionId}/restore

Restore from a checkpoint

GET/projects/{projectId}/sessions/{sessionId}/restores/{restoreId}

Get restore job status

DELETE/projects/{projectId}/sessions/{sessionId}/checkpoints/{checkpointId}

Delete a checkpoint

Billing

GET/projects/{projectId}/billing/usage

Get billing usage

Next

NEXT →API PlaygroundSearch any endpoint and send a live request.NEXT →QuickstartInstall the SDK and make your first request.NEXT →AuthenticationAPI keys, Bearer tokens, and user sessions.

Last updated: October 2026

Edit this page on GitHub