Routes

Here's a list of our publically available routes that you can use to interact with the Aplos NCA SaaS solution.

If you are on professional, academic or developer plans you will access the API(s) from :

https://api.aplos-nca.com

Team or Enterprise accounts will have a dedicated tenancy and will have an API path unique to their AWS Account

https://api.<tenant-name>.aplos-nca.com
https://api.<sandbox>.<tenant-name>.aplos-nca.com (additional cost)

The final routes are subject to change before Go-Live Summer 2024

The following applies to EARLY ACCESS prior to Go Live.

Some of our routes will be changing prior to our final go-live date this summer (2024). They won't change during Early Access, but be sure to check the documentation.

In order to make a smooth tranistion, we'll provide detailed information on which routes changed and which remained the same. As a good programming practice, you store the routes in a central library for easier migration.

Older routes may be kept active for short period of time to help with any transitions.

Route Name

Endpoint URL

https://cognito-idp.{region}.amazonaws.com

Get a Presigned Url

https://api.<tenant>.aplos-nca.com/tenants/{tenant-id}/users/{user-id}/nca/files

Upload a file

The full path is generated for you and returned in the response of the presigned url.

Get Status

https://api.<tenant>.aplos-nca.com/tenants/{tenant-id}/users/{user-id}/nca/executions/{id}

Run/Execute an analysis

https://api.<tenant>.aplos-nca.com/tenants/{tenant-id}/users/{user-id}/nca/executions

List User Executions

https://api.<tenant>.aplos-nca.com/tenants/{tenant-id}/users/{user-id}/nca/executions

List Metrics

https://api.<tenant>.aplos-nca.com/tenants/{tenant-id}/users/{user-id}/metrics

Routes ​

Routes