Skip to main content
GET
Get replica

Authorizations

Authorization
string
header
required

Organization or personal API key from Settings → API Keys.

Headers

X-Replicas-Api-Version
enum<string>

API version. 2026-10-07 returns snake_case responses. See versioning.

Available options:
2026-10-07

Path Parameters

id
string<uuid>
required

The unique identifier of the replica

Query Parameters

include
string

Comma-separated list of additional fields to include in the response

Example:

"environment,diffs"

Response

Successful response

replica
object
required

Detailed workspace information including engine status and environment