API Overview

Programmatic access to AnomalyArmor data observability features

AnomalyArmor provides a REST API for programmatic access to data observability features. This enables automation, CI/CD integration, and custom tooling.

Base URL

https://api.anomalyarmor.ai/api/v1

Authentication

All API requests require authentication via API key. Include your key in the Authorization header:

curl -H "Authorization: Bearer aa_live_your_key_here" \
  https://api.anomalyarmor.ai/api/v1/assets

Create API keys in Settings > API Keys or via CLI: armor api-keys create

Rate Limiting

Rate limits are enforced per API key based on your subscription tier:

Tier	Rate Limit	Burst
Free Trial	20 req/min	2 req/sec
Starter	30 req/min	3 req/sec
Growth	500 req/min	25 req/sec
Professional	1,000 req/min	50 req/sec
Enterprise	5,000 req/min	100 req/sec

Rate Limit Headers

Every response includes rate limit information:

X-RateLimit-Limit: 500
X-RateLimit-Remaining: 499
X-RateLimit-Reset: 1701705600

When rate limited, you’ll receive a 429 response with Retry-After header.

Pagination

All list endpoints use offset/limit pagination:

GET /api/v1/assets?limit=50&offset=100

Response includes pagination metadata:

{
  "data": [...],
  "pagination": {
    "total": 245,
    "limit": 50,
    "offset": 100,
    "has_more": true
  }
}

Error Responses

Errors return a consistent JSON structure:

{
  "error": {
    "code": "ASSET_NOT_FOUND",
    "message": "Asset not found",
    "details": {
      "asset_id": "snowflake.prod.warehouse.orders",
      "suggestion": "Check the qualified name format: source.database.schema.table"
    }
  }
}

Error Codes

Code	HTTP Status	Description
ASSET_NOT_FOUND	404	Asset doesn’t exist or not accessible
UNAUTHORIZED	401	Invalid or missing API key
FORBIDDEN	403	Valid key but insufficient scope
RATE_LIMITED	429	Too many requests
VALIDATION_ERROR	400	Invalid request parameters
INTERNAL_ERROR	500	Server error

Quick Start

Python SDK

from anomalyarmor import Client

# Initialize with API key
client = Client(api_key="aa_live_xxx")

# List assets
assets = client.assets.list(source="snowflake", limit=10)
for asset in assets:
    print(asset.qualified_name)

# Check freshness (raises StalenessError if stale)
client.freshness.require_fresh("snowflake.prod.warehouse.orders")

Available Endpoints

Assets

List and retrieve data assets

Freshness

Monitor and check data freshness

Schema

Track schema changes and drift

Lineage

Explore data dependencies

Alerts

Query alert history and status

Authentication

API key management

Data Quality APIs

Metrics

Track row counts, null rates, and data trends

Validity

Enforce NOT NULL, UNIQUE, REGEX, and custom rules

Referential Checks

Verify foreign key relationships

Next Steps

SDK Quickstart

Get started with the Python SDK

CLI Reference

Command-line interface guide

Airflow Integration

Use with Apache Airflow