Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Replications

List replications for a given project

Retrieves a paginated list of replications for the specified project.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Owner
  • Project Owner

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/projects/{projectId}/replications

Path parameters

organizationIdstring uuid required
Example:ffffffff-aaaa-1414-eeee-000000000000

The GUID4 ID of the organization.

projectIdstring uuid required
Example:ffffffff-aaaa-1414-eeee-000000000000

The GUID4 ID of the project.

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

sortBystring[]

Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: id, sourceCluster, targetCluster, status, direction, priority.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

Response

List of replications for the project.

Example response

{
  "data": [
    {
      "id": "MDIwN23ewrerfetrmZmUzYzExYTcxMTA4MjJkYjJiNmYvdGVzdDEvdGVzdDI=",
      "sourceCluster": "SourceCluster",
      "targetCluster": "TargetCluster",
      "status": "running",
      "audit": {
        "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "createdAt": "2021-09-01T12:34:56Z"
      }
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}