Air APIAPI ReferenceUcp

Retrieve a usage threshold alert

View as Markdown

Retrieve a single usage threshold alert by its UCP alert_id. Scoped to the authenticated org; Air admins and SREs may retrieve alerts belonging to any org.

Required role: air_org_admin

Authentication

AuthorizationBearer

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

Path parameters

alert_idstringRequiredformat: "uuid"

Response

alert_idstringRead-onlyformat: "uuid"
The UUID UCP assigned to the alert when it was registered.
alert_typeenum

The UCP webhook event this alert is registered for.

  • USAGE_REMAINING_ALERT - USAGE_REMAINING_ALERT
  • USAGE_GRANT_THRESHOLD_REACHED - USAGE_GRANT_THRESHOLD_REACHED
  • USAGE_GRANT_EXHAUSTED - USAGE_GRANT_EXHAUSTED
  • CONTRACT_ENDED - CONTRACT_ENDED
thresholdintegerRead-only
Remaining balance in compute hours at which UCP will fire the webhook back to Air.
recipientslist of strings

Email addresses notified when UCP fires the webhook. Providing a value on update overwrites the existing recipients rather than appending to them; to add a new recipient include the existing recipients in the request as well.

last_fireddatetime or nullRead-only
When Air last dispatched an email for this alert, or null if it has never fired.
creatorstringRead-only
Email of the client that registered this alert.
org_display_namestringRead-only
Display name of the organization this alert belongs to.
ngc_org_namestringRead-only
NGC org name of the organization this alert belongs to.
org_nca_idstringRead-only
NCA id of the organization this alert belongs to.
createddatetimeRead-only
modifieddatetimeRead-only

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error