Skip to main content
GET
/
projects
/
{project_id}
/
services
/
{service_id}
/
replicaSets
Get Read Replica Sets
curl --request GET \
  --url https://console.cloud.timescale.com/public/api/v1/projects/{project_id}/services/{service_id}/replicaSets
[
  {
    "id": "alb8jicdpr",
    "name": "reporting-replica-1",
    "status": "active",
    "nodes": 2,
    "cpu_millis": 250,
    "memory_gbs": 1,
    "metadata": {
      "environment": "<string>"
    },
    "endpoint": {
      "host": "my-service.com",
      "port": 8080
    },
    "connection_pooler": {
      "endpoint": {
        "host": "my-service.com",
        "port": 8080
      }
    }
  }
]

Path Parameters

​
project_id
string
required

The unique identifier of the project.

Example:

"rp1pz7uyae"

​
service_id
string
required

The unique identifier of the service.

Example:

"d1k5vk7hf2"

Response

A list of read replica sets.

​
id
string
Example:

"alb8jicdpr"

​
name
string
Example:

"reporting-replica-1"

​
status
enum<string>
Available options:
creating,
active,
resizing,
deleting,
error
Example:

"active"

​
nodes
integer

Number of nodes in the replica set.

Example:

2

​
cpu_millis
integer

CPU allocation in milli-cores.

Example:

250

​
memory_gbs
integer

Memory allocation in gigabytes.

Example:

1

​
metadata
object

Additional metadata for the read replica set

​
endpoint
object
​
connection_pooler
object