# AmpleRun Hosts API

**Canonical:** https://apis.io/apis/amplerun-com/amplerun-com-hosts-api/  
**Provider:** AmpleRun — https://apis.io/providers/amplerun-com/  
**Base URL:** https://amplerun-api.spiry.org  
**Documentation:** https://docs.amplerun.com/reference/api/

AmpleRun Hosts API is one of 10 APIs that [AmpleRun](https://apis.io/providers/amplerun-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. This API exposes 6 JSON Schema definitions. Tagged areas include Hosts. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

Machines, offers, telemetry, earnings and payouts for hosts. Host scope.

## Operations (20)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/hosts/enrollment-tokens` | Host enrollment token (verified host account) |
| POST | `/api/v1/hosts/pairings` | Open a host pairing (installer; unauthenticated) |
| POST | `/api/v1/hosts/pairings/lookup` | Show the machine behind a pairing code (verified session) |
| POST | `/api/v1/hosts/pairings/approve` | Approve a pairing code (verified session, or an API key with the host scope) |
| POST | `/api/v1/hosts/pairings/poll` | Poll a pairing (installer; needs poll_secret) |
| GET | `/api/v1/hosts/machines` | List own machines (host owner/admin) |
| GET | `/api/v1/hosts/machines/{id}` | Machine detail: compatibility findings, current offer/job, observed metrics… |
| DELETE | `/api/v1/hosts/machines/{id}` | Remove an idle machine registration, preserving history |
| GET | `/api/v1/hosts/machines/{id}/telemetry` | Rolling telemetry history in 5-minute buckets (host owner/admin) |
| POST | `/api/v1/hosts/machines/{id}/offer` | Publish versioned future offer (host owner) |
| PATCH | `/api/v1/hosts/machines/{id}/offer` | Edit the listing by publishing the next offer version (host owner) |
| GET | `/api/v1/hosts/machines/{id}/earnings` | Per-machine earnings day-series (host owner) |
| POST | `/api/v1/hosts/machines/{id}/list` | List machine (host owner); admission checks apply |
| POST | `/api/v1/hosts/machines/{id}/drain` | Drain machine (host owner); stops new bookings, never kills an active job or… |
| POST | `/api/v1/hosts/machines/{id}/unlist` | Unlist idle offer (host owner); never kills an active job or retrieval cleanup |
| POST | `/api/v1/hosts/machines/{id}/nettest` | Re-run the network measurement (host owner/admin); queues a NETTEST command… |
| PUT | `/api/v1/hosts/machines/{id}/custom-images` | Opt this machine in or out of renter-supplied public images (host owner) |
| GET | `/api/v1/hosts/earnings` | Earnings (host owner): earned, disputed, payable, requested, settled; gross vs… |
| GET | `/api/v1/hosts/market` | Market stats (host): per-GPU-model supply, listed-rate band, fill rate and… |
| POST | `/api/v1/hosts/payouts` | Request a payout to an address (host owner; same model as withdrawals) |

## Machine-readable artifacts (7)

- **OpenAPI** — https://artifacts.apis.io/amplerun-com/openapi/amplerun-com-hosts-api-openapi.yml
- **JSONSchema** — https://artifacts.apis.io/amplerun-com/json-schema/amplerun-com-offer-summary-schema.json
- **JSONSchema** — https://artifacts.apis.io/amplerun-com/json-schema/amplerun-com-deposit-address-schema.json
- **JSONSchema** — https://artifacts.apis.io/amplerun-com/json-schema/amplerun-com-template-schema.json
- **JSONSchema** — https://artifacts.apis.io/amplerun-com/json-schema/amplerun-com-job-schema.json
- **JSONSchema** — https://artifacts.apis.io/amplerun-com/json-schema/amplerun-com-quote-schema.json
- **JSONSchema** — https://artifacts.apis.io/amplerun-com/json-schema/amplerun-com-telemetry-sample-schema.json

## Other AmpleRun APIs (9)

- [AmpleRun Account API](https://apis.io/apis/amplerun-com/amplerun-com-account-api/)
- [AmpleRun Admin API](https://apis.io/apis/amplerun-com/amplerun-com-admin-api/)
- [AmpleRun Agents API](https://apis.io/apis/amplerun-com/amplerun-com-agents-api/)
- [AmpleRun Billing API](https://apis.io/apis/amplerun-com/amplerun-com-billing-api/)
- [AmpleRun Catalog API](https://apis.io/apis/amplerun-com/amplerun-com-catalog-api/)
- [AmpleRun Health API](https://apis.io/apis/amplerun-com/amplerun-com-health-api/)
- [AmpleRun Jobs API](https://apis.io/apis/amplerun-com/amplerun-com-jobs-api/)
- [AmpleRun Support API](https://apis.io/apis/amplerun-com/amplerun-com-support-api/)
- [AmpleRun Wallets API](https://apis.io/apis/amplerun-com/amplerun-com-wallets-api/)

## Tags

Hosts

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/amplerun-com/amplerun-com-hosts-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/amplerun-com/.