REredis
v2
pipelines

Reset Pipeline

Changed on

Resets a pipeline, or a single source when one is given.

post/api/v2/pipelines/{name}/reset

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/pipelines/{name}/reset
  • Auth
    HTTP bearer

Path parameters

namestring required

Pipeline name

Query parameters

sourcestring nullable

Reset only this source; the other sources keep their data. The whole pipeline is stopped while the reset runs and starts again afterwards. Must be an existing source that is not of type 'external'.

Response

Successful Response

namestring required
activeboolean required
configobject required
status'started' | 'stopped' | 'error' | 'creating' | 'updating' | 'deleting' | 'starting' | 'stopping' | 'resetting' | 'pending' | 'standby' | 'unknown'

Pipeline status.

status_changed_atstring date-time nullable
currentboolean

Changes

  • 38675c1371b2Revision changes
    • warning

      added the new flink-collector enum value to the // response property for the response status

    • warning

      added the new standby enum value to the // response property for the response status

    • warning

      added the new standby enum value to the response property for the response status

    • info

      added the new optional query request parameter source

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      removed the flink-processor-jobmanager enum value from the // response property for the response status

    • info

      removed the flink-processor-taskmanager enum value from the // response property for the response status

  • e381b64b5ffcRevision changes
    • warning

      added the new flink-processor enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status