Change mirror state - PeerDB Docs: Setup your ETL in minutes with SQL.

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"
}'

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_RUNNING"
}'

curl --request POST \
  --url http://localhost:3000/api/v1/mirrors/state_change \
  --header 'Authorization: Basic Xk5hY3VhXXXZTP0IP==' \
  --header 'Content-Type: application/json' \
  --data '{
	"flowJobName": "mirror_kick_off",
	"requestedFlowState": "STATUS_RUNNING",
	"flowConfigUpdate": {
		"cdcFlowConfigUpdate":{
      "idle_timeout": 600,
      "batch_size": 100000,
			"additional_tables":[
        {
          "sourceTableIdentifier": "public.added_table",
          "destinationTableIdentifier": "added_table_destination"
        },
        {
          "sourceTableIdentifier": "public.added_table_2",
          "destinationTableIdentifier": "added_table_destination_2",
          "exclude": ["column1", "column2"]
        }
      ]
		}
	}
}'

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": 6
}'

{
	"ok": true,
	"errorMessage": ""
}

{}

{
	"code": 2,
	"message": "unable to get workflowID for flow job fake_mirror: no rows in result set",
	"details": []
}

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"
}'

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_RUNNING"
}'

curl --request POST \
  --url http://localhost:3000/api/v1/mirrors/state_change \
  --header 'Authorization: Basic Xk5hY3VhXXXZTP0IP==' \
  --header 'Content-Type: application/json' \
  --data '{
	"flowJobName": "mirror_kick_off",
	"requestedFlowState": "STATUS_RUNNING",
	"flowConfigUpdate": {
		"cdcFlowConfigUpdate":{
      "idle_timeout": 600,
      "batch_size": 100000,
			"additional_tables":[
        {
          "sourceTableIdentifier": "public.added_table",
          "destinationTableIdentifier": "added_table_destination"
        },
        {
          "sourceTableIdentifier": "public.added_table_2",
          "destinationTableIdentifier": "added_table_destination_2",
          "exclude": ["column1", "column2"]
        }
      ]
		}
	}
}'

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": 6
}'

{
	"ok": true,
	"errorMessage": ""
}

{}

{
	"code": 2,
	"message": "unable to get workflowID for flow job fake_mirror: no rows in result set",
	"details": []
}

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

string

required

The name of the mirror.

string

required

The state to change the mirror to. Possible values are:

STATUS_PAUSED (2) - Pause the mirror
STATUS_RUNNING (1) - Resume the mirror
STATUS_TERMINATING (6) - Drop the mirror

Resuming via editing a mirror If you are editing a paused CDC mirror, you can include the following fields.

Editing a mirror resumes it automatically.

object

Show flowConfigUpdate

object

Show cdcFlowConfigUpdate

number

The sync interval of the CDC mirror in seconds.

number

The pull batch size of the CDC mirror

string

Additional tables to sync. You cannot add and remove the same table in the same request. You can also specify column exclusion here.

Show child attributes

string

The source table identifier.

string

The destination table identifier.

array

Columns to exclude from the sync.

string

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.

Show child attributes

string

The source table identifier.

string

The destination table identifier.

Response Fields

boolean

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"
}'

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_RUNNING"
}'

curl --request POST \
  --url http://localhost:3000/api/v1/mirrors/state_change \
  --header 'Authorization: Basic Xk5hY3VhXXXZTP0IP==' \
  --header 'Content-Type: application/json' \
  --data '{
	"flowJobName": "mirror_kick_off",
	"requestedFlowState": "STATUS_RUNNING",
	"flowConfigUpdate": {
		"cdcFlowConfigUpdate":{
      "idle_timeout": 600,
      "batch_size": 100000,
			"additional_tables":[
        {
          "sourceTableIdentifier": "public.added_table",
          "destinationTableIdentifier": "added_table_destination"
        },
        {
          "sourceTableIdentifier": "public.added_table_2",
          "destinationTableIdentifier": "added_table_destination_2",
          "exclude": ["column1", "column2"]
        }
      ]
		}
	}
}'

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": 6
}'

{
	"ok": true,
	"errorMessage": ""
}

{}

{
	"code": 2,
	"message": "unable to get workflowID for flow job fake_mirror: no rows in result set",
	"details": []
}

​Request Fields

​Response Fields

Request Fields

Response Fields