🚧

Please note that these are the docs for the new version of the API released in September 2022 (v2022.09). If you started using the API before this time, you may be looking for version 2018.01 instead.

If you want to try out our API, we provide two easy ways of doing so:

Directly from our Documentation

You can use the "Try It!" feature embedded within each endpoint page of the API reference docs. This will allow you to make live calls to our sandbox environment, provided you enter a valid bearer token.

794

Postman Collection

Alternatively, we provide a Postman collection that you can import here: Run in Postman

📘

Before you get started, you will need to set the TENANT_ID and BEARER_TOKEN variables, either for the collection or for your Postman environment. You can retrieve both from the API Tokens page in Aurora.

When you create a new object, we save the ID so you can use it when retrieving or updating the object. For example, if you create a project, the collection will store the project id in the PROJECT_ID variable. The next time you retrieve a project, Postman will use that id in the url path /tenants/{{TENANT_ID}}/projects/{{PROJECT_ID}} so you don't have to copy and paste that ID.

Under the hood, we use scripts (under the Tests tab) to store the values in variables. Our collection supports storing variables at the collection level or in Postman environments, which make it easy to switch between sandbox and production.