POST /pipeline/update
Update the state of the pipeline. All values that are not explicitly included in the request are left in their old state.
Authorizations
Section titled “Authorizations ”Request Body required
Section titled “Request Body required ”Body for the update endpoint
object
The id of the pipeline to be updated.
Example
08446737-da9b-4787-8599-97d85c48c3bbThe updated definition of the pipeline.
Example
export | where baz | publish /fooThe action that will change the pipeline’s running state.
Example
startUpdate the human-readable name of the pipeline to this value.
Example
zeek-monitoring-pipelineThe user-provided labels for this pipeline.
object
The pipeline label text.
Example
zeekThe pipeline label color.
Example
3F1A24Flags that specify on which state to restart the pipeline.
object
Autostart the pipeline upon creation.
Example
trueAutostart the pipeline upon completion.
Autostart the pipeline upon failure.
Flags that specify on which state to delete the pipeline.
object
Autodelete the pipeline upon completion.
Autodelete the pipeline upon failure.
Example
trueAutodelete the pipeline when it stops before completing.
A duration string specifying the minimum time between automatic restarts of a pipeline when an error occurs. Takes no effect if restarting on failure is disabled.
Example
500msA flag specifying whether this pipeline is unstoppable. Unstoppable pipelines start automatically, fail when they complete, and can not be paused or stopped manually.
Example
trueResponses
Section titled “ Responses ”Success.
The updated pipeline.
object
object
The pipeline id.
The human-readable name of the pipeline.
The pipeline definition.
A flag specifying whether this pipeline is unstoppable. Unstoppable pipelines start automatically, fail when they complete, and can not be paused or stopped manually.
Example
trueWhether this pipeline is hidden. Hidden pipelines are only available through the show pipelines operator.
The Unix timestamp of the pipeline creation time in nanoseconds.
The Unix timestamp of the last pipeline modification in nanoseconds.
If the pipeline has been started, the ISO 8601 timestamp of the most recent start.
The total amount of runs this pipeline has attempted so far.
The error that the pipeline may have encountered during running.
object
Example
unknown option `--frobnify`object
A potentially empty label.
Example
this option does not existA region in the source code, defined by byte offsets.
object
Example
42Example
48object
Example
usageExample
file <path> [-f|--follow] [-m|--mmap] [-t|--timeout <duration>]Example
[1m[31merror[39m: unknown option `--frobnify`[0mThe user-provided labels for this pipeline.
object
The pipeline label text.
Example
zeekThe pipeline label color.
Example
3F1A24A duration string specifying the minimum time between automatic restarts of a pipeline when an error occurs. Takes no effect if restarting on failure is disabled.
Example
10sFlags that specify on which state to restart the pipeline.
object
Autostart the pipeline upon creation.
Example
trueAutostart the pipeline upon completion.
Autostart the pipeline upon failure.
Flags that specify on which state to delete the pipeline.
object
Autodelete the pipeline upon completion.
Autodelete the pipeline upon failure.
Example
trueAutodelete the pipeline when it stops before completing.
If a TTL exists for this pipeline, the TTL as a duration string.
Example
2minIf a TTL exists for this pipeline, the remaining TTL as a duration string.
Example
10sInvalid arguments.
object
The error message.
Example
Invalid arguments