Sign in
api-read_only_replica_changes

Get read-only replica change requests

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses read_branch, delete_branch, create_branch, connect_production_branch, connect_branch

OAuth Scopes

ResourceScopes
Organizationread_branches
Databaseread_branches
Branchread_branch
get/organizations/{organization}/databases/{database}/branches/{branch}/read-only-replica-changes

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

databasestring required

Database name slug from list_databases. Example: app-db.

branchstring required

Branch name from list_branches. Example: main.

Query parameters

pageinteger

If provided, specifies the page offset of returned results

per_pageinteger

If provided, specifies the number of returned results

period'15m' | '1h' | '3h' | '6h' | '12h' | '1d' | '2d' | '7d' | '8d'

Filter change requests by named period

completed_atstring

Filter change requests completed between two ISO 8601 timestamps

Response

Returns read-only replica change requests

typestring required

The response type. Always "list" for paginated responses.

current_pageinteger required

The current page number

per_pageinteger required

The maximum number of results per page

next_pageinteger nullable required

The next page number, or null when this is the last page

next_page_urlstring nullable required

The next page of results, or null when this is the last page

prev_pageinteger nullable required

The previous page number, or null when this is the first page

prev_page_urlstring nullable required

The previous page of results, or null when this is the first page

Changes