Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

The Pipeline HTTP API allows you to manage and execute pipelines via a HTTP requests, similar to REST calls. Here is a list of of available the most important endpoints:

Path

Method

Description

/api/v3/pipeline

Status
colourGreen
titlePOST

Execute adhoc
pipeline YAML or JSON given in the body. The pipeline is not stored.

/api/v3/pipeline:{path}

Status
colourYellow
titlePUT

Store
the pipeline YAML given in the body in the property store at {path}.

/api/v3/pipeline:{path}

Status
colourGreen
titlePOST

Load and execute
the persisted pipeline at {path} from the property store:

  • The request body will become the body of the pipeline.

  • Request params will be set in vars scope of the pipeline.

  • Request and response can be accessed via ${request} and ${response} object in the pipeline.

/api/v3/pipeline:{path}

Status
colourBlue
titleGET

Return
the pipeline persisted at {path} from the property store.

/api/v3/pipeline:{path}

Status
colourRed
titleDELETE

Delete
the persisted pipeline at {path} from the property store.

...