Routes

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

If you are on a professional, academic, or developer plan you access the API from:

• https://api.aplos-nca.com

Team or Enterprise accounts have a dedicated tenancy with 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)

All routes require a JWT Authorization: Bearer <token> header unless marked Public.

The routes below are grouped by feature area, mirroring how they are organized in our Postman and Bruno collections.

Tip

This list is generated automatically from our OpenAPI specification, so it always reflects the current API. For request/response schemas and an interactive "try it out" experience, see the OpenAPI reference.

Audit Logs

Get Audit Config Status

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/audit-config/status
Auth	JWT

Query Audit Logs by Resource

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/audit-logs/resources/{resource-type}/{resource-id}
Auth	JWT

Query Audit Logs by Tenant

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/audit-logs
Auth	JWT

Query Audit Logs by User

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/audit-logs/users/{user-id}
Auth	JWT

Authentication

Login → Get JWT

Method	POST
Endpoint URL	https://cognito-idp.{region}.amazonaws.com
Auth	Public

Feature Flags

Create Feature Flag Rule

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/feature-flags/rules
Auth	JWT

Delete Feature Flag Rule

Method	DELETE
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/feature-flags/rules/{rule-id}
Auth	JWT

Delete Feature Key

Method	DELETE
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/feature-flags/registry/{registration-id}
Auth	JWT

Evaluate Feature Flags

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/feature-flags/evaluate
Auth	JWT

List Feature Flag Registry

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/feature-flags/registry
Auth	JWT

List Feature Flag Rules

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/feature-flags/rules
Auth	JWT

Register Feature Key

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/feature-flags/register
Auth	JWT

Update Feature Flag Rule

Method	PUT
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/feature-flags/rules/{rule-id}
Auth	JWT

Update Feature Key

Method	PUT
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/feature-flags/registry/{registration-id}
Auth	JWT

File System

Archive File

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/files/{file-id}/archive
Auth	JWT

Count Files

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/files/count
Auth	JWT

Get File

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/files/{file-id}
Auth	JWT

Get File Download URL

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/files/{file-id}/download-url
Auth	JWT

Get File Lineage

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/files/{file-id}/lineage
Auth	JWT

Get File Metadata

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/files/{file-id}/meta
Auth	JWT

Get File Upload URL

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/files
Auth	JWT

List Files

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/files
Auth	JWT

Stream File Data

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/files/{file-id}/stream
Auth	JWT

Unarchive File

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/files/{file-id}/unarchive
Auth	JWT

Upload Analysis File

Method	POST
Endpoint URL	The presigned URL returned by the upload-url request
Auth	Public

Maintenance

Get Maintenance History

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/maintenance/events
Auth	JWT

Trigger Maintenance

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/maintenance/trigger
Auth	JWT

Metrics

Drilldown Executions

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/metrics/executions
Auth	JWT

Get Tenant Metrics Report

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/metrics
Auth	JWT

Get User Metrics

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/metrics
Auth	JWT

Query Metrics Snapshots

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/metrics/snapshots
Auth	JWT

Plot Themes

plotThemeDeleteDelete

Method	DELETE
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/plot-themes/{theme-id}
Auth	JWT

plotThemeGetGet

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/plot-themes/{theme-id}
Auth	JWT

plotThemeListGet

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/plot-themes
Auth	JWT

plotThemeUpsertPost

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/plot-themes
Auth	JWT

Report Templates

Get Report Template

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/templates/{id}
Auth	JWT

List Report Templates

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/templates
Auth	JWT

Update Report Template

Method	PATCH
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/templates/{id}/status
Auth	JWT

Upload Report Template

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/templates/upload-url
Auth	JWT

Schemas

Get Calculation Block Schema

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/schemas/calculation
Auth	Public

Get Custom Calculations Block Schema

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/schemas/custom_calculations
Auth	Public

Get Custom Plots Block Schema

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/schemas/custom_plots
Auth	Public

Get Custom Reports Block Schema

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/schemas/custom_reports
Auth	Public

Get Custom Tables Block Schema

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/schemas/custom_tables
Auth	Public

Get Data Cleaning Block Schema

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/schemas/data_cleaning
Auth	Public

Site Messages

API Docs Redirect

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/docs
Auth	Public

Get Public App Messages

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/app/messages
Auth	Public

Get Secure App Messages

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/messages
Auth	JWT

Subscriptions

Activate Subscription

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/subscriptions/{subscription-id}/activate
Auth	JWT

Get Active Subscription

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/active-subscription
Auth	JWT

Get Subscription

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/subscriptions/{subscription-id}
Auth	JWT

Get Subscription Status

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/subscription-status
Auth	JWT

List Subscriptions

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/subscriptions
Auth	JWT

Upsert Subscription

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/subscriptions
Auth	JWT

Validate Subscription

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/validate-subscription
Auth	JWT

Tenants

Get Tenant

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}
Auth	JWT

List Tenants

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants
Auth	JWT

Upsert Tenant

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}
Auth	JWT

Users

Cleanup Duplicate Emails

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/cleanup-duplicates
Auth	JWT

Delete User

Method	DELETE
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}
Auth	JWT

Detect Duplicate Emails

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/duplicate-emails
Auth	JWT

Get Assignable Roles

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/assignable-roles
Auth	JWT

Get User

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}
Auth	JWT

List Users

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/
Auth	JWT

Sync Cognito User

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/cognito-sync
Auth	JWT

Upsert User

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users
Auth	JWT

Validate Cognito Status

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/cognito-status
Auth	JWT

Validations

Trigger Validation

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/validations/queue
Auth	JWT

Warm Up

Get Warm-Up Report

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/admin/warm-up/report
Auth	JWT

Get Warm-Up Schedule

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/admin/warm-up/schedule
Auth	JWT

Toggle Warm-Up Schedule

Method	PUT
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/admin/warm-up/schedule
Auth	JWT

Trigger Warm-Up

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/admin/warm-up
Auth	JWT

Workflow

Archive Execution

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/archive
Auth	JWT

Cancel Execution

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/cancel
Auth	JWT

Get Execution Diagnostics

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/diagnostics
Auth	JWT

Get Execution Diagnostics Detail

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/diagnostics-detail
Auth	JWT

Get Execution History

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions
Auth	JWT

Get Execution Lineage

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/lineage
Auth	JWT

Get Execution Original Config

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/config
Auth	JWT

Get Execution Output File

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/outputs/{key-name}
Auth	JWT

Get Execution Root

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/root
Auth	JWT

Get Execution Status

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/status
Auth	JWT

List Execution Outputs

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/outputs
Auth	JWT

List Execution Outputs by Type

Method	GET
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/outputs/type/{output-type}
Auth	JWT

Manage Execution Folders

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/execution-folders
Auth	JWT

Move Execution to Folder

Method	PUT
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/execution-summaries/{execution-id}/folder
Auth	JWT

Restore Execution

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/executions/{execution-id}/restore
Auth	JWT

Send Analysis to Queue

Method	POST
Endpoint URL	https://api.<tenant>.aplos-nca.com/v3/tenants/{tenant-id}/users/{user-id}/analysis/queue
Auth	JWT