REST API Reference

Release Automation (Nolio)
offers REST APIs that enable external systems to configure, execute, and monitor release operations and accompanied artifacts without having to access the UI. The REST API provides both the Get and the POST methods that are required to retrieve data and to execute the process.
Release Automation (Nolio)
offers REST APIs that enable external systems to configure, execute, and monitor release operations and accompanied artifacts without having to access the UI. The REST API provides both the Get and the POST methods that are required to retrieve data and to execute the process.
The base URL for the available services is:
API Version 3 and 4: http://<host>:<port>/datamanagement/a/api
API Version 5: http://<host>:<port>/datamanagement/ra/<api category>/v5/<api>
The REST API documentation is available directly in your deployment of
Release Automation (Nolio)
at the following URL:
http://<host>:<port>/datamanagement/apis/public.html
REST calls should include Content-Type: text/html in the HTTP header.
In addition to the following documented REST APIs, you can now access and test the
Release Automation (Nolio)
REST APIs in Swagger. To access Swagger from the
Release Automation (Nolio)
UI, in the upper right-hand corner, click
Help
, and select
REST API (Swagger)
.
Versioning:
Version
Description
None
If you do not supply the API version, version V4 is used.
V4
Created for versions 5.5.2 and later. Includes several new operations on template categories and templates that are marked with
(V4+)
V5
Created for versions 6.6 and later. Includes several new operations on director server, user management, server management that are marked with
(V5+)
REST Calls
Method
URL
Description
POST
Adds an artifact package to an existing deployment plan
(V4+)
PATCH
Adds a user to a specified group
(V5+)
DELETE
Deletes agent as test agent by agent ID
(V5+)
PATCH
Sets agent as test agent by agent ID
(V5+)
GET
Retrieves all applications
(V4+)
POST
Creates an application
(V5+)
GET
Retrieves a specific application
(V4+)
POST
Creates a template category in an application.
(V4+)
GET
Gets template categories in an application.
(V4+)
DELETE
Deletes a template
(V4+)
PUT
Updates a template category in an application.
(V4+)
POST
Gets template properties of the template category
(V4+)
POST
Gets all steps of a template category.
(V4+)
POST
Creates a template property.
(V4+)
DELETE
Deletes a template property.
(V4+)
POST
Updates a template property.
(V4+)
POST
Creates a step in a template category, the step is used by templates in the template category.
(V4+)
DELETE
Deletes template category step.
(V4+)
POST
Updates template category step.
(V4+)
GET
Gets deployment templates of the template category.
(V4+)
POST
Creates a deployment template in a category.
(V4+)
PUT
Updates a deployment template.
(V4+)
DELETE
Deletes a deployment template.
(V4+)
POST
Gets templates steps. Steps are grouped by stage type.
(V4+)
POST
Attaches a category step to a template.
(V4+)
DELETE
Detaches a step from a template.
(V4+)
PUT
Updates the dependencies of a step.
(V4+)
PUT
Creates component revision mappings
(V5+)
POST
Copies a shared component to a local application
(V5+)
GET
Exports XML metadata of a deployment template.
(V4+)
GET
Retrieves all environments for a specific application.
(V4+)
GET
Retrieves a specific environment for a specific application.
(V4+)
GET
Retrieves all deployments for a specific application and environment.
(V4+)
GET
Retrieves a specific deployment for a specific application and environment.
(V4+)
GET
Retrieves processes tree
(V5+)
GET
Retrieves all active projects for a specific application.
(V4+)
GET
Retrieves a project from application and project ids.
(V4+)
GET
Retrieves all deployment plans under specific application and project.
(V4+)
GET
Retrieves specific deployment plan.
(V4+)
GET
Retrieves all templates for a specific application.
(V4+)
GET
Retrieves a specific template for a specific application.
(V4+)
POST
Deprecated.
This API is relevant only for v4.7. From v5.0, use /artifact-version-details
POST
Deprecated.
This API is relevant only for v4.7. From v5.0, use /artifact-version-status
POST
Retrieves the details of a specific artifact-version
(V4+)
POST
Retrieves the status of a specific artifact-version
(V4+)
POST
Creates and Adds an artifact package to an existing deployment plan
(V4+)
POST
Deprecated
. This API is relevant only for v4.7. From v5.0, use /create-artifact-package-xml
POST
Creates an empty artifact package
(V4+)
POST
Creates an artifact package that is provided in XML
(V4+)
POST
Creates an artifact-version with all the different parameters entered
(V4+)
POST
Creates a deployment plan
(V4+)
POST
Create a unique project for the given application.
(V4+)
POST
Deprecated.
This API is relevant only for v4.7. From v5.0, use /run-deployment-plan
POST
Deletes an artifact version
(V4+)
POST
Deletes a release (deployment)
(V4+)
POST
Deletes all specified user groups.
(V5+)
POST
Deletes all specified users.
(V5+)
GET
Retrieves the logs of a specified deployment.
(V5+)
GET
Gets the state of the deployment.
(V4+)
POST
Changes a deployment manual approval status.
(V4+)
GET
Retrieves all directory server definitions.
(V5+)
POST
Creates a directory server definition.
(V5+)
POST
Triggers connectivity tests for all the directory servers of a specified directory server type that exist on a specific server.
(V5+)
DELETE
Deletes a specified directory server definition.
(V5+)
GET
Retrieves a specified directory server definition.
(V5+)
PATCH
Updates a specified directory server definition.
(V5+)
GET
Retrieves all the user groups that are linked to a specific directory server.
(V5+)
GET
Retrieves all the users that are linked to a specific directory server.
(V5+)
POST
Exports a DSL file representation of an application model
(V5+)
POST
Exports a release (deployment)
(V4+)
POST
Exports a release to an XML
(V4+)
GET
Exports a process to a PDF
(V4+)
GET
Exports a release (deployment) to a PDF.
(V4+)
POST
Retrieves artifact-versions for a given artifact-package
(V4+)
POST
Retrieves artifact-versions for a given artifact-definition
(V4+)
POST
Retrieves the value of a parameter in an environment
(V4+)
POST
Imports groups from a specified directory server.
(V5+)
GET
Retrieves the logs of a specified job.
(V5+)
POST
Imports a DSL file representation of an application model
(V5+)
POST
Loads a manifest file to a deployment plan
(V4+)
POST
Loads tokens values to an environment.
(V4+)
DELETE
Deletes process tags in a process.
(V5+)
GET
Retrieves a list of all published tags of a specified design process.
(V5+)
GET
Retrieve a list of usages of a specified process.
(V5+)
POST
Retrieves a status of a release (deployment)
(V4+)
GET
Retrieves a status of a release (deployment)
(V4+)
GET
Retrieves the releases (deployments) reports by filters
(V4+)
PATCH
Removes given users from a specified user group.
(V5+)
POST
Creates a deployment plan then runs deployments on different environments.
(V4+)
POST
Creates (and optionally runs) a deployment.
(V4+)
POST
Deprecated.
This API is relevant only for v4.7. From v5.0, use /run-deployments.
POST
Deprecated.
This API is relevant only for v4.7. From v5.0, use /run-deployment-plan
POST
Schedule a release (deployment) by entering a release id or unique release attributes and the scheduled properties.
(V4+)
POST
Returns all server groups.
(V5+)
GET
Returns the server group data for a given server group ID.
(V5+)
GET
Returns all servers.
(V5+)
GET
Retrieves a list of all the shared components in the system.
(V5+)
POST
Retrieves a step status
(V4+)
GET
Retrieves a status of a step
(V4+)
POST
Stopping a running release
(V4+)
GET
Retrieves all system properties.
(V5+)
POST
Creates a system property.
(V5+)
DELETE
Deletes a system property.
Note:
Only a user-added system property can be deleted.
(V5+)
GET
Retrieves a system property by either name or ID.
(V5+)
PUT
Returns an updated system property.
(V5+)
POST
Updates the value of a parameter in an environment.
(V4+)
POST
Deprecated.
This API is relevant only for v4.7. From v5.0, use /load-manifest
POST
Upgrade remote Agents
(V4+)
PUT
Assigns listed users to specified local groups.
(V5+)
GET
Retrieves all user group definitions.
(V5+)
POST
Creates a user group definition.
(V5+)
PUT
Add users to user groups.
(V5+)
PATCH
Updates user groups permissions
(V5+)
GET
Retrieves groups permissions.
(V5+)
PATCH
Updates groups permissions.
(V5+)
GET
Returns all server groups the specified user group is authorized to use.
(V5+)
PUT
Updates the server groups the specified user group is authorized to use. This method overwrites previous data.
(V5+)
DELETE
Deletes a specified user group.
(V5+)
GET
Returns a specified user group.
(V5+)
PATCH
Patches a specified user group.
(V5+)
PUT
Updates a specified user group.
(V5+)
GET
Returns all of the users in a specified user group.
(V5+)
PUT
Updates all of the users in a specified user group.
(V5+)
GET
Gets all users.
(V5+)
POST
Creates a user.
(V5+)
POST
Imports users from a specified directory server. 
(V5+)
PATCH
Updates users permissions
(V5+)
DELETE
Deletes a user.
(V5+)
GET
Retrieves a user.
(V5+)
PATCH
Patches a user.
(V5+)
GET
Retrieves all local groups for a given user.
(V5+)
PUT
Updates the local groups for a given user.
(V5+)
GET
Returns a specified user's application permissions.
(V5+)
PATCH
Updates a specified user's application permissions.
(V5+)
GET
Returns a specified user's server group permissions.
(V5+)
PUT
Updates a specified user's server group permissions.
(V5+)
GET
Gets group permissions.
(V4+)
PATCH
Updates groups permissions.
(V4+)
GET
Gets users permissions.
(V4+)
PATCH
Updates users permissions.
(V4+)
The REST API uses the following DTOs to standardize request and response data in REST calls:
Alphabetical List of DTOs
[A] [C] [D] [E] [F] [L] [P] [R] [S] [T] [U]
A
C
D
E
F
L
P
R
S
T
U