Skip to main content
GET
Get Replica

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys. User-session JWTs are not accepted by /v1/replica endpoints.

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 replica information including engine status and environment