Versions Compared

Key

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

...

Path

Method

Description

/api/v3/pipeline

Status
colourGreen
titlePOST

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

  • 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
colourYellow
titlePUT

Store
the pipeline YAML given in the body in the property store at {path}. Overwrite any existing one.

/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.

/api/v3/command:{name}

Status
colourGreen
titlePOST

Status
colourBlue
titleGET

Execute
the a single command given by name {name}.

  • The request body in

    Status
    colourGreen
    titlePOST
    requests will become the body of the command.

  • Request params of

    Status
    colourGreen
    titlePOST
    or
    Status
    colourBlue
    titleGET
    requests will become the params to the command.

See the Command API documentation for a listing of all built-in commands.

For more details see the API Documentation.

...