REST API

The Axon Ivy Engine comes with REST deployment API which can be used to deploy new applications or projects. It can be inspected with the API Browser.

The REST deployment API makes highly customized deployment chains possible. This is the prefered approach to build a CI/CD pipeline because it is platform independent. You can use any tool you want to call this REST API like curl. Whether a deployment was succesful or not can be checked by verifying the http status code, which must be 200.

Example how to deploy via curl:

sh "curl -X POST http://localhost/system/api/apps/myApp -u admin:admin -H 'X-Requested-By: curl' -F fileToDeploy=@/tmp/app.zip"

Explanation:

• -X POST: You need to send a HTTP POST request.

• http://localhost/system/api/apps/myApp: URL targeting your application.

• -u admin:admin: Username and password of an administrator user.

• -H 'X-Requested-By: curl': HTTP Header to prevent CSRF attacks. Any value for curl possible.

• -F fileToDeploy=@/tmp/app.zip: The file which needs to be deployed.

The deploy.options.yaml can be provided within the file to deploy or additionally specified in the HTTP request, read more here: REST deployment API.