Skip to content
Management API Reference

Set up a read replica

post/v1/projects/{ref}/read-replicas/setup

This is an experimental endpoint. It is subject to change or removal in future versions. Use it with caution, as it may not remain supported or stable.

This endpoint is currently in its Beta stage.

This endpoint is only available on the following plans:

  • Pro
  • Team
  • Enterprise

The fine-grained token must include the following permissions to access this endpoint:

  • infra_read_replicas_write

Path parameters

  • ref
    Required
    string

    Project ref

Body

  • read_replica_region
    Required
    enum

Response codes

  • 204
  • 401
  • 402
  • 403
  • 429
  • 500

Response (204)

{}