Commands Reference

A Command in PIPEFORCE is a single action as part of an automation.

It can be defined inside an automation pipeline like this:

pipeline:
  - my.command:
      paramKey: paramValue

Or it can be called remotely using the Rest API. Here is an example, how a command can be called via HTTP GET:

GET https://hub-{ns}.pipeforce.net/api/v3/command:my.command?paramKey=paramValue

Replace {ns} by your own namespace name.

A request to this URL would call the command my.command at server side and finally returns the result of this command. The request query parameters will be set as command parameters. Any command can be callled using HTTP GET or HTTP POST. In case of HTTP POST, the body of the post request becomes the body to the command.

PIPEFORCE Rest API

Since a command is always a REST API endpoint, the most recent overview of all commands can be found in the PIPEFORCE Rest API documentation:

PIPEFORCE API

Pipeline and Commands Documentation

For more details about commands and automation pipelines, see the documentation pages:

Automation Pipeline and Commands