Sign in
Databases

List read-only regions

List read-only regions for the database's default branch

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_database, delete_database, write_database, read_branch, delete_branch, create_branch, promote_branches, demote_branches, delete_production_branch, connect_branch, connect_production_branch, connect_production_read_only_branch, delete_branch_password, delete_production_branch_password, delete_production_read_only_branch_password, read_deploy_request, create_deploy_request, approve_deploy_request, read_comment, create_comment, restore_backup, restore_production_branch_backup, read_backups, write_backups, delete_backups, delete_production_branch_backups, write_branch_vschema, write_production_branch_vschema, read_workflow, write_workflow, delete_workflow

OAuth Scopes

ResourceScopes
Organizationread_branches
Databaseread_branches
get/organizations/{organization}/databases/{database}/read-only-regions

Path parameters

organizationstring required

Organization name slug from list_organizations. Example: acme.

databasestring required

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

Query parameters

pageinteger

If provided, specifies the page offset of returned results

per_pageinteger

If provided, specifies the number of returned results

Response

List of the database's read-only regions

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

Changed in 3 of the 24 revisions of this API.74

  • 4b2e4f05bda21See the full diff
    • ○

      added the required property per_page to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 72506953f36753See the full diff
    • ▲

      the response property data/items/ready_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property next_page became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property next_page_url became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property prev_page became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property prev_page_url became nullable for the status 200

      response-property-became-nullable

    • ○

      added the required property data/items/region/mysql_supported to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/region/postgresql_supported to the response with the 200 status

      response-required-property-added

    • ○

      added the required property type to the response with the 200 status

      response-required-property-added

  • d710019068fb2See the full diff
    • ▲

      for the query request parameter page, the type/format was changed from number/ to integer/

      request-parameter-type-changed

    • ▲

      for the query request parameter per_page, the type/format was changed from number/ to integer/

      request-parameter-type-changed