Documentation

Welcome to PurgeOps docs

PurgeOps is an autonomous AWS cost agent: connect read-only IAM, scan continuously, risk-score findings, and execute low-risk purges while you ship. These guides cover setup, concepts, and integrations — no sales deck required.

In this guide

Quick start

Sign up, launch the CloudFormation stack from the connect flow, and confirm the IAM role ARN. PurgeOps validates permissions and queues an initial scan automatically.

# After connect, trigger on-demand scan (Starter+ plans)
curl -X POST https://api.purgeops.com/v1/scans \
  -H "Authorization: Bearer $PURGEOPS_API_KEY"

Connect AWS

Use the quick-launch template — read-only by default. Execute permissions are scoped to approved purge actions only.

First scan

First results typically land in under four minutes. Findings appear in the activity feed with monthly waste estimates.

Ask-the-Agent chat

Open the Ask-the-Agent panel from your dashboard once you've connected an AWS account. The agent reads scan status, findings, and savings from your account, answers follow-up questions, and can propose approve/reject actions for your confirmation — powered by Claude Sonnet 5 with tool-calling.

Risk tiers

Low, medium, and high map to autonomous execution, batch approval, and human review. Configure per rule in Settings.

Rules & auto-approve

Each resource type has default heuristics. Toggle auto-approve for low-risk classes you trust.

Activity feed

Every detect, approve, and purge streams to the dashboard feed and optional Slack webhooks.

Reversibility

Snapshots and retention windows apply where AWS allows rollback. High-risk actions always require explicit approval.

AWS IAM setup

External ID, least-privilege policy documents, and org-wide stack sets for multi-account roll-out.

Slack webhooks

Incoming webhook URL in Settings → Notifications. Events: findings, approvals, completed purges.

Terraform provider

Manage IAM bootstrap and notification channels as code — provider docs ship with the connect wizard.

GitHub (soon)

PR comments and deployment gates for cost findings — on the Q4 roadmap.

API keys

Create keys in Settings → API. Bearer auth for scans, findings, and webhook management.

Webhooks

Signed payloads for finding.created, purge.completed, and scan.finished events.

CLI (soon)

Local CLI for CI triggers and bulk approve — coming after GA.

Rate limits

Tier-based on-demand scan quotas. API: 120 req/min per key on Pro and above.

Plans & billing

See pricing on the homepage or manage subscription in the billing portal.

Multi-account org roll-out

StackSet deployment from the management account with consistent external ID per linked account.

SSO/SAML

Enterprise SSO via SAML 2.0 — contact us for IdP metadata and seat provisioning.