Stops data replication for the specified pipeline_id by removing its schedule. Jobs that are already running are allowed to finish, unless you set cancel_active_jobs to true to cancel them. Read Disabling your Edge Pipeline for more information about the actions performed on your Pipeline when you disable it.
The request body is optional. The Pipeline stays in the Disabling state until the running jobs finish. If the first historical load had not finished, Hevo also releases the resources it created in your Source for that load, such as the replication slot on a PostgreSQL Source. If the disable fails, the Pipeline moves to the Failed state, and you can then only resync or delete it.
The response returns the Pipeline in the Disabling state, and the Pipeline reaches the Disabled state once the action completes.
Refer to Disabling a Pipeline for more information about when and how to disable a Pipeline.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
The Pipeline could not be disabled. This occurs when the Pipeline is not in the Initialized state.
You do not have the permission to run this action on a Pipeline. Ask your team administrator for a role that allows it.
The Pipeline could not be found. This occurs when:
- No Pipeline exists with the specified
pipeline_id, or you do not have access to it. - The Pipeline is deleted, or its deletion is in progress.
- The Pipeline is in a different region from the base URL that you call.
The Pipeline could not be disabled. This occurs when the Pipeline is changing state, for example when it is in the Enabling or Initializing state. Retry the request once the Pipeline reaches a stable state, such as Initialized.