canonical: https://jentic.com/apis/arpio.io/arpio

# Arpio API

The Arpio API drives cloud disaster recovery for AWS environments. An agent can manage protected accounts, configure sync pairs that replicate workloads into a recovery region, inspect application resources with their backup and restore status, run and review failover tests, and tune recovery point retention. It covers the protect, test, and recover lifecycle across accounts and the applications inside them.

## For AI agents

Manage AWS disaster recovery with Arpio: protected accounts, sync pairs, backup and restore status, failover tests, and retention. Secured with an API key or session cookie.

## Scope

Does not handle application performance monitoring or cost management - use it for AWS disaster recovery and backup only.

## Capabilities

- List and manage protected accounts
- Configure sync pairs for cross-region replication
- Inspect application resources with backup and restore status
- Run and review failover tests
- Tune recovery point retention settings

## Use cases

### Protect a cloud account

Bring an AWS account under disaster-recovery protection. The agent reads the account, confirms its entitlement, and sets up the sync pairs that replicate its workloads to a recovery region.

Example prompt: Call GET `/api/accounts` to list accounts, then GET `/api/accounts/{account_id}/syncPairs` to review replication

### Validate recovery readiness

Confirm that a protected environment can actually recover. The agent reviews recent failover test results so it can flag any environment whose last drill did not pass.

Example prompt: Call GET `/api/accounts/{account_id}/failoverTestResults` and surface any failed drill

### Audit backup coverage

Check which resources in an application are backed up and which can be restored. The agent lists the application's resources with their backup and restore status to spot gaps.

Example prompt: Call GET `/api/accounts/{account_id}/applications/{app_id}/resources/backup` to review coverage

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/api/accounts` | List accounts the authenticated subject can access |
| GET | `/api/accounts/{account_id}` | Get an account |
| PUT | `/api/accounts/{account_id}` | Update an account |
| DELETE | `/api/accounts/{account_id}` | Delete an account |
| GET | `/api/accounts/{account_id}/syncPairs` | List sync pairs |
| GET | `/api/accounts/{account_id}/failoverTestResults` | List failover test results |
| GET | `/api/accounts/{account_id}/applications/{app_id}/resources/backup` | List an application's resources with their backup status |
| GET | `/api/accounts/{account_id}/retention` | Get an account's recovery point retention settings |

## Key resources

- **Accounts** — AWS accounts protected by Arpio
- **Applications** — Protected applications and their resources inside an account
- **Sync Pairs** — Source and recovery region pairings that drive replication
- **Failover Tests** — Recovery drills and their recorded results
- **Retention** — Recovery point retention settings for an account

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 44 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 46 / 100
  - Developer Experience & Jentic Compatibility: 62 / 100
  - AI-Readiness & Agent Experience: 28 / 100
  - Agent Usability: 54 / 100
  - Security: 50 / 100
  - AI Discoverability: 60 / 100
- **View full report:** https://jentic.com/apis/arpio.io/arpio/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Arpio API by hand means obtaining an API key or session cookie, pointing at the api.arpio.io host, and shaping account and application requests yourself. Through Jentic you install once, import Arpio from the Jentic API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Arpio puts the account and application ids in the URL path (`/api/accounts/{account_id}`), so a rule can pin your agent to one account and nothing else. You choose which operations it may call, so state-changing ones like deleting an account or updating a sync pair are not included unless you add them.
- **Credential handling:** Your Arpio API key or ArpioSession cookie is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list protected accounts' or 'check failover test results', and Jentic returns the matching Arpio operation with its input schema so the agent calls the right endpoint without browsing the reference.

## Related APIs

- **AWS Backup** — Alternative AWS backup and recovery API
- **AWS Data Lifecycle Manager** — Complementary snapshot lifecycle API
- **Amazon EC2** — Complementary compute inventory API

## FAQ

### What authentication does the Arpio API use?

The Arpio API accepts an API key in the X-Api-Key header or an ArpioSession session cookie. Through Jentic the credential is stored encrypted in your Jentic One instance and injected at execution time, so the raw secret never enters the agent context. A few endpoints, such as the OpenAPI document, are public and need no credential.

### What can an agent do with the Arpio API?

It can manage protected accounts, configure sync pairs for cross-region replication, inspect application resources with their backup and restore status, run and review failover tests, and tune recovery point retention. Responses are structured so an agent can act on them directly.

### Can I run failover tests through the Arpio API?

Yes. The API records failover test results per account, so an agent can review recent drills and flag any environment whose last test did not pass.

### What are the rate limits for the Arpio API?

Rate limits are not specified in the OpenAPI spec. Check the Arpio documentation for current limits. Through Jentic, retries are handled in the execution layer.

### How many endpoints does the Arpio API have?

The Arpio API exposes 176 endpoints covering accounts, applications, sync pairs, failover tests, and retention.

### Can I limit what my agent is allowed to do with the Arpio API?

Yes. Jentic One is self-hosted by you, so your own rules decide which Arpio operations your agent may call. Because Arpio puts the account id in the URL path, such as `/api/accounts/{account_id}`, a rule can pin the agent to a single account and nothing else. You also choose which operations it may call, so destructive ones like DELETE `/api/accounts/{account_id}` to delete an account are excluded unless you add them.