REredis
v2
pipelines

Patch Pipeline

Changed on

Updates a pipeline partially (only updates specified fields).

patch/api/v2/pipelines/{name}

Request

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

Path parameters

namestring required

Pipeline name

Query parameters

dry_runboolean

Only validate the provided configuration without making changes

validate_tablesboolean

Validate against source and target databases via collector API

validate_cdcboolean

Validate CDC configuration via collector API

Request body

activeboolean nullable
configobject nullable

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
    • breaking

      query request parameter dry_run list-of-types was narrowed by removing types null

    • breaking

      for the query request parameter dry_run, the type changed from no type to boolean

    • 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 non-success response with the status

    • 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 new optional query request parameter validate_tables

    • 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