List usage threshold alerts

GET

https://api.dsx-air.nvidia.com/api/v3/ucp/alerts/

List the usage threshold alerts registered for the authenticated user’s organization. Each alert records a remaining-balance threshold (in compute hours) at which UCP will fire a webhook so Air can email the configured recipients. Air admins and SREs see alerts across all orgs. Results are searchable by creator, org_display_name, ngc_org_name, org_nca_id, and threshold, and orderable by created, modified, last_fired, or threshold.

Required role: air_org_admin

List the usage threshold alerts registered for the authenticated user's organization. Each alert records a remaining-balance threshold (in compute hours) at which UCP will fire a webhook so Air can email the configured recipients. Air admins and SREs see alerts across all orgs. Results are searchable by `creator`, `org_display_name`, `ngc_org_name`, `org_nca_id`, and `threshold`, and orderable by `created`, `modified`, `last_fired`, or `threshold`. **Required role:** `air_org_admin`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

limitintegerOptional

Number of results to return per page.

offsetintegerOptional

The initial index from which to return the results.

orderingenumOptional

Order objects by field. Prefix with - for descending order.

searchstringOptional

Search by creator, org_display_name, ngc_org_name, org_nca_id, or threshold.

Response

countinteger

resultslist of objects

nextstring or nullOptionalformat: "uri"

previousstring or nullOptionalformat: "uri"

Errors

400

Bad Request Error

403

Forbidden Error

500

Internal Server Error