FlexDeploy supports a REST Service interface using JSON. This enables access to capabilities of the tool from outside applications such as scheduling tools, scripts, and other build tools.


http://<host>:<port>/flexdeploy/rest/properties
Set the request header Content-Type to application/json.

API Functions


Common Parameters

Authentication

The authentication parameter is comprised of 2 fields.

  • userId – a valid user id for FlexDeploy
  • password – the associated password

code

This is the Property Code, and not the Display Name that you see on most screens, that the request will update the value for. To copy the Property Code to your clipboard click on the clipboard icon to the right of any property.

value

This is the new value that will be assigned to the respective property.

IsExpression

This is a required, boolean value indicating whether or not the value is an expression (true) or a literal value. On the FlexDeploy screens the properties have a button that toggles to indicate whether a value is an expression or a literal value .