POST /api/v1/mirrors/state_change
This endpoint can be used for changing the state of a mirror. To be specific, it can be used for:
- Pausing a mirror
- Resuming a mirror
- Editing a paused mirror
- Dropping a mirror
Request Fields
The state to change the mirror to. Possible values are:
STATUS_PAUSED - Pause the mirrorSTATUS_RUNNING - Resume the mirrorSTATUS_TERMINATED - Drop the mirror
If you are editing a paused CDC mirror, you can include the following fields.
Editing a mirror resumes it automatically.
The sync interval of the CDC mirror in seconds.
The pull batch size of the CDC mirror
Additional tables to sync. You cannot add and remove the same table in the same request.
You can also specify column exclusion here.
The source table identifier.
destinationTableIdentifier
The destination table identifier.
Columns to exclude from the sync.
Tables to remove from the sync. You cannot remove just a few columns.
You cannot add and remove the same table in the same request.
The source table identifier.
destinationTableIdentifier
The destination table identifier.
Response Fields
Whether the request was successful.
For an edit request, the response is empty if successful.
curl --request POST \
--url http://localhost:3000/api/v1/mirrors/state_change \
--header 'Authorization: Basic OmJkYWNrU3rhbjEyMw==' \
--header 'Content-Type: application/json' \
--data '{
"flowJobName": "mirror_kick_off",
"requestedFlowState": "STATUS_PAUSED"
}'
{
"ok": true,
"errorMessage": ""
}
