API Reference

The REST API allows you to get information about a running Axon.ivy Engine and to control it remotely. The API is by default accessible under http://localhost:8080/<appName>/api.

Note

All modifier requests such as POST, PUT and DELETE are CSRF protected. For this reason, the HTTP header field X-Requested-By must be set with any value for each request.

Deployment

POST /system/api/apps/(applicationName)

Deploy a project .iar file or multiple projects in a .zip file to an application.

Example request:

curl -X POST \
  http://localhost:8080/system/api/apps/test \
  -u admin:admin \
  -H 'X-Requested-By: curl' \
  -F fileToDeploy=@/home/user/Documents/Test.zip \
  -F deploymentOptions=@deploy.options.yaml

Example response:

14:14:51.708 Info: Start deploying project(s) of file 'Test.iar' to application 'test'.

14:14:51.710 Info: Using DeploymentOptions[overwriteConfiguration=false,cleanupConfiguration=DISABLED,deployTestUsers=FALSE,targetVersion=AUTO,targetState=ACTIVE_AND_RELEASED,targetFileFormat=AUTO]

14:14:51.728 Info: Synchronize project directory ...
14:14:51.729 Info: - Cleaning target archive ...
14:14:51.729 Info: - Copying new project to test/Test/1.zip ...
14:14:51.730 Info: Successful synchronized.

14:14:51.730 Info: Project(s) of file 'test.iar' successful deployed to application 'test' in 22 ms.
Parameters

  • applicationName – (required) name of the target application

Form Parameters

  • fileToDeploy – (required) project .iar file or multiple projects in a .zip file

  • deploymentOptions – (optional; if given the form parameters below are ignored) deployment options as yaml file

  • deployTestUsers – (optional; ignored if deploymentOptions is given) deploy test users

  • overwriteConfig – (optional; ignored if deploymentOptions is given) overwrite configuration

  • cleanupConfig – (optional; ignored if deploymentOptions is given) cleanup configuration

  • targetVersion – (optional; ignored if deploymentOptions is given) target version

  • targetState – (optional; ignored if deploymentOptions is given) target state

  • targetFileFormat – (optional; ignored if deploymentOptions is given) target file format

Request Headers

  • Basic Authentication – (required) administrator user and password

  • X-Requested-By – (required) see note

Status Codes