REST API

General

We provide a REST API. You can use the API to access information from items or test runs, create or modify new items, manage user administration, create test runs, 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 to 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 public cloud customer, please visit the following page:

https://app.aqua-cloud.io/aquaWebNG/Help

Please also note the following when using the REST API

• The permissions and license of the user logging into 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

Accessing the rest API

Please follow the instructions in the 'Authorizations' section of our REST API documentation to gain access.

If you are using Java Script, Python, or Power Shell to communicate with the REST API, you can contact us at [email protected] for additional support.

API rate limits

What	Limit
Agents	20 requests per second
Upload attachments	20 uploads per minute
Upload images	20 uploads per minute
API	20 requests per second

To improve the stability and future-proof your automation workflows, in a few months we are introducing a new public API. This new API will coexist with the current internal one, but is designed to offer greater stability and will be our recommended interface for external integrations going forward, as the internal API may change without notice.

Here’s what’s coming:

• 🧾 Preliminary documentation is ready for you to explore, so you can review all available endpoints and compare them to your current usage. Please download the file below.

• 🔐 Authorization is changing. In future, for each request, you’ll now need to use the Authorization header with the Bearer token. More details will follow soon in the full documentation.

• 🧪 Test environment. We’re preparing a dedicated test environment for the new API. You’ll be able to validate your implementation before it goes live. We’ll notify you as soon as it’s ready.

What’s next?

To make sure everything continues to run smoothly, we encourage you to review the documentation and share your questions or feedback by June 23, 2025. This gives us time to make any needed adjustments before the official release.

Download the API documentation below:

479KB

aqua-public-swagger.json

For private cloud or on-prem users:

Aber Sie haben die volle Kontrolle darüber, wann Sie auf die Version mit der neuen API upgraden, so dass Sie sich in Ihrem eigenen Tempo anpassen können. Wir werden Sie benachrichtigen, sobald er fertig ist.