Commands API Reference

Reference documentation of all built-in Commands.

Download pipeline and commands schema: pipeline-schema.json
Also see: Pipeline Guide | Command Guide

Example usage of chained commands in a pipeline with PEL to access the body:

pipeline:  
  - datetime:  
      format: "dd/MM/yyyy"  
  - log:  
      message: "The current date is: #{body}"  

apidoc.commands

---

Returns the OpenAPI documentation of commands.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - apidoc.commands:  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/apidoc.commands?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command apidoc.commands id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

apidoc.pel.utils

---

Returns the OpenAPI documentation of PEL utils.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - apidoc.pel.utils:  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/apidoc.pel.utils?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command apidoc.pel.utils id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

app.install

---

Installs an app into the property store. The app can be located on GitHub or is provided as zip file content in the body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
overwrite	Boolean	false	false	What to do if app with this key already exists? If true, the existing app will be uninstalled and replaced by this new version. Otherwise, an attempt to install an existing app will cause an error.
github	String	false	null	A GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
branch	String	false	null	The GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
runTests	Boolean	false	false	Run the tests of the app after installation?
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
credentials	String	false	null	Refers to the name of a stored credentials secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
  - app.install:  
      overwrite: <value>  
      github: <value>  
      branch: <value>  
      runTests: <value>  
      id: <value>  
      if: <value>  
      credentials: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.install?overwrite=<value>&github=<value>&branch=<value>&runTests=<value>&id=<value>&if=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command app.install overwrite=<value> github=<value> branch=<value> runTests=<value> id=<value> if=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

app.marketplace.search

---

Searches the marketplace for apps ready to be installed. Note: This command is limited to max. 10 calls per minute.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
sort	String	false		Sorts the results by author-date or committer-date or (best-match). If null or empty, best-match will be used as default.
order	String	false	desc	Orders the result desc or asc.
results	String	false	30	Max. number of results per page.
page	String	false	1	The 1-based page number to return.
license	String	false	null	Limit the search to app repos with given exact license keyword only.
searchString	String	false	null	The text to search for.
searchInName	Boolean	false	true	Search for searchString in the app repo name?
searchInDesc	Boolean	false	true	Search for searchString in the app repo description?
searchInReadme	Boolean	false	true	Search for searchString in the app repo README file?
searchInTopics	Boolean	false	true	Search for searchString in the repo topics?
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - app.marketplace.search:  
      sort: <value>  
      order: <value>  
      results: <value>  
      page: <value>  
      license: <value>  
      searchString: <value>  
      searchInName: <value>  
      searchInDesc: <value>  
      searchInReadme: <value>  
      searchInTopics: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.marketplace.search?sort=<value>&order=<value>&results=<value>&page=<value>&license=<value>&searchString=<value>&searchInName=<value>&searchInDesc=<value>&searchInReadme=<value>&searchInTopics=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command app.marketplace.search sort=<value> order=<value> results=<value> page=<value> license=<value> searchString=<value> searchInName=<value> searchInDesc=<value> searchInReadme=<value> searchInTopics=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

app.uninstall

---

Uninstalls the given app.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
appKey	String	false	null	The key of the app to uninstall. For example: global/app/myapp.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
credentials	String	false	null	Refers to the name of a stored credentials secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
  - app.uninstall:  
      appKey: <value>  
      id: <value>  
      if: <value>  
      credentials: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.uninstall?appKey=<value>&id=<value>&if=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command app.uninstall appKey=<value> id=<value> if=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

app.update

---

Deprecated. Use app.install with param update:true instead. Updates the given apps.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
github	String	false	null	A GitHub repository path (owner/reponame) to download the app resources from. For example acme/myproject. If no credentials are given, the repo is expected to be a public one. If this parameter is missing, the app sources are expected in the body as zip file content instead.
branch	String	false	null	The GitHub repo branch, commit or tag reference to be used. If null or empty, the default branch of the GitHub repo will be used. This parameter will be ignored in case no value for github is given.
runTests	Boolean	false	false	Run the tests of the app after installation?
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
credentials	String	false	null	Refers to the name of a stored credentials secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
  - app.update:  
      github: <value>  
      branch: <value>  
      runTests: <value>  
      id: <value>  
      if: <value>  
      credentials: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/app.update?github=<value>&branch=<value>&runTests=<value>&id=<value>&if=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command app.update github=<value> branch=<value> runTests=<value> id=<value> if=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

assert

---

Evaluates a given PEL conditions and throws an error in case a condition is invalid.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
true	String	false	null	A PE which must evaluate to true.
false	String	false	null	A PE which must evaluate to false.
body.equals	String	false	null	The value of this param is compared to the body. If different, exception is thrown. Can be a PE.
equals	String	false	null	Compares the result of param value with this. If not equal, throws exception. Can be a PE.
value	String	false	null	The value to be used for comparision. Can be a PE.
message	String	false	null	An optional message to be used in case of invalid condition. Can be a PE.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - assert:  
      true: <value>  
      false: <value>  
      body.equals: <value>  
      equals: <value>  
      value: <value>  
      message: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/assert?true=<value>&false=<value>&body.equals=<value>&equals=<value>&value=<value>&message=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command assert true=<value> false=<value> body.equals=<value> equals=<value> value=<value> message=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

workflow.assert

---

Applies asserts for a given workflow in the workflow service.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
hasPassed	String	false	null	A comma separated list of task names to check whether they have been passed.
hasNotPassed	String	false	null	A comma separated list of task names to check whether they have not yet passed.
processFinished	String	false	null	If true, checks whether the process with given id has been finished.
throwException	String	false	true	If true, throws exception when assert is false. Otherwise returns the status in the body.
processInstanceId	String	true	null	The id of the process instance the task to check belongs to.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - workflow.assert:  
      hasPassed: <value>  
      hasNotPassed: <value>  
      processFinished: <value>  
      throwException: <value>  
      processInstanceId: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/workflow.assert?hasPassed=<value>&hasNotPassed=<value>&processFinished=<value>&throwException=<value>&processInstanceId=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command workflow.assert hasPassed=<value> hasNotPassed=<value> processFinished=<value> throwException=<value> processInstanceId=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

barcode.create

---

Creates a barcode from a dynamic format.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
text	String	false	null	The text value to be transformed to a barcode.
width	String	false	null	The width of the barcode. If empty, the default size is used.
height	String	false	null	The height of the barcode. If empty, the default size is used.
format	String	false	PDF_417	The dynamic format of the barcode to be created. One of: AZTEC, CODABAR, CODE_39, CODE_93, CODE_128, DATA_MATRIX, EAN_8, EAN_13, ITF, PDF_417, QR_CODE, UPC_A, UPC_E
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - barcode.create:  
      text: <value>  
      width: <value>  
      height: <value>  
      format: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/barcode.create?text=<value>&width=<value>&height=<value>&format=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command barcode.create text=<value> width=<value> height=<value> format=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

barcode.read

---

Reads a barcode from a dynamic PNG format. Expects the barcode image as content object in the body. Detects the barcode type automatically. By default returns the text extracted from the barcode in the body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - barcode.read:  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/barcode.read?id=<value>&if=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command barcode.read id=<value> if=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

bean

---

Executes a method on a Spring bean. Is only available for support users.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
name	String	false	null	The name of the bean.
method	String	false	null	The method name of the bean to be executed.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - bean:  
      name: <value>  
      method: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/bean?name=<value>&method=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command bean name=<value> method=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

body.delete

---

Sets the value in the body to null. Deletes any existing value in the body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - body.delete:  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/body.delete?id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command body.delete id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

body.filter

---

DEPRECATED. Converts the input body to JSON and then filters the input body and removes any properties not matching the given filter. Throws exception if input body cannot be converted to JSON.Does nothing, if input body is null or empty. If the first level of the body is a list, appliesthe filter to each element inside the list. This command can be used for example to filter outsensitive information or to shrink a big result set for performance reasons.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
properties	String	false	null	A comma separated list of first-level properties to be shown. If set, only those properties of the first level will be returned, those are listed here. All other properties will be omitted. For example to filter a user entity in the body with filter: id,username would return only the id and the username of the user. If not set, the body will not be converted and filtered at all and returned unchanged.
removeKey	Boolean	false	false	Can only be applied, if the result is a list and contains elements with a single property each. For example: [{name: foo}, {name: bar}]. If set to true, removes the key from the property and converts the result to a simple list like: [foo, bar]. If the result is not a list or elements in the list contain more than one property, this param is ignored.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - body.filter:  
      properties: <value>  
      removeKey: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/body.filter?properties=<value>&removeKey=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command body.filter properties=<value> removeKey=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

cache.clear

---

Clears the underlying central cache and removes any entry those time to live has been expired. Can also be used to remove a single entry from the cache.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
key	String	false	null	The key to load the value from the cache to remove. If empty or null, all entries in the cache will be inspected and those time to live has been expired will be removed.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - cache.clear:  
      key: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/cache.clear?key=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command cache.clear key=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

cache.get

---

Reads a value with given key from the cache and writes it into the output.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
key	String	true	null	The key to load the value from the cache.
remove	Boolean	false	false	If true, removes the entry after it was successfully returned.
exit	Boolean	false	false	If true, exits the pipeline if cache entry exists.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - cache.get:  
      key: <value>  
      remove: <value>  
      exit: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/cache.get?key=<value>&remove=<value>&exit=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command cache.get key=<value> remove=<value> exit=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

cache.info

---

Returns information about the current state of the cache. Available for system and support users only.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
key	String	false	null	Returns the info for a given cache entry. If null or empty, the overall cache info is returned.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - cache.info:  
      key: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/cache.info?key=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command cache.info key=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

cache.list

---

Lists ALL entries of the cache. Use with care!

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - cache.list:  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/cache.list?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command cache.list id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

cache.put

---

Saves the given value under given key into a central cache. If no value param is given, uses the body as cache value. The max time to live of each entry is 120 min. The min time to live is 5 min. Default is 5 min.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
timeToLive	Integer	false	5	The min. time to live for this cache entry in minutes. If not set or negative, will be set to default = 5 min. If value is bigger than 120, will be limited to 120 (2 hours). If value is smaller than 5, will be extended to 5.
key	String	true	null	The unique key for the cache entry.
value	String	false	null	The value for the cache entry. If not set, null is used.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - cache.put:  
      timeToLive: <value>  
      key: <value>  
      value: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/cache.put?timeToLive=<value>&key=<value>&value=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command cache.put timeToLive=<value> key=<value> value=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

call

---

Calls a script and returns with the result in the body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
uri	String	true	null	The uri to be called.
args	Object	false	null	Name value pair of arguments to be passed to the script. If the script is a pipeline, the arguments are set as vars overwriting any existing vars.If the script is a remote HTTP URL, the arguments are passed as request parameters, each.If the script is a script in classpath or property store, the arguments are passed via implicit variable: pi.args.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - call:  
      uri: <value>  
      args: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/call?uri=<value>&args=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command call uri=<value> args=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

capture

---

DEPREACTED (Use the cache.* commands instead). Captures the last pipe message and adds it into a list in the header under key {@link #HEADER_CAPTURED}. This is primarily for testing purposes but also can be used to create a snapshot of a certain pipeline state.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - capture:  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/capture?id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command capture id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

pipe.schema

---

Returns the JSON schema for all built-in pipes.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
pipe	String	false	null	The specific pipe name to fetch schema from. If set, only the schema for this specific pipe is returned.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - pipe.schema:  
      pipe: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/pipe.schema?pipe=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pipe.schema pipe=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

pipe.schema.v7

---

Returns the V7 compliant JSON schema for all built-in pipes.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - pipe.schema.v7:  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/pipe.schema.v7?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command pipe.schema.v7 id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

config.get

---

Returns all admin config settings for a given group from the backend as a JSON in this format: {configKey:{value:someValue, canOverwrite:true|false}}. The attribute canOverwrite is only available if param includePermission is set.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
group	String	false	null	The config group to select. If null or empty, all configs will be returned if user has permission to do so.
key	String	false	null	The config key inside a given group. If null or empty, all configs from the selected group will be returned.
includePermission	String	false	false	If true, additionally shows whether a currently logged-in user can write/change a configuration or not by adding the attribute canOverwrite:true
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - config.get:  
      group: <value>  
      key: <value>  
      includePermission: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/config.get?group=<value>&key=<value>&includePermission=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command config.get group=<value> key=<value> includePermission=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

container.registry.delete

---

Deletes a container registry.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
url	String	false	null	The url of the registry.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
credentials	String	false	null	Refers to the name of a stored credentials secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
  - container.registry.delete:  
      url: <value>  
      id: <value>  
      if: <value>  
      credentials: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/container.registry.delete?url=<value>&id=<value>&if=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command container.registry.delete url=<value> id=<value> if=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

container.registry.list

---

Lists all container registries.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
credentials	String	false	null	Refers to the name of a stored credentials secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
  - container.registry.list:  
      id: <value>  
      if: <value>  
      credentials: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/container.registry.list?id=<value>&if=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command container.registry.list id=<value> if=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

container.registry.put

---

Adds a new container registry.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
url	String	false	null	The url of the registry.
username	String	false	null	The username to access the registry.
password	String	false	null	The password to access the registry.
email	String	false	null	The email for the registry.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
credentials	String	false	null	Refers to the name of a stored credentials secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
  - container.registry.put:  
      url: <value>  
      username: <value>  
      password: <value>  
      email: <value>  
      id: <value>  
      if: <value>  
      credentials: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/container.registry.put?url=<value>&username=<value>&password=<value>&email=<value>&id=<value>&if=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command container.registry.put url=<value> username=<value> password=<value> email=<value> id=<value> if=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

content.get

---

Reads content from provided uri and puts the result back to body.

Try online.

Input body type: Raw
Output body type: Raw
Parameters:

Name	Type	Required	Default	Description
uri	String	true	null	The content uri of the content to load.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - content.get:  
      uri: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/content.get?uri=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command content.get uri=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

data.enrich

---

Enriches a given data object by applying a given PEL expression on it.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
do	String	true	null	A PEL which will be executed in order to enrich a selected field of the data object from input. These variables will be provided in the PEL: headers (= the pipeline headers), vars (= the pipeline variables), body (= the pipeline body), input (= the input data)
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - data.enrich:  
      do: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.enrich?do=<value>&id=<value>&if=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.enrich do=<value> id=<value> if=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

data.list.filter

---

Iterates over a list of items given by input and removes all items matching the given criteria.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
exclude	String	true	null	A PEL which will be executed on each iteration item. If the expression results in a true value, the item will be removed from the list. Additionally to the default PEL variables, the variable item (= current iteration item, default name) will be provided.
iterItemName	String	false	item	The name of the iteration item value, provided for exclude
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - data.list.filter:  
      exclude: <value>  
      iterItemName: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.list.filter?exclude=<value>&iterItemName=<value>&id=<value>&if=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.list.filter exclude=<value> iterItemName=<value> id=<value> if=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

data.list.iterate

---

Iterates over a data list (like JSON array for example) and applies the given do-action on each entry matching given where-condition. If two lists a are given, iterates over both lists whereas listA will be the outer loop and listB will be the inner loop.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
listA	String	false	null	The main list where data must be merged into. If null or empty, the value from input parameter will be used instead. If both are given, the value from listA has precedence.
listB	String	false	null	The seconds list where data mast be read from. For each item in listA, this list will be fully iterated.
where	String	false	null	Selects the iteration step in listA which must be elected for the do operation. If null or empty, any iteration step will be selected. Additionally to the default PEL variables, the variables itemA (= current iteration item of listA, default name) and itemB (= current iteration item of listB) will be provided.
do	String	true	null	A PEL which will be executed on each where-selected iteration item. It is also possible to apply multiple expressions in each iteration. Multiple such expressions must be separated by a semicolon ;Additionally to the default PEL variables, the variables itemA (= current iteration item of listA, default name) and itemB (= current iteration item of listB, default name) will be provided. In case therethere is only one list provided from body or input param, only one iteration item will be provided with name 'item' as default name.
iterItemName	String	false	item	The name of the iteration item value in case only single list has been provided via input or body.
iterItemNameA	String	false	itemA	The name of the iteration item value of listA provided in the PEL parts
iterItemNameB	String	false	itemB	The name of the iteration item value of listB provided in the PEL parts
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - data.list.iterate:  
      listA: <value>  
      listB: <value>  
      where: <value>  
      do: <value>  
      iterItemName: <value>  
      iterItemNameA: <value>  
      iterItemNameB: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.list.iterate?listA=<value>&listB=<value>&where=<value>&do=<value>&iterItemName=<value>&iterItemNameA=<value>&iterItemNameB=<value>&id=<value>&if=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.list.iterate listA=<value> listB=<value> where=<value> do=<value> iterItemName=<value> iterItemNameA=<value> iterItemNameB=<value> id=<value> if=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

data.list.limit

---

Limits a given list of data to a specific size. Removes any item from the list those index is above given maxLength - 1.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
maxLength	String	false	null	Limits the data list from the input to the given max. length.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - data.list.limit:  
      maxLength: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.list.limit?maxLength=<value>&id=<value>&if=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.list.limit maxLength=<value> id=<value> if=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

data.mapping

---

Converts from one data structure into a another by applying simple mapping rules. Auto-creates nested elements if required.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
rules	String	false	null	A list of mapping PEL rules to map from the input to the output data set. A rule has the format inputPEL1 -> outputPEL1. Multiple rules are separated by a comma directly followed by a new line.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - data.mapping:  
      rules: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.mapping?rules=<value>&id=<value>&if=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.mapping rules=<value> id=<value> if=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

data.transform

---

This data transformer converts the input to an output format by applying the given template. By default the current message is provided as model inside the template context so you can access body, vars or headers similar to the default PEL approach.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
iterate	String	false	false	If true, the input is expected to be a list which will be iterated. The template is then applied on each iteration row and the result is added to a target list.
groupBy	String	false	null	An expression to apply on the target list in order to group the result of a row into. If the expression returns false, the row result is added to the end of the list.If null or empty, each row result creates a new entry in the target list.
engine	String	false	pel	The template engine to be used. Currently 'freemarker' and 'pel' is supported.
modelName	String	false	null	The name of the root model under which the input can be accessed inside the template. If null or empty, then the input defines the model names.
template	String	true	null	The template to be used for the transformation. It can the template text itself as string or a qualified uri pointing to a template resource like this for example: $uri:property:/my/template/path
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - data.transform:  
      iterate: <value>  
      groupBy: <value>  
      engine: <value>  
      modelName: <value>  
      template: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/data.transform?iterate=<value>&groupBy=<value>&engine=<value>&modelName=<value>&template=<value>&id=<value>&if=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command data.transform iterate=<value> groupBy=<value> engine=<value> modelName=<value> template=<value> id=<value> if=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

datetime

---

Returns the current time at server side.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
format	String	false	null	The date time format pattern. If null, the system default format is used.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - datetime:  
      format: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/datetime?format=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command datetime format=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

datetime.zones

---

Returns all official IANA time-zone names supported by this PIPEFORCE instance: http://www.iana.org/time-zones

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - datetime.zones:  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/datetime.zones?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command datetime.zones id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

decrypt

---

Decrypts the data in the body using the defined encryption parameter. Puts the encrypted data back to the body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
password	String	true	null	The password to decrypt the body with.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - decrypt:  
      password: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/decrypt?password=<value>&id=<value>&if=<value>&input=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command decrypt password=<value> id=<value> if=<value> input=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.attachment.add

---

Adds a single attachment to an existing PIPEFORCE Secure Delivery. Note: Attachments can be added to deliveries only in state DRAFT.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
deliveryUuid	String	true	null	The uuid of an existing delivery to be updated.
name	String	true	null	The name of the attachment.
mimeType	String	false	null	The mime type of the attachment.
length	String	false	0	The length of the attachment in bytes.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - delivery.attachment.add:  
      deliveryUuid: <value>  
      name: <value>  
      mimeType: <value>  
      length: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.attachment.add?deliveryUuid=<value>&name=<value>&mimeType=<value>&length=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.attachment.add deliveryUuid=<value> name=<value> mimeType=<value> length=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.create

---

Creates a new PIPEFORCE Secure Delivery and sets it in the target

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
subject	String	false	null	The subject of the delivery. If null or empty, the default subject will be used.
message	String	false	null	The message of the delivery. If null or empty, the default message will be used.
privacyLevel	Integer	false	1	The privacy level to send the delivery. Must be one of 1, 2, 3 or 4.
recipients	String	false	null	A comma separated list of email recipients. Also PEL is supported here.
deleteAfter	String	false	0	Delete the delivery attachments after this date and time given as unix timestamp in millis. If null, empty, 0 or negative, delivery will never be deleted.
attachments	String	false	null	The list of attachment file names or a list of JSON objects to be added to this delivery.
notifySender	String	false	true	If true, notifies sender when recipients have downloaded delivery.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - delivery.create:  
      subject: <value>  
      message: <value>  
      privacyLevel: <value>  
      recipients: <value>  
      deleteAfter: <value>  
      attachments: <value>  
      notifySender: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.create?subject=<value>&message=<value>&privacyLevel=<value>&recipients=<value>&deleteAfter=<value>&attachments=<value>&notifySender=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.create subject=<value> message=<value> privacyLevel=<value> recipients=<value> deleteAfter=<value> attachments=<value> notifySender=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.delete

---

Deletes a given delivery.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
deliveryUuid	String	true	null	The uuid of the delivery to delete.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - delivery.delete:  
      deliveryUuid: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.delete?deliveryUuid=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command delivery.delete deliveryUuid=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.finalize

---

Finalizes an existing delivery. After finalized, only recipients can be added but message and attachments of delivery can not be changed any longer.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
deliveryUuid	String	true	null	The uuid of the delivery to finalize.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - delivery.finalize:  
      deliveryUuid: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.finalize?deliveryUuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.finalize deliveryUuid=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.get

---

Returns an existing delivery.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
deliveryUuid	String	true	null	The uuid of the delivery.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - delivery.get:  
      deliveryUuid: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.get?deliveryUuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.get deliveryUuid=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.recipient.add

---

Adds recipients to an existing PIPEFORCE Secure Delivery. Note: Recipients can be added to deliveries only in state DRAFT or FINALIZED.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
deliveryUuid	String	false	null	The uuid of an existing delivery to be updated.
email	String	false	null	The email address of the recipient to be added.
locale	String	false	null	The locale to be used for this recipient like de, en or fr for example.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - delivery.recipient.add:  
      deliveryUuid: <value>  
      email: <value>  
      locale: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.recipient.add?deliveryUuid=<value>&email=<value>&locale=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.recipient.add deliveryUuid=<value> email=<value> locale=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.send

---

Sends a given PIPEFORCE Secure Delivery. If delivery is in status DRAFT it will be converted to FINALIZED before send.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
deliveryUuid	String	true	null	The uuid of the delivery to send.
recipients	String	false	null	The comma separated or PEL list of recipients to (re-)send the delivery to. The recipients must already exist in the delivery. If null or empty, the delivery message is send to all existing recipients of the delivery.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - delivery.send:  
      deliveryUuid: <value>  
      recipients: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.send?deliveryUuid=<value>&recipients=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.send deliveryUuid=<value> recipients=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

delivery.update

---

Updates an existing PIPEFORCE Secure Delivery.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
deliveryUuid	String	false	null	The uuid of an existing delivery to be updated with values from the params. Any existing value will be overwritten by parameter set on this command. If null or empty, a new delivery will be created and initialized with values from params. Note: Deliveries can only be fully updated in DRAFT state. In FINALIZED state, only recipients can be updated.
subject	String	false	null	The subject of the delivery. If null or empty, this attribute wont be updated.. Overwrites any existing value.
message	String	false	null	The message of the delivery. If null or empty, this attribute wont be updated. Overwrites any existing value.
privacyLevel	Integer	false	1	The privacy level to send the delivery. Must be one of 1, 2, 3 or 4. Overwrites any existing value. If null or empty, this attribute wont be updated.
recipients	String	false	null	A comma separated list of email recipients. Overwrites any existing recipients. If null or empty, this attribute wont be updated.
deleteAfter	String	false	0	Delete the delivery attachments after this date and time given as unix timestamp in millis. If 0 or negative, delivery will never be deleted. If null or empty, this attribute wont be updated. If set overwrites any existing value.
attachments	String	false	null	The attachments to be set to this delivery. Overwrites any existing attachments. If null or empty, this attribute wont be updated.
notifySender	String	false	true	If true, notifies sender when recipients have downloaded delivery. If null or empty, this attribute wont be updated.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - delivery.update:  
      deliveryUuid: <value>  
      subject: <value>  
      message: <value>  
      privacyLevel: <value>  
      recipients: <value>  
      deleteAfter: <value>  
      attachments: <value>  
      notifySender: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/delivery.update?deliveryUuid=<value>&subject=<value>&message=<value>&privacyLevel=<value>&recipients=<value>&deleteAfter=<value>&attachments=<value>&notifySender=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command delivery.update deliveryUuid=<value> subject=<value> message=<value> privacyLevel=<value> recipients=<value> deleteAfter=<value> attachments=<value> notifySender=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

doc.api.pelutils

---

Returns the api doc for the available PEL utils.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - doc.api.pelutils:  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/doc.api.pelutils?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command doc.api.pelutils id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

docusign

---

Requests a signature of the given document in the body via email (remote signing) using DocuSign. See here: https://developers.docusign.com/esign-rest-api/code-examples/code-example-request-a-signature-via-email Expects the to be signed document in the body with json.file encoding.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
signerEmail	String	true	null	The email address of the signer.
signerName	String	false	null	The real name of the signer.
ccEmail	String	false	null	The email of cc user to get informed about the signing request. If null, no cc mail is sent.
ccName	String	false	null	The name of cc email user to get informed about the signing request.
subject	String	false	null	The email subject to be send to the signer. If null or empty, the default subject will be set.
accessToken	String	false	null	The DocuSign access token. If null or empty, the token will be read from settings.
accountId	String	false	null	The docuSign account Id for REST calls. Can be obtained here: https://developers.docusign.com/esign-rest-api/guides/authentication/user-info-endpoints . If not set, the command tries to get the account ID by an additional request from DocuSign
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - docusign:  
      signerEmail: <value>  
      signerName: <value>  
      ccEmail: <value>  
      ccName: <value>  
      subject: <value>  
      accessToken: <value>  
      accountId: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/docusign?signerEmail=<value>&signerName=<value>&ccEmail=<value>&ccName=<value>&subject=<value>&accessToken=<value>&accountId=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command docusign signerEmail=<value> signerName=<value> ccEmail=<value> ccName=<value> subject=<value> accessToken=<value> accountId=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

document.understand

---

Returns metadata for a given unstructured document like an invoice PDF for example. Expects the document to be in the body by default. Returns the result as JSON in the body (replacing any existing value in the body).

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
apiKey	String	false	null	The alternative API key to connect to the service. If null or empty, the default one will be used, as defined by the default backend settings.
restUrl	String	false	null	The URL to be called by the command. If null or empty, the default url will be used as defined in the backend.
filter	String	false	null	A PEL as filter to be applied to the output data before it is returned by this command. If null or empty, no filter is applied.

Pipeline example:

pipeline:  
  - document.understand:  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  
      apiKey: <value>  
      restUrl: <value>  
      filter: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/document.understand?id=<value>&if=<value>&input=<value>&output=<value>&apiKey=<value>&restUrl=<value>&filter=<value>  

Command Line Interface (CLI) example:

pi command document.understand id=<value> if=<value> input=<value> output=<value> apiKey=<value> restUrl=<value> filter=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.archive.save

---

Saves the content of the body to the given archive folder in Drive. The content of the body must be a single file. Verifies the integrity of the archive on write. Returns the final archive file name / path (without archive root path) into the output target.

Try online.

Input body type: Raw
Output body type: Raw
Parameters:

Name	Type	Required	Default	Description
path	String	true	null	The root path of the archive folder where the file to be saved to.
namingPattern	String	false	null	The PEL pattern to be applied to generate the final archive file name / path. This name / path will be relative to the given archive root path. Additionally, provides these variables in this PEL pattern context: archiveCounter = The last value used as counter as it comes from the .counter file. When not present, is initialized by counting all files in archive folder. counter = The archiveCounter increased by 1.archivePath = The path to the archive root as given by path param. basename = The base filename of the archive file, without extension (for example myfile.pdf = myfile). basenameNoId = Same as basename but without the _ID-123 part in the file name if there is any.ext = The extension of the archive file, without a period (for example myfile.pdf = pdf) filename = The full name of the archive file, with extension (for example myfile.pdf = myfile.pdf). The default pattern is this: basename_counter.ext
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - drive.archive.save:  
      path: <value>  
      namingPattern: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.archive.save?path=<value>&namingPattern=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command drive.archive.save path=<value> namingPattern=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.copy

---

Copies a folder or file on Drive.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
path	String	true	null	The path of the folder or file to be copied.
to	String	true	null	The target folder to copy the resource into.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - drive.copy:  
      path: <value>  
      to: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.copy?path=<value>&to=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command drive.copy path=<value> to=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.delete

---

Deletes a file or folder on Drive. If resource doesnt exist, nothing happens.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
path	String	true	null	The path of the resource to be deleted. If it is a folder, it will be deleted recursively.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - drive.delete:  
      path: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.delete?path=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command drive.delete path=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.exists

---

Checks whether a resource in Drive exists. Puts the string true or false in the message body depending whether the resource exists.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
path	String	true	null	The path of the resource to check for existence.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - drive.exists:  
      path: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.exists?path=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command drive.exists path=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.list

---

Lists all resources from drive folder.

Try online.

Input body type: JsonNode
Output body type: Raw
Parameters:

Name	Type	Required	Default	Description
path	String	true	null	The path of the folder to be listed.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - drive.list:  
      path: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.list?path=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command drive.list path=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.mkdir

---

Creates a new dir on Drive if it not already exists.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
path	String	true	null	The path of the folder the new dir should be created within.
recurse	String	false	false	If set to true, any non existing folder in the path will be created.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - drive.mkdir:  
      path: <value>  
      recurse: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.mkdir?path=<value>&recurse=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command drive.mkdir path=<value> recurse=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.move

---

Moves a folder or file on Drive from one location into another.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
path	String	true	null	The path of the folder or file to be moved.
to	String	true	null	The target folder to move the resource into.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - drive.move:  
      path: <value>  
      to: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.move?path=<value>&to=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command drive.move path=<value> to=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.read

---

Reads a file from drive and puts its content as a pipeline resource into the body.

Try online.

Input body type: JsonNode
Output body type: Raw
Parameters:

Name	Type	Required	Default	Description
path	String	true	null	The path of the file to be read from Drive.
append	Boolean	false	false	If true, appends the files read from drive to any existing collection in the body. In case the body is no collection but a content (single file), creates a new collection and adds all to this collection (already existing file and read files). In case the body is different from collection or content, an error is thrown. If false (default), overwrites any existing body value.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - drive.read:  
      path: <value>  
      append: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.read?path=<value>&append=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command drive.read path=<value> append=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.save

---

Saves the content of the body to one or more files in Drive. The content of the body can be a single pipeline resource or a pipeline resource collection.

Try online.

Input body type: Raw
Output body type: Raw
Parameters:

Name	Type	Required	Default	Description
path	String	true	null	The path of the file to be saved. If multiple files are in the body, this is the path of the base folder where to store these files. Otherwise it is expected to be the full path to a single file.
namingStrategy	String	false	null	If defined, applies the given naming strategy to the name of the resource. If null or empty, no name strategy is applied.
cleanupBody	String	false	true	If true, deletes the content from the body after the content was saved to drive (default). Note: In case the body content is a stream, this stream will be empty even if this was set to false since streams can be processed only once and was processed by writing its data to drive here.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - drive.save:  
      path: <value>  
      namingStrategy: <value>  
      cleanupBody: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.save?path=<value>&namingStrategy=<value>&cleanupBody=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command drive.save path=<value> namingStrategy=<value> cleanupBody=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.share

---

Shares a folder in Drive given by path to users given by recipients.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
to	String	true	null	Comma separated list of users, group names or email addresses. Never null. If this is an expression and points to comma separated list, an array or a collection, will create share to any of the entries. If this value is missing, a public share is created instead
type	String	false	user	Can be either shared to 'user' or to 'group'. Defaults to 'user'
path	String	true	null	The path to the folder to be shared.
permission	Integer	false	1	The permission for the share: 1 (read), 2 (update), 4 (create), 8 (delete), 16 (share), 31 (all). Note: Permissions can be combined by additions: For example read (1) + update (2) would be 3. For public shares defaults to 1 (read).
subject	String	false	null	Optional subject of the share email to be send to the recipient. If type=user and at least one of subject or message parameter is set, an email will be send to the recipient after it was shared to him.
message	String	false	null	Optional message of the share email to be send to the recipient. If type=user and at least one of subject or message parameter is set, an email will be send to the recipient after it was shared to him.
model	String	false	null	Optional model for the share email to be send to the recipient.
expires	Long	false	null	NOT SUPPORTED YET. A timestamp in millis since 1970 when this share will expire. If -1 share will never expire.
password	String	false	null	NOT SUPPORTED YET. A password to protect the share.
invite	Boolean	false	null	NOT SUPPORTED YET. Send an invite email to recipients.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - drive.share:  
      to: <value>  
      type: <value>  
      path: <value>  
      permission: <value>  
      subject: <value>  
      message: <value>  
      model: <value>  
      expires: <value>  
      password: <value>  
      invite: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.share?to=<value>&type=<value>&path=<value>&permission=<value>&subject=<value>&message=<value>&model=<value>&expires=<value>&password=<value>&invite=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command drive.share to=<value> type=<value> path=<value> permission=<value> subject=<value> message=<value> model=<value> expires=<value> password=<value> invite=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.tag

---

Adds or removes a WebDAV tag to a resource on drive.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
path	String	true	null	The path of the resource to tag.
tagname	String	true	null	The name of the tag to add.
tagvalue	String	false	null	The value of the tag to add.
remove	Boolean	false	null	If true (or any non empty/null value), removes the given tag.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - drive.tag:  
      path: <value>  
      tagname: <value>  
      tagvalue: <value>  
      remove: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.tag?path=<value>&tagname=<value>&tagvalue=<value>&remove=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command drive.tag path=<value> tagname=<value> tagvalue=<value> remove=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

drive.upload.chunked

---

Supports chunked uploads of large files into the Drive endpoint. Expects an object in the body which can be converted to an input stream as the chunk data to be uploaded.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
action	String	true	null	Defines the action of the chunked upload. One of: create, upload, finalize, cancel
uuid	String	false	null	The uuid to refer to the upload session as returned by the create action. Required for upload, finalize and cancel actions.
path	String	false	null	The target path where to copy the final file on finalize action. Mandatory for the finalize action.
index	Integer	false	null	The index of the chunk. Mandatory for the upload action.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - drive.upload.chunked:  
      action: <value>  
      uuid: <value>  
      path: <value>  
      index: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/drive.upload.chunked?action=<value>&uuid=<value>&path=<value>&index=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command drive.upload.chunked action=<value> uuid=<value> path=<value> index=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

encrypt

---

Encrypts the data in the body using the defined encryption parameter and puts the encrypted datain the output.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
password	String	true	null	The password to encrypt the body with.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - encrypt:  
      password: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/encrypt?password=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command encrypt password=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

eval

---

Executes a given pipeline expression with the message as context.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
expr	String	true	null	The pipeline expression to be executed.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - eval:  
      expr: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/eval?expr=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command eval expr=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

event.listen

---

Listening for events works like this: Add this command at the very first in your pipeline, define the event key you want to listen for and an optional filter expression. Then save this pipeline into the property store. This causes the system to automatically register this pipeline and execute it whenever an event with given key and matching filter is fired. Note: Only one event.listen command per pipeline is allowed and it needs to be the very first command in the pipeline. In the body of the pipeline the event object is provided and can be used for filtering for example.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
key	String	true	null	The key to listen for.
filter	String	false	null	An optional PEL to execute the pipeline only in case the filter applies.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - event.listen:  
      key: <value>  
      filter: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/event.listen?key=<value>&filter=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command event.listen key=<value> filter=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

event.mapping.get

---

Returns all event key to pipeline key mappings.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - event.mapping.get:  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/event.mapping.get?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command event.mapping.get id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

event.send

---

Sends a new event to inform listeners in pipelines and microservices.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
key	String	true	null	The key under which to send this event.
traceId	String	false	null	The optional tracedId to be used to send this event. If not defined, a random traceId is created automatically.
payload	String	false	null	The payload to send with this event. May be null.
async	String	false	true	Send the event in ASYNC mode? Note: ASYNC is faster but lacks transaction capability. If false, message is send in SYNC. Slower but can use the current authentication and transaction context.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - event.send:  
      key: <value>  
      traceId: <value>  
      payload: <value>  
      async: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/event.send?key=<value>&traceId=<value>&payload=<value>&async=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command event.send key=<value> traceId=<value> payload=<value> async=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

exit

---

Exits the current pipeline flow and returns the current body state to the caller.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
if	String	false	#{true}	The PE to be evaluated. If true, the pipeline will exit.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - exit:  
      if: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/exit?if=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command exit if=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

finally

---

Any command placed after this finally command will be executed even if the pipeline execution was quit using the exit command or by an exception.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
do	String	false	null	An optional PE to execute finally.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - finally:  
      do: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/finally?do=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command finally do=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

foreach

---

Repeats the subsequent pipeline commands for each entry in a given list. By default the full pipeline until the end will be repeated. To repeat only a subset, place the command foreach?end where the foreach iteration should end. The current iteration item is placed in vars.loop.item.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
in	String	false	null	Default parameter which points to a list of items to be iterated over. Each iteration item is placed by default under vars.loop.item an can be accessed as such inside the iteration loop.
item	String	false	null	Contains an optional expression which will be evaluated for each iteration. The current iteration item at vars.loop.item will be overwritten by the result of this expression.
loopName	String	false	loop	The name of the current loop object in the vars scope. By default this is 'loop' which results in 'vars.loop.item' then for accessing the current loop item. With this attribute you can change this for example to 'iteration' so you can access the loop iterm under 'vars.iteration.item'. The loop object contains attributes for the current loop like item = the current iteration item, index = the current iteration index.
end	String	false	null	Signals the end of a for each loop.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - foreach:  
      in: <value>  
      item: <value>  
      loopName: <value>  
      end: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/foreach?in=<value>&item=<value>&loopName=<value>&end=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command foreach in=<value> item=<value> loopName=<value> end=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

header.set

---

DEPRECATED. Use the set command instead. Sets any parameter value as header. For example header.set?key1=value1&key2=value2 would become the headers: key1: value1 and key2: value2

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - header.set:  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/header.set?id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command header.set id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.form.find

---

Searches for a form on the page and sets is as vars.form model in PEL. If param 'select' is given, uses this PEL to find the form object. Otherwise tries to detect the form automatically by searching the page and using the first form found. Note: The pipe is BETA and not intended to be used in production!

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
select	String	false	null	A PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - htmlunit.website.form.find:  
      select: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.form.find?select=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.form.find select=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.form.input

---

Searches for an input element with given name and sets the given value on it. Note: The pipe is BETA and not intended to be used in production!

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
value	String	false	null	The value to be set on the selected input field.
select	String	false	null	A PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - htmlunit.website.form.input:  
      value: <value>  
      select: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.form.input?value=<value>&select=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.form.input value=<value> select=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.form.submit

---

Searches for a submit button and clicks it. Note: The pipe is BETA and not intended to be used in production!

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
select	String	false	null	A PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - htmlunit.website.form.submit:  
      select: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.form.submit?select=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.form.submit select=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.link.click

---

Searches for a link on current page and clicks it. Note: The pipe is BETA and not intended to be used in production!

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
select	String	false	null	A PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - htmlunit.website.link.click:  
      select: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.link.click?select=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.link.click select=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.open

---

Opens a website and sets it as 'vars.page' in PEL. Additionally sets the current browser instance as 'var.browser'. Note: The pipe is BETA and not intended to be used in production!

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
url	String	true	null	The url of the web page to open.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - htmlunit.website.open:  
      url: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.open?url=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.open url=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

htmlunit.website.scrap

---

Scraps data from the current website and returns the result in the body.Note: The pipe is BETA and not intended to be used in production!

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
xpath	String	true	null	Executes the given xpath expression on the current page and puts the result in the body. In case the xpath returns more than one results, adds an array to the body. Otherwise the body only contains the single result value.
select	String	false	null	A PE to select elements on a website for subsequent RPA commands. If null, form is tried to select automatically.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - htmlunit.website.scrap:  
      xpath: <value>  
      select: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/htmlunit.website.scrap?xpath=<value>&select=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command htmlunit.website.scrap xpath=<value> select=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

http.delete

---

Executes a DELETE HTTP call to the given url.Returns the result from the server in the message body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
url	String	false	null	The url for the HTTP call.
service	String	false	null	The name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
headers	String	false	null	A list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
body	String	false	null	The value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
credentials	String	false	null	Refers to the name of a stored credentials secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
  - http.delete:  
      url: <value>  
      service: <value>  
      headers: <value>  
      body: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  
      credentials: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/http.delete?url=<value>&service=<value>&headers=<value>&body=<value>&id=<value>&if=<value>&input=<value>&output=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command http.delete url=<value> service=<value> headers=<value> body=<value> id=<value> if=<value> input=<value> output=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

http.get

---

Executes a GET HTTP call to the given url.Returns the result from the server in the message body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
url	String	false	null	The url for the HTTP call.
service	String	false	null	The name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
headers	String	false	null	A list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
body	String	false	null	The value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
credentials	String	false	null	Refers to the name of a stored credentials secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
  - http.get:  
      url: <value>  
      service: <value>  
      headers: <value>  
      body: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  
      credentials: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/http.get?url=<value>&service=<value>&headers=<value>&body=<value>&id=<value>&if=<value>&input=<value>&output=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command http.get url=<value> service=<value> headers=<value> body=<value> id=<value> if=<value> input=<value> output=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

http.patch

---

Executes a PATCH HTTP call to the given url.Returns the result from the server in the message body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
url	String	false	null	The url for the HTTP call.
service	String	false	null	The name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
headers	String	false	null	A list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
body	String	false	null	The value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
credentials	String	false	null	Refers to the name of a stored credentials secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
  - http.patch:  
      url: <value>  
      service: <value>  
      headers: <value>  
      body: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  
      credentials: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/http.patch?url=<value>&service=<value>&headers=<value>&body=<value>&id=<value>&if=<value>&input=<value>&output=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command http.patch url=<value> service=<value> headers=<value> body=<value> id=<value> if=<value> input=<value> output=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

http.post

---

Executes a POST HTTP call to the given url.Returns the result from the server in the message body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
url	String	false	null	The url for the HTTP call.
service	String	false	null	The name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
headers	String	false	null	A list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
body	String	false	null	The value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
credentials	String	false	null	Refers to the name of a stored credentials secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
  - http.post:  
      url: <value>  
      service: <value>  
      headers: <value>  
      body: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  
      credentials: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/http.post?url=<value>&service=<value>&headers=<value>&body=<value>&id=<value>&if=<value>&input=<value>&output=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command http.post url=<value> service=<value> headers=<value> body=<value> id=<value> if=<value> input=<value> output=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

http.put

---

Executes a PUT HTTP call to the given url.Returns the result from the server in the message body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
url	String	false	null	The url for the HTTP call.
service	String	false	null	The name of the internal service to be called. If this parameter is given, it will prefix the url parameter, if exists. This parameter can also contain the internal port information separated by a colon like serviceName:port. If no port is given, it will be looked-up automatically.
headers	String	false	null	A list of headers to append to the request. Can be a PEL pointing to a map or a list of name-value pair strings name:value or a comma separated string like: name1:value1, name2:value2.
body	String	false	null	The value to be set in the body of the request (if it supports a body). If this param is missing, the value from the input parameter is used. If this value is null, no body is used.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
input	String	false	null	Defines where to read the input from as PEL. If this param is missing, the input will be read from the body.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.
credentials	String	false	null	Refers to the name of a stored credentials secret entry to be used by this command. If not null, all other credentials parameters are ignored if there exists any.

Pipeline example:

pipeline:  
  - http.put:  
      url: <value>  
      service: <value>  
      headers: <value>  
      body: <value>  
      id: <value>  
      if: <value>  
      input: <value>  
      output: <value>  
      credentials: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/http.put?url=<value>&service=<value>&headers=<value>&body=<value>&id=<value>&if=<value>&input=<value>&output=<value>&credentials=<value>  

Command Line Interface (CLI) example:

pi command http.put url=<value> service=<value> headers=<value> body=<value> id=<value> if=<value> input=<value> output=<value> credentials=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.apitoken

---

Obtains the apitoken (= offline token) in exchange for user credentials provided and writes it into the output.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
username	String	true	null	The user name.
password	String	true	null	The user password.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.apitoken:  
      username: <value>  
      password: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.apitoken?username=<value>&password=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.apitoken username=<value> password=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.authinfo

---

Adds header 'authUserId' - name of an user authenticated as a sender of the pipe message.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - iam.authinfo:  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.authinfo?id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command iam.authinfo id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.authorize

---

Authorizes pipeline execution and overwrites any existing authentication by this new, successful authentication. Additionally puts the successful authentication token on an internal stack. See iam.logout to pop from stack.Subsequent commands will be executed only if authorization was successful. Tries each existing parameter for authentication in this order. If multiple params are given, first existing one is used from this list: accessToken, refreshToken, basic, username+password. Throws exception and exits pipeline execution on first not matching login try.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
accessToken	String	false	null	The accessToken (bearer token) to be used for authentication.
refreshToken	String	false	null	The refreshToken to be used for authentication.
basic	String	false	null	The basic authentication string to be used for authentication.
username	String	false	null	The username to be used for authentication.
password	String	false	null	The password to be used for authentication.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - iam.authorize:  
      accessToken: <value>  
      refreshToken: <value>  
      basic: <value>  
      username: <value>  
      password: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.authorize?accessToken=<value>&refreshToken=<value>&basic=<value>&username=<value>&password=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command iam.authorize accessToken=<value> refreshToken=<value> basic=<value> username=<value> password=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.bruteforce.release

---

Releases any bruteforce lock for the given user. If user is not locked, nothing happens.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
username	String	false	null	The name of the user to unlock. If not set, param uuid must be set.
uuid	String	false	null	The uuid of the user to unlock. If set, the param username is ignored.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.bruteforce.release:  
      username: <value>  
      uuid: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.bruteforce.release?username=<value>&uuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.bruteforce.release username=<value> uuid=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.bruteforce.status

---

Returns the bruteforce status for a single user

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
username	String	false	null	The name of the user to return the status for. If not set, param uuid must be set.
uuid	String	false	null	The uuid of the user to return the status for. If set, the param username is ignored.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.bruteforce.status:  
      username: <value>  
      uuid: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.bruteforce.status?username=<value>&uuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.bruteforce.status username=<value> uuid=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.cache.clear

---

Clears the security objects (and reloads roles where required). Note: Since this can be a heavy task and slow down the system, use it only in case really required!

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - iam.cache.clear:  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.cache.clear?id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command iam.cache.clear id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.add.roles

---

Adds roles to a given group. Roles must exist beforehand.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
groupUuid	String	true	null	The unique group uuid.
roleNames	String	true	null	The role names to join. Can be a comma separated list or a PEL pointing to a list.
groupName	String	true	null	The unique group name.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.group.add.roles:  
      groupUuid: <value>  
      roleNames: <value>  
      groupName: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.group.add.roles?groupUuid=<value>&roleNames=<value>&groupName=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.add.roles groupUuid=<value> roleNames=<value> groupName=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.create

---

Creates a new group and puts its uuid in the body under key groupUuid. Throws exception if group already exists.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
name	String	true	null	The unique group name.
roleNames	String	false	null	A list of roles to be assigned to this group on creation.
attributes	Map	false	null	A map which holds optional attributes to be added to this group.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.group.create:  
      name: <value>  
      roleNames: <value>  
      attributes: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.group.create?name=<value>&roleNames=<value>&attributes=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.create name=<value> roleNames=<value> attributes=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.delete

---

Deletes the group with given uuid.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
uuid	String	true	null	The uuid of the group to delete.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.group.delete:  
      uuid: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.group.delete?uuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.delete uuid=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.list

---

Lists all groups. By default, the response is a JSON array with these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_grouprepresentation

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
filter	String	false	null	If set, applies the given filter to the search for groups.
sortByName	String	false	null	If set, groups are returned as collection with the group name as key.
max	Integer	false	1000	The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
offset	Integer	false	0	The offset to start return entries.
filter	String	false	null	The filter query to additionally filter the result. Not applied if null
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.group.list:  
      filter: <value>  
      sortByName: <value>  
      max: <value>  
      offset: <value>  
      filter: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.group.list?filter=<value>&sortByName=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.list filter=<value> sortByName=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.list.names

---

Lists all group names. The response is a JSON array with these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_grouprepresentation

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
max	Integer	false	1000	The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
offset	Integer	false	0	The offset to start return entries.
filter	String	false	null	The filter query to additionally filter the result. Not applied if null
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.group.list.names:  
      max: <value>  
      offset: <value>  
      filter: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.group.list.names?max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.list.names max=<value> offset=<value> filter=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.members

---

Lists all users which are member of the given group. The response is a JSON array with these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_userrepresentation

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
name	String	false	null	The name of the group. If not set, param uuid must be set.
uuid	String	false	null	The uuid of the group. If set, the param name is ignored.
max	Integer	false	1000	The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
offset	Integer	false	0	The offset to start return entries.
filter	String	false	null	The filter query to additionally filter the result. Not applied if null
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.group.members:  
      name: <value>  
      uuid: <value>  
      max: <value>  
      offset: <value>  
      filter: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.group.members?name=<value>&uuid=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.members name=<value> uuid=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.group.roles

---

Lists all effective role names, the given group is assigned to.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
groupName	String	false	null	The name of the group. If not set, param uuid must be set.
uuid	String	false	null	The uuid of the group. If set, the param username is ignored.
max	Integer	false	1000	The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
offset	Integer	false	0	The offset to start return entries.
filter	String	false	null	The filter query to additionally filter the result. Not applied if null
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.group.roles:  
      groupName: <value>  
      uuid: <value>  
      max: <value>  
      offset: <value>  
      filter: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.group.roles?groupName=<value>&uuid=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.group.roles groupName=<value> uuid=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.realm.create

---

Creates a new realm. Sets the uuid in the body under key realmUuid. Throws exception if realm already exists. Expects a JSON in the body of this structure: https://www.keycloak.org/docs-api/11.0/rest-api/index.html#_realmrepresentation

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.realm.create:  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.realm.create?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.realm.create id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.role.add.composites

---

Adds existing composite roles to an existing role.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
roleName	String	true	null	The unique role name to be loaded.
composites	String	true	null	The composite role names to join. Can be a comma separated list or a PEL pointing to a list.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.role.add.composites:  
      roleName: <value>  
      composites: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.role.add.composites?roleName=<value>&composites=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.role.add.composites roleName=<value> composites=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.role.create

---

Creates a new role and puts its role uuid in the body under key roleUuid. Throws exception if role already exists.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
name	String	true	null	The unique role name.
composites	String	false	null	A PEL list of roles names to add to this role as children. Makes this role a composite.
attributes	Map	false	null	A map which holds optional attributes to be added to this role.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.role.create:  
      name: <value>  
      composites: <value>  
      attributes: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.role.create?name=<value>&composites=<value>&attributes=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.role.create name=<value> composites=<value> attributes=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.role.members

---

Lists all users which are member of the given role. The response is a JSON array with these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_userrepresentation

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
roleName	String	false	null	The name of the role.
max	Integer	false	1000	The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
offset	Integer	false	0	The offset to start return entries.
filter	String	false	null	The filter query to additionally filter the result. Not applied if null
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.role.members:  
      roleName: <value>  
      max: <value>  
      offset: <value>  
      filter: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.role.members?roleName=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.role.members roleName=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.run.as

---

Executes the subsequent pipeline as different user if following two conditions are met. 1. currently logged-in user has permission CAN_RUN_AS_SOURCE 2. requested user has permission CAN_RUN_AS_TARGET

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
username	String	true	null	The username, subsequent pipe commands must be executed as. This user must has RUN_AS_SOURCE role assigned.
caching	String	false	yes	Should the IAM cache used (= much faster)?
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - iam.run.as:  
      username: <value>  
      caching: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.run.as?username=<value>&caching=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command iam.run.as username=<value> caching=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.search

---

Searches for specific entity in the IAM service matching the given filter. Returns the JSON representation of the given type as JSON array. See here for the representation types: https://www.keycloak.org/docs-api/11.0/rest-api/ .For example the type 'USER' would return a list of 'UserRepresentation'.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
type	String	true	null	The entity type to search for. Supported values are: ROLE, USER, GROUP, REALM.
max	Integer	false	1000	The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
offset	Integer	false	0	The offset to start return entries.
filter	String	false	null	The filter query to additionally filter the result. Not applied if null
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.search:  
      type: <value>  
      max: <value>  
      offset: <value>  
      filter: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.search?type=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.search type=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.token

---

Obtains the full offline token response JSON in exchange for user credentials provided and writes into the output.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
username	String	true	null	The user name.
password	String	true	null	The user password.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.token:  
      username: <value>  
      password: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.token?username=<value>&password=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.token username=<value> password=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.token.logout

---

Logs out keycloak session associated with refreshToken and removes any refresh and access tokens from headers.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
refreshToken	String	true	null	The refresh token.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - iam.token.logout:  
      refreshToken: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.token.logout?refreshToken=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command iam.token.logout refreshToken=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.token.refresh

---

Enrich headers with accessToken obtained from authorization server using refreshToken and returns the tokenResponse in the body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
refreshToken	String	true	null	The refresh token.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.token.refresh:  
      refreshToken: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.token.refresh?refreshToken=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.token.refresh refreshToken=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.add.groups

---

Adds groups to a user by group id or name and returns the group ids added.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
uuid	String	true	null	The unique username as uuid.
groupNames	String	false	null	The group names to join. If not given, groupIds is required.
groupIds	String	false	null	The group ids to join. If not given, groupIds is required.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.user.add.groups:  
      uuid: <value>  
      groupNames: <value>  
      groupIds: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.add.groups?uuid=<value>&groupNames=<value>&groupIds=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.add.groups uuid=<value> groupNames=<value> groupIds=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.add.roles

---

Adds roles to a given user. Roles must exist beforehand.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
userUuid	String	true	null	The unique username as uuid.
username	String	true	null	The unique username as uuid.
roleNames	String	true	null	The role names to join. Can be a comma separated list or a PEL pointing to a list.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.user.add.roles:  
      userUuid: <value>  
      username: <value>  
      roleNames: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.add.roles?userUuid=<value>&username=<value>&roleNames=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.add.roles userUuid=<value> username=<value> roleNames=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.create

---

Creates a new user and returns its uuid in the body. Throws exception if user already exists.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
name	String	true	null	The unique username.
email	String	true	null	The unique email.
firstName	String	false	null	The optional first name.
lastName	String	false	null	The optional last name.
groupNames	String	false	null	The optional groups the user joins.
roleNames	String	false	null	The optional roles (permissions) the user must join.
password	String	false	null	The password to be set for this user or null in order to let the user choose one on login.
attributes	Map	false	null	A map which holds optional attributes to be added to this user.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.user.create:  
      name: <value>  
      email: <value>  
      firstName: <value>  
      lastName: <value>  
      groupNames: <value>  
      roleNames: <value>  
      password: <value>  
      attributes: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.create?name=<value>&email=<value>&firstName=<value>&lastName=<value>&groupNames=<value>&roleNames=<value>&password=<value>&attributes=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.create name=<value> email=<value> firstName=<value> lastName=<value> groupNames=<value> roleNames=<value> password=<value> attributes=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.delete

---

Deletes the user with given uuid.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
uuid	String	true	null	The uuid of the user to delete.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.user.delete:  
      uuid: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.delete?uuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.delete uuid=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.get

---

Looks up a user returns it in the body if exists. The response is a JSON array of these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_userrepresentation

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
username	String	false	null	The name of the user. If not set, param uuid must be set.
uuid	String	false	null	The uuid of the user. If set, the param username is ignored.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.user.get:  
      username: <value>  
      uuid: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.get?username=<value>&uuid=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.get username=<value> uuid=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.groups

---

Lists all groups, the given user is member of. By default, the response is a JSON array with these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_grouprepresentation

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
username	String	false	null	The name of the user. If not set, param uuid must be set.
uuid	String	false	null	The uuid of the user. If set, the param username is ignored.
max	Integer	false	1000	The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
offset	Integer	false	0	The offset to start return entries.
filter	String	false	null	The filter query to additionally filter the result. Not applied if null
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.user.groups:  
      username: <value>  
      uuid: <value>  
      max: <value>  
      offset: <value>  
      filter: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.groups?username=<value>&uuid=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.groups username=<value> uuid=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.list

---

Lists all users. The response is a JSON array of these entities: https://www.keycloak.org/docs-api/5.0/rest-api/index.html#_userrepresentation

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
includeGroups	Boolean	false	null	Include all groups, for each user he is member of? Note: If true, the command execution becomes significantly slower!
includeRoles	Boolean	false	null	Include all realm roles, for each user he is member of? Note: If true, the command execution becomes significantly slower!
max	Integer	false	1000	The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
offset	Integer	false	0	The offset to start return entries.
filter	String	false	null	The filter query to additionally filter the result. Not applied if null
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.user.list:  
      includeGroups: <value>  
      includeRoles: <value>  
      max: <value>  
      offset: <value>  
      filter: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.list?includeGroups=<value>&includeRoles=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.list includeGroups=<value> includeRoles=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

iam.user.roles

---

Lists all effective role names, the given user is member of.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
username	String	false	null	The name of the user. If not set, param uuid must be set.
uuid	String	false	null	The uuid of the user. If set, the param username is ignored.
max	Integer	false	1000	The max number of entries to return. If set to a higher value than 1000, will be reset to 1000.
offset	Integer	false	0	The offset to start return entries.
filter	String	false	null	The filter query to additionally filter the result. Not applied if null
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - iam.user.roles:  
      username: <value>  
      uuid: <value>  
      max: <value>  
      offset: <value>  
      filter: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/iam.user.roles?username=<value>&uuid=<value>&max=<value>&offset=<value>&filter=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command iam.user.roles username=<value> uuid=<value> max=<value> offset=<value> filter=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

if

---

Executes the subsequent pipeline only if given condition evaluates to true. By default the full pipeline until the end will be executed. To skip the pipes inside the if definition place the pipe if?end where the if should end.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
true	String	false	null	Default parameter which points to the expression which must evaluate to true. Only one of true or false param is allowed.
end	String	false	null	Defines the end of of the if pipe. If not set, the full pipeline till its end is executed.
else	String	false	null	Defines the else part of the if statement. If value of if evaluates to false, the section right after this else statement is executed until the if?end statement or the end of the pipeline.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - if:  
      true: <value>  
      end: <value>  
      else: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/if?true=<value>&end=<value>&else=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command if true=<value> end=<value> else=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

job

---

Schedules any subsequent commands of the current pipeline and executes it at the scheduled times.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
schedule	String	true	null	A schedule string which configures the execution of the job. Can be one of: EVERY_2_MIN, EVERY_5_MIN, EVERY_15_MIN, EVERY_30_MIN, EVERY_45_MIN, HOURLY, DAILY, WEEKLY, MONTHLY. Furthermore in development stage also EVERY_1_MIN is allowed. Throws an exception in production stage.
stop	String	false	null	Deprecated. Use the command stop.stop instead. If this param is set, all other params are ignored. It contains the id of the job to be canceled.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - job:  
      schedule: <value>  
      stop: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/job?schedule=<value>&stop=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command job schedule=<value> stop=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

job.list

---

Lists all scheduled pipeline jobs.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - job.list:  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/job.list?id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command job.list id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

job.status

---

Returns the status of a given job or null in case the job doesnt exist.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
pipelineKey	String	true	null	The pipelineKey of the job those status to return
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - job.status:  
      pipelineKey: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/job.status?pipelineKey=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command job.status pipelineKey=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

job.stop

---

Stops the job with given id. Note: Usually it is not required to use this command. In order to stop and unregister a job, simply remove it from the pipeline or delete the pipeline.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
pipelineKey	String	true	null	The pipeline key of the job to be cancelled.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - job.stop:  
      pipelineKey: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/job.stop?pipelineKey=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command job.stop pipelineKey=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

jpa.query

---

Executes a JPA query and returns the result as JSON in the body. NOTE: This pipe is primarily meant for support to monitor the system. Its not accessible by default accounts! This can change at any time without notice!

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
query	String	false	null	The JPA query to be executed.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - jpa.query:  
      query: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/jpa.query?query=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command jpa.query query=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

log

---

Logs the given input message without changing it. Sets the log message in the body in case body is empty. Doesn't overwrite any existing content in the body.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
message	String	true	null	The message to log. Can be a string or a pipe expression. If null or empty, the full pipe message will be logged.
level	String	false	INFO	The log level. Can be one of DEBUG, TRACE, INFO, WARN, ERROR. If null or empty, INFO will be used.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - log:  
      message: <value>  
      level: <value>  
      id: <value>  
      if: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/log?message=<value>&level=<value>&id=<value>&if=<value>  

Command Line Interface (CLI) example:

pi command log message=<value> level=<value> id=<value> if=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

log.list

---

Logs the given number of log lines from specified service.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
service	String	false	hub	The service to print logs for. If null or empty, the 'hub' will be used.
lines	Integer	false	100	The number of lines to print in case format is text. 100 is printed when not specified.
format	String	false	text	The format to be returned. One of: text, json
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - log.list:  
      service: <value>  
      lines: <value>  
      format: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/log.list?service=<value>&lines=<value>&format=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command log.list service=<value> lines=<value> format=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

log.list.email

---

Returns the email audit log properties. Only available for developers, system or support users.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
auditId	String	false	null	The audit id (uuid) of the logged email to return. If null or empty, all emails will be returned matching the given parameters.
createdAfter	String	false		Returns only those emails created after this date in ISO-8601 format. If null or empty, no after filter will be set.
createdBefore	String	false		Returns only those emails created before this date in ISO-8601 format. If null or empty, no before filter will be set.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - log.list.email:  
      auditId: <value>  
      createdAfter: <value>  
      createdBefore: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/log.list.email?auditId=<value>&createdAfter=<value>&createdBefore=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command log.list.email auditId=<value> createdAfter=<value> createdBefore=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

log.list.environment

---

Logs the current environment properties. Only available for developers, system or support users.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
interpolate	String	false	true	Return all properties with values interpolated? (= ${some.var} is resolved).
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - log.list.environment:  
      interpolate: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/log.list.environment?interpolate=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command log.list.environment interpolate=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

log.search

---

Searches the cloud logs and returns the last 30 entries per request. Supports pagination toscroll thru the entries.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
service	String	false	hub	The service to search for log entries. Can be a list or comma separated service names. If null or empty, 'hub' will be used as default.
severity	String	false	null	The severity to search inside: DEBUG, INFO, WARNING, ERROR. Can be a list or comma separated text. If null or empty, searches in all severities.
messageFilter	String	false	null	Message search string to filter the result by matching this string. Can be null or empty to return any entry.
typeFilter	String	false	null	A list of types of message logs to show. Possible values are: command, pipeline, security_audit, event_fired, webhook. If not set, all logs will be shown.
startDateTime	String	false	null	An ISO8601 date-time string to start the search at. If null or empty, the date-time string from 24h before will be used.
endDateTime	String	false	null	An ISO8601 date-time string to end the search at. If null or empty, all results up to now will be returned.
nextPageToken	String	false	null	If this value is given, the next page of results of a previous search is loaded.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - log.search:  
      service: <value>  
      severity: <value>  
      messageFilter: <value>  
      typeFilter: <value>  
      startDateTime: <value>  
      endDateTime: <value>  
      nextPageToken: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/log.search?service=<value>&severity=<value>&messageFilter=<value>&typeFilter=<value>&startDateTime=<value>&endDateTime=<value>&nextPageToken=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command log.search service=<value> severity=<value> messageFilter=<value> typeFilter=<value> startDateTime=<value> endDateTime=<value> nextPageToken=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

log.services

---

Returns all PIPEFORCE services for those logging is allowed / enabled.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - log.services:  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/log.services?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command log.services id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

log.severities

---

Returns all severities (for example, DEBUG, INFO,...), supported by the logging system.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - log.severities:  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/log.severities?id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command log.severities id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

mail.dump

---

Fetches new emails from given mail inbox and uploads them into a drive folder.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
protocol	String	false	imap	The email protocol. One of 'imap' or 'pop3'.
host	String	true	null	The email host.
port	Integer	true	null	The port of the email host.
inboxUsername	String	true	null	The username of the email inbox.
inboxPassword	String	true	null	The password of the email inbox.
driveUsername	String	true	null	The username of the drive account to upload to.
drivePassword	String	true	null	The password of the drive account to upload to.
path	String	false	null	The remote folder path in drive where to upload the emails into. For each new email a new sub folder will be created inside this path. If null or empty, uploads to the root folder of the logged in user.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - mail.dump:  
      protocol: <value>  
      host: <value>  
      port: <value>  
      inboxUsername: <value>  
      inboxPassword: <value>  
      driveUsername: <value>  
      drivePassword: <value>  
      path: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/mail.dump?protocol=<value>&host=<value>&port=<value>&inboxUsername=<value>&inboxPassword=<value>&driveUsername=<value>&drivePassword=<value>&path=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command mail.dump protocol=<value> host=<value> port=<value> inboxUsername=<value> inboxPassword=<value> driveUsername=<value> drivePassword=<value> path=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

mail.fetch

---

Fetches new emails from given mail inbox and returns them as JSON in the output.

Try online.

Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
protocol	String	false	imap	The email protocol. One of 'imap' or 'pop3'.
host	String	true	null	The email host.
port	Integer	true	null	The port of the email host.
inboxUsername	String	true	null	The username of the email inbox.
inboxPassword	String	true	null	The password of the email inbox.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.
output	String	false	null	Defines a PEL where to write the result of this command. If null or empty, then the result is written to the body.

Pipeline example:

pipeline:  
  - mail.fetch:  
      protocol: <value>  
      host: <value>  
      port: <value>  
      inboxUsername: <value>  
      inboxPassword: <value>  
      id: <value>  
      if: <value>  
      output: <value>  

Learn more: Pipeline.

URL example:

http://host/api/v3/command/mail.fetch?protocol=<value>&host=<value>&port=<value>&inboxUsername=<value>&inboxPassword=<value>&id=<value>&if=<value>&output=<value>  

Command Line Interface (CLI) example:

pi command mail.fetch protocol=<value> host=<value> port=<value> inboxUsername=<value> inboxPassword=<value> id=<value> if=<value> output=<value>  

Learn more: Command Line Interface (CLI) | CLI Reference.

mail.send

---

Sends the given message as email. The message's subject and body will be used for in the email accordingly.

Try online.

Alias: pipe.command.mail
Input body type: JsonNode
Output body type: JsonNode
Parameters:

Name	Type	Required	Default	Description
to	String	true	null	Comma separated list of to email addresses. Never null. If this is an expression and points to comma separated list, an array or a collection, will send an email to any of the entries.
from	String	false	Systems default FROM setting.	The from email.
fromName	String	false	Systems default FROM name setting.	The from name.
subject	String	false	Systems default subject setting.	The subject.
model	String	false	null	The optional model to be used in case subject and/or message point to a template.
message	String	false	null	By default, the body is used as email message. If this param is set, it will be used as message instead. Can also be a PE which points to a value to be used as the mail message.
replyTo	String	false	null	Reply-To email address is used when email receiver uses its mail client's 'reply' function. If not used,the from address is used automatically.
attachments	String	false	null	Can be a comma separated list of URI Strings (e.g.: uri:drive:file1, uri:property:global/file2, uri:drive:file1, uri:classpath:pipeforce/file3). Also can point via PEL to a content object or a content collection. If the PEL points to an object differently to an uri or content object, serializes the value to string and attaches this as a text file.
id	String	false	null	The optional id of this command, unique within the pipeline.
if	String	false	null	Is the command enabled (if=true)? Can be a static boolean value of a PE to be evaluated. If this value is set to false, negative number, null or empty string, the command is disabled and will be skipped when defined in a pipeline. By default it is set to true = command is enabled.

Pipeline example:

pipeline:  
  - mail.send:  
      to: <value>  
      from: <value>  
      fromName: <value>  
      subject: <value>  
      model: <value>