List physical replication streams

Can be used by the following roles assigned at the organization, folder or cluster scope:

• CLUSTER_ADMIN
• CLUSTER_OPERATOR_WRITER
• CLUSTER_DEVELOPER

GET /api/v1/physical-replication-streams

cURL

cURL

curl --request GET \
  --url https://cockroachlabs.cloud/api/v1/physical-replication-streams \
  --header 'Authorization: Bearer <token>'

200

{
  "physical_replication_streams": [
    {
      "activation_at": "2006-01-03T15:04:15Z",
      "created_at": "2006-01-02T15:04:05Z",
      "failover_at": "2006-01-03T15:04:05Z",
      "id": "00000000-0000-0000-0000-000000000001",
      "primary_cluster_id": "00000000-0000-0000-0000-000000000002",
      "replicated_time": "2006-01-03T15:04:04Z",
      "retained_time": "2006-01-02T15:04:06Z",
      "standby_cluster_id": "00000000-0000-0000-0000-000000000003",
      "status": "COMPLETED"
    }
  ],
  "pagination": {
    "next_page": "<string>",
    "previous_page": "<string>"
  }
}

{
  "code": 123,
  "details": [
    {
      "@type": "<string>"
    }
  ],
  "message": "<string>"
}

This endpoint is in Preview and subject to change. Refer to the API support policy for more details.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

primary_cluster_id · string

primary_cluster_id, if set, will cause only replication streams with this cluster as the primary to be returned.

standby_cluster_id · string

standby_cluster_id, if set, will cause only replication streams with this cluster as the standby to be returned.

cluster_id · string

cluster_id, if set, will cause replication streams with this cluster as the primary or the standby to be returned.

show_completed · boolean

show_completed specifies whether or not replication streams in the completed state are shown.

pagination.page · string

pagination.limit · integer<int32>

pagination.as_of_time · string<date-time>

pagination.sort_order · enum<string>

• ASC: Sort in ascending order. This is the default unless otherwise specified.
• DESC: Sort in descending order.

Available options: ASC, DESC

Response

200

application/json

A successful response.

physical_replication_streams · object[] · required

physical_replication_streams is a list of PhysicalReplicationStreams.

Show child attributes

pagination · object

Show child attributes