PATCH
/
pipelines
/
{pipeline_id}
/
enable
from mixpeek import Mixpeek
mixpeek = Mixpeek("API_KEY")

# Enable a pipeline
response = mixpeek.pipelines.enable(
    pipeline_id="b2ea3950",
    enable=True
)

# Disable a pipeline
response = mixpeek.pipelines.enable(
    pipeline_id="b2ea3950",
    enable=False
)
{
  "message": "<string>"
}

Pipelines in Mixpeek can be dynamically enabled or disabled, allowing you to control when they are active and processing data. This feature is useful for managing resource usage and operational flow without needing to delete or recreate pipelines.

Request

pipeline_id
string

The unique identifier for the pipeline you wish to enable or disable.

enable
boolean
required

Set to true to enable the pipeline, or false to disable it. Enabling a pipeline constructs all the necessary underlying architecture to start processing, while disabling it ceases all operations.

Response

message
string
required

Confirmation message indicating whether the pipeline has been enabled or disabled.

from mixpeek import Mixpeek
mixpeek = Mixpeek("API_KEY")

# Enable a pipeline
response = mixpeek.pipelines.enable(
    pipeline_id="b2ea3950",
    enable=True
)

# Disable a pipeline
response = mixpeek.pipelines.enable(
    pipeline_id="b2ea3950",
    enable=False
)

Was this page helpful?