ReadReplicaSet

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/timescale/main/json-schema/timescale-read-replica-set-schema.json",
  "title": "ReadReplicaSet",
  "x-generated": "2026-10-13",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/timescale-read-replica-sets-api-openapi.yml#/components/schemas/ReadReplicaSet",
  "type": "object",
  "properties": {
    "id": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "status": {
      "type": "string",
      "enum": [
        "creating",
        "active",
        "resizing",
        "deleting",
        "error"
      ]
    },
    "nodes": {
      "type": "integer",
      "description": "Number of nodes in the replica set."
    },
    "cpu_millis": {
      "type": "integer",
      "description": "CPU allocation in milli-cores."
    },
    "memory_gbs": {
      "type": "integer",
      "description": "Memory allocation in gigabytes."
    },
    "metadata": {
      "type": "object",
      "description": "Additional metadata for the read replica set",
      "properties": {
        "environment": {
          "type": "string",
          "description": "Environment tag for the read replica set"
        }
      }
    },
    "endpoint": {
      "$ref": "#/$defs/Endpoint"
    },
    "connection_pooler": {
      "$ref": "#/$defs/ConnectionPooler"
    }
  },
  "$defs": {
    "ConnectionPooler": {
      "type": "object",
      "properties": {
        "endpoint": {
          "$ref": "#/$defs/Endpoint"
        }
      }
    },
    "Endpoint": {
      "type": "object",
      "properties": {
        "host": {
          "type": "string"
        },
        "port": {
          "type": "integer"
        }
      }
    }
  }
}