Sign in
Endpoint Redirections

Create dynamic endpoint redirection

Initiates a dynamic endpoint redirection from a source database to a target database. Returns a redirection ID that can be used to poll the status. This is available in private preview.

post/v1/endpoint-redirections

Request body

sourceDatabaseIdinteger required

ID of the source database to redirect the endpoint from.

targetDatabaseIdinteger required

ID of the target database to redirect the endpoint to.

endpointTargetType'public' | 'private' required

Type of endpoint to redirect.

duplicateACLsboolean

Whether to duplicate the source database ACLs to the target database.

migrationProtectionboolean required

Must be explicitly set to true to start the migration. This is a protective measure to avoid accidental migrations.

Example request

{
  "sourceDatabaseId": 51404231,
  "targetDatabaseId": 51404232,
  "endpointTargetType": "public",
  "duplicateACLs": true,
  "migrationProtection": true
}

Response

OK

redirectionIdstring uuid

Unique identifier of the dynamic endpoint redirection. Use it to poll the redirection status.

status'initiated' | 'pending' | 'in-progress' | 'completed' | 'failed' | 'reverted'

Current status of the dynamic endpoint redirection.

sourceDatabaseIdinteger

ID of the source database the endpoint is redirected from.

targetDatabaseIdinteger

ID of the target database the endpoint is redirected to.

isRevertboolean

Whether this redirection reverts a previously completed redirection.

duplicateACLsboolean

Whether the source database ACLs were duplicated to the target database.

startedAtstring date-time

Timestamp when the redirection started.

completedAtstring date-time

Timestamp when the redirection completed.

revertedAtstring date-time

Timestamp when the redirection was reverted, if applicable.

errorMessagestring

Error message describing why the redirection failed, if applicable.

Example response

{
  "redirectionId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "in-progress",
  "sourceDatabaseId": 51404231,
  "targetDatabaseId": 51404232,
  "duplicateACLs": true,
  "startedAt": "2024-05-01T13:03:08Z",
  "completedAt": "2024-05-01T13:05:42Z",
  "endpoints": [
    {
      "sourceEndpointName": "redis-12345",
      "targetEndpointName": "redis-12346",
      "sourceEndpointType": "public",
      "targetEndpointType": "public"
    }
  ]
}

Changes

Changed in 2 of the 68 revisions of this API.11