REST API

REST API

aqua offers a REST API. You can use the API for example to access information from items or test executions, to create or modify new items, to manage the user administration, to create test executions and much more. This allows you to automate recurring tasks in aqua via scripts, easily handle large amounts of data (e.g. assign thousands of users to a project) or create interfaces with your third-party systems or automation tools.
 
The REST API is documented in detail with examples of the requests and the possible responses and contents.
 
As aqua OnPremises customer, you can find the documentation on the REST API help page at:
http(s)://<YourServerNameOrIP>/aquaWebNG/Help
 
or in some cases:
http(s)://<YourServerNameOrIP>/aquaWeb/Help
 
Please replace <YourServerNameOrIP> with your server name or the server IP address.
 
As aqua SAAS customer, please visit the following page:
https://aqua-saas2.andagon.com/aquaWebNG/Help
 
On the aqua Demo environment, please visit the following page:
https://aqua-demo2.andagon.com/aquaWeb/Help
 
 
Please also note the following when using the REST API
  • The permissions and the license of the user used to login to the REST API will affect what is allowed. For example, you cannot create a test case using the API with a user who does not have permissions to create test cases
  • The ID of items within the requests must be specified without leading zeros, e.g., 123 and not TC000123 or 000123

    • Related Articles

    • Configuration in aqua

      This step is optional but recommended. In order to show information about any Jira items in aqua, the connection to Jira needs to be configured. In order to configure the integration, click on the configuration menu in the upper left corner of the ...

    • Troubleshooting

      Self-signed certificate Jira can be configured to support secure connections via HTTPS. In this case, all HTTP requests are redirected by Jira to HTTPS. When a self-signed certificate is used by Jira, the Jira sync and also the sync configurator can ...

    • Checklist before start

      Please make sure, you have the topics from this checklist done, before you start your synchronization. Administrative access to aqua and Jira is required for the initial setup. Licenses You will receive a special Jira sync license. If you do not have ...

    • LDAP

      Users in aqua can be authenticated via LDAP. Precondition: the user has been created in aqua before, that is, the given username exists in both systems, in aqua and in LDAP. If you have a large number of users, you can also use the following script ...

    • Create sync

      To create a new sync, click on New sync in the SyncConfigurator.     A window will open, where you have to select the sync's type.     Usually, you will only have the option to select Jira Rest. To create a Jira Sync, select Jira Rest. Click on Next. ...