...
The PIPEFORCE HTTP API allows you to manage any aspect of the PIPEFORCE platform via RESTful HTTP calls. You can setup automation and data integration apps. Execute commands and pipelines. Manage users, webhooks, configs, gateway endpoints and much more using this API.
Here is a list of the most important entry-endpoints:
Path | Method | Description |
|---|
/api/v3/pipeline
| | 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.
See: https://pipeforce.github.io/api#/Pipeline%20API | Info |
|---|
For security reasons, executing adhoc pipelines is by default restricted to admin, support and developer users in DEV stage only. For production stage you should always consider to use persisted pipelines instead. |
|
/api/v3/pipeline:{path}
| | Store
the pipeline YAML given in the body in the property store at {path}. Overwrite any existing one. See: https://pipeforce.github.io/api#/Pipeline%20API |
/api/v3/pipeline:{path}
| | 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.
See: https://pipeforce.github.io/api#/Pipeline%20API |
/api/v3/pipeline:{path}
| | Return
the pipeline source persisted at {path} from the property store. See: https://pipeforce.github.io/api#/Pipeline%20API |
/api/v3/pipeline:{path}
| | Delete
the persisted pipeline at {path} from the property store. See: https://pipeforce.github.io/api#/Pipeline%20API |
/api/v3/property:{path}
|
| Create, read, update and delete persisted JSON documents, attachments and other data types in the persistence DB, called the Property Store. See: https://pipeforce.github.io/api#/Property%20API |
/api/v3/command:{name}
|
| Execute
a single command given by name {name}. The request body in requests will become the body of the command.Request params of or requests will become the params to the command.
See the Command API documentation here for a listing of all built-in commands.full list of available commands:
https://pipeforce.github.io/api |
For more details see the API Documentation.
...