API Reference

Projects

Services

Replica Sets

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Read Replica Sets

GET/projects/{project_id}/services/{service_id}/replicaSets

Retrieves a list of all read replica sets associated with a primary service within a project.

Path ParametersExpand Collapse

project_id: string

service_id: string

ReturnsExpand Collapse

id: optional string

connection_pooler: optional ConnectionPooler { endpoint }

endpoint: optional Endpoint { host, port }

host: optional string

port: optional number

cpu_millis: optional number

CPU allocation in milli-cores.

endpoint: optional Endpoint { host, port }

host: optional string

port: optional number

memory_gbs: optional number

Memory allocation in gigabytes.

metadata: optional object { environment }

Additional metadata for the read replica set

environment: optional string

Environment tag for the read replica set

name: optional string

nodes: optional number

Number of nodes in the replica set.

status: optional "creating" or "active" or "resizing" or 2 more

One of the following:

"creating"

"active"

"resizing"

"deleting"

"error"

Get Read Replica Sets

HTTP

HTTP

TypeScript

curl http://localhost:8080/projects/$PROJECT_ID/services/$SERVICE_ID/replicaSets \
    -H "Authorization: Bearer $TIGER_CLOUD_API_KEY"

200 example

[
  {
    "id": "alb8jicdpr",
    "connection_pooler": {
      "endpoint": {
        "host": "my-service.com",
        "port": 8080
      }
    },
    "cpu_millis": 250,
    "endpoint": {
      "host": "my-service.com",
      "port": 8080
    },
    "memory_gbs": 1,
    "metadata": {
      "environment": "environment"
    },
    "name": "reporting-replica-1",
    "nodes": 2,
    "status": "active"
  }
]

Returns Examples

200 example

[
  {
    "id": "alb8jicdpr",
    "connection_pooler": {
      "endpoint": {
        "host": "my-service.com",
        "port": 8080
      }
    },
    "cpu_millis": 250,
    "endpoint": {
      "host": "my-service.com",
      "port": 8080
    },
    "memory_gbs": 1,
    "metadata": {
      "environment": "environment"
    },
    "name": "reporting-replica-1",
    "nodes": 2,
    "status": "active"
  }
]