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:

  1. Pausing a mirror
  2. Resuming a mirror
  3. Dropping a mirror

​
Request Fields

flowJobName
string
required

The name of the mirror.

requestedFlowState
string
required

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

  • STATUS_PAUSED - Pause the mirror
  • STATUS_RUNNING - Resume the mirror
  • STATUS_TERMINATED - Drop the mirror

​
Response Fields

Ok
boolean

Whether the request was successful.

Mirror status