Skip to main content
The SDK’s full typed surface lives on npm as @anomalyarmor/sdk and in-source as typedoc-generated reference pages.

​
Live reference

The canonical reference is generated from TypeScript source on every release and hosted on GitHub Pages:

Open the typedoc reference

Full type signatures for every exported symbol

​
Ergonomic surface

If you just want a quick lookup table, here are the hand-written wrappers. For anything not listed, drop down to client.raw and use the generated OpenAPI paths type directly - see How requests work.

​
client.health

MethodBacking endpoint
check()GET /api/v1/health

​
client.alerts

MethodBacking endpoint
overview()GET /api/v1/alerts/overview
history(params?)GET /api/v1/alerts/history
inbox()GET /api/v1/alerts/inbox
get(alertId)GET /api/v1/alerts/{alert_id}
acknowledge(alertId, notes?)POST /api/v1/alerts/{alert_id}/acknowledge
resolve(alertId, notes?)POST /api/v1/alerts/{alert_id}/resolve

​
client.freshness

MethodBacking endpoint
check(assetId)GET /api/v1/assets/{asset_id}/freshness
getTable(assetId, tablePath)GET /api/v1/assets/{asset_id}/freshness/{table_path}
checkTable(assetId, tablePath)POST /api/v1/assets/{asset_id}/freshness/{table_path}/check

​
client.schema

MethodBacking endpoint
listChanges(assetId)GET /api/v1/schema-drift/assets/{asset_id}/changes
getChange(assetId, changeId)GET /api/v1/schema-drift/assets/{asset_id}/changes/{change_id}
baselineStatus(assetId)GET /api/v1/schema-drift/assets/{asset_id}/baseline-status
detectChanges(assetId)POST /api/v1/schema-drift/assets/{asset_id}/detect-changes

​
Exported types

import type {
  AnomalyArmorClient,
  AnomalyArmorClientOptions,
  AlertsResource,
  FreshnessResource,
  SchemaResource,
  HealthResource,
  // Raw OpenAPI types for advanced callers:
  paths,
  components,
  operations,
} from '@anomalyarmor/sdk';

import { createAnomalyArmorClient, AnomalyArmorApiError, DEFAULT_BASE_URL } from '@anomalyarmor/sdk';

​
Source

The SDK source lives in the AnomalyArmor core monorepo. Bug reports, feature requests, and PRs welcome at github.com/anomalyarmor/core/issues.