Deploy V2 Rest API

The DeploymentRestService APIs provides methods to manage the installed deployment packages.
Identities with rest.deploy permissions can access these APIs.

Get installed packages

• Description: Provides the list of all the deployment packages installed and tracked by the framework.
• Method: GET
• API PATH: /deploy/v2/

Responses

• 200 OK status

[{ "name": "packageName", "version": "packageVersion"}]

Install package from URL

• Description: Installs the deployment package specified in the InstallRequest. If the request was already issued for the same InstallRequest, it returns the status of the installation process.
• Method: POST
• API PATH: /deploy/v2/_install

Request Body

{
  "url": "deploymentPackageUrl"
}

Example:

{
  "url": "http://download.eclipse.org/kura/releases/4.1.0/org.eclipse.kura.demo.heater_1.0.500.dp"
}

Please note that the url can refer to a .dp already in the device filesystem.

Responses

• 200 OK status
• 400 Bad request

"REQUEST_RECEIVED"

Install package from upload

• Description: Upload and install a Deployment Package.
• Method: POST
• API PATH: /deploy/v2/_upload

Request Body

The POST request body should be encoded in the multipart/form-data enctype, thus allowing for the upload of the Deployment Package file. The uploaded file is expected to be added in the file field of the form.

Headers

• Content-Type: multipart/form-data

Body (formdata)

• file

Example

Example using curl:

curl -X POST -k -u $USERNAME:$PASSWORD \
    --header 'Content-Type: multipart/form-data' \
    --form 'file=@"/path/to/your/file.dp"' \
    https://$ADDRESS/services/deploy/v2/_upload

Responses

• 200 OK status
• 400 Bad request

"REQUEST_RECEIVED"

Uninstall a package

• Description: Uninstalls the deployment package identified by the specified name. If the request was already issued, it reports the status of the uninstallation operation.
• Method: DELETE
• API PATH: /deploy/v2/{name}

Responses

• 200 OK status

"REQUEST_RECEIVED"