Repository navigation
HOST-2752: SLA API Documentation - #162
Open
robertfernandez-vast wants to merge 250 commits into
Open
robertfernandez-vast wants to merge 250 commits into
robertfernandez-vast wants to merge 250 commits into
Conversation
robertfernandez-vast
requested review from
agustin-vastai,
jsbcannell,
liam-at-vast,
michele-cloud and
stackanthony
July 7, 2026 04:30
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
robertfernandez-vast
force-pushed
the
HOST-2752-SLA-API-Documentation
branch
from
July 28, 2026 15:57
ab838e7 to
73c1583
Compare
robertfernandez-vast
force-pushed
the
HOST-2752-SLA-API-Documentation
branch
from
August 6, 2026 16:32
8abb9d2 to
457109c
Compare
robertfernandez-vast
force-pushed
the
HOST-2752-SLA-API-Documentation
branch
from
September 29, 2026 18:54
457109c to
c27cc74
Compare
robertfernandez-vast
force-pushed
the
HOST-2752-SLA-API-Documentation
branch
from
October 5, 2026 23:23
c27cc74 to
77a4a71
Compare
Register SLA pages in nav, align OpenAPI with listing/backtester endpoints, and fix clarity issues flagged across all-hosts review (confidence direction, broken links, jargon, onboarding gaps). Co-authored-by: Cursor <cursoragent@cursor.com>
Align create_asks error codes with production, add OpenAPI earnings fleet-scope note, choose-your-path routing, and merge duplicate FAQs. Co-authored-by: Cursor <cursoragent@cursor.com>
Clarify economics sign convention, console LIST step, dph_total, OpenAPI SLA CLI caveat, fleet backtest error handling, and webhook subscription key. Co-authored-by: Cursor <cursoragent@cursor.com>
Document console Save-then-LIST vs REST publish, host-centric economics tables, earnings rate limits, merge semantics, and maintenance webhooks. Co-authored-by: Cursor <cursoragent@cursor.com>
Fix API error shapes, UTC day-index docs, confidence/claim clarity, economics table wording, and host overview SLA publish steps. Co-authored-by: Cursor <cursoragent@cursor.com>
Fix confidence preset percentages, console step numbering, economics tail-risk cap, fleet listing workflow, and backtester error table. Co-authored-by: Cursor <cursoragent@cursor.com>
Clarify hourly vs daily premium framing, promote fleet listing section, fix setup URL consistency, and improve earnings API fleet guidance. Co-authored-by: Cursor <cursoragent@cursor.com>
Fix show machines jq path for partial updates, define dph_total early, and correct backtester economics walkthrough link. Co-authored-by: Cursor <cursoragent@cursor.com>
Extend show-machines OpenAPI for SLA read path, add search field mapping, fix daily vs window monitoring examples, uptime measurement, and hosting fixes. Co-authored-by: Cursor <cursoragent@cursor.com>
Tell SLA hosts that a 24-hour maintenance default is not full forgiveness, and that a CLI relist drops the SLA. Co-authored-by: Cursor <cursoragent@cursor.com>
Save SLA listing terms before an upgrade unlist, and stop the weekly earnings window on yesterday. Co-authored-by: Cursor <cursoragent@cursor.com>
Stop combining has_sla with expected_reliability in CLI search, and stop comparing a day's charge to fee times hours. Co-authored-by: Cursor <cursoragent@cursor.com>
Describe the Charges SLA row as one net amount, and stop the upgrade self-test from relisting before holds are back. Co-authored-by: Cursor <cursoragent@cursor.com>
Re-check rentals before a live fleet re-list, and stop the quick start from treating a missing SLA Fee line as hidden. Co-authored-by: Cursor <cursoragent@cursor.com>
Stop the fleet re-list on HTTP 403 sla_disabled, and relist only after the Docker holds are back. Co-authored-by: Cursor <cursoragent@cursor.com>
An extension checks the SLA fee only when the request includes SLA fields. Co-authored-by: Cursor <cursoragent@cursor.com>
The console cannot turn SLA off with 0, and every Save sends the listing end date. Co-authored-by: Cursor <cursoragent@cursor.com>
Relist after a Docker upgrade without opening SLA controls, and keep the console verify step for hosts who have no API key. Co-authored-by: Cursor <cursoragent@cursor.com>
A new machine has no SLA preview until it has rental history, and omitted disk still rents 10 GB. Co-authored-by: Cursor <cursoragent@cursor.com>
The fleet quota check was matching an error code the CLI never prints, and hosts were told to read an SLA fee the CLI cannot show. Co-authored-by: Cursor <cursoragent@cursor.com>
The outage relist was turning SLA back on with a partial body that resets storage price and auto-renew. Co-authored-by: Cursor <cursoragent@cursor.com>
Hosts were told to stay listed through maintenance, and to turn SLA on before destroying the test rental. Co-authored-by: Cursor <cursoragent@cursor.com>
show maints needs instance_read, and the post-outage self-test will not start while the machine is still rented. Co-authored-by: Cursor <cursoragent@cursor.com>
The outage relist was one paragraph, and the billing page pointed renters at the wrong bullet. Co-authored-by: Cursor <cursoragent@cursor.com>
The post-outage self-test stays blocked until the current rental ends, and show machines left out the fields those scripts read. Co-authored-by: Cursor <cursoragent@cursor.com>
show maints labels Vast-scheduled windows as admin_scheduled, and unlisting during an outage can leave SLA off until the rental ends. Co-authored-by: Cursor <cursoragent@cursor.com>
Meeting the SLA target is not a zero-credit day. Settlement still pays about half of that day's covered compute. Co-authored-by: Cursor <cursoragent@cursor.com>
Every page now uses the same settlement rule: a day on the target still pays about half of that day's covered compute. Co-authored-by: Cursor <cursoragent@cursor.com>
A day well above the target keeps most of the SLA fee, and the self-test key must include offer search. Co-authored-by: Cursor <cursoragent@cursor.com>
The renter page leads with how to turn SLA on, and break-even is named before the economics. Co-authored-by: Cursor <cursoragent@cursor.com>
A day above the host commitment can still fall below break-even, and the self-test examples use the packaged CLI. Co-authored-by: Cursor <cursoragent@cursor.com>
Unlisting for planned work drops the SLA ask, and listing does not check the self-test for you. Co-authored-by: Cursor <cursoragent@cursor.com>
The host checklist no longer repeats the scoped-key list, and a host-key search is not treated as proof that renters can see the offer. Co-authored-by: Cursor <cursoragent@cursor.com>
Turning SLA off points at the relist step, and cancel maint documents the admin_locked count the API returns. Co-authored-by: Cursor <cursoragent@cursor.com>
Maintenance forgiveness follows the window, not when a rental started, and the self-test can still run when a sliced machine has a rentable offer. Co-authored-by: Cursor <cursoragent@cursor.com>
robertfernandez-vast
force-pushed
the
HOST-2752-SLA-API-Documentation
branch
from
October 9, 2026 17:37
77a4a71 to
ecc1b82
Compare
robertfernandez-vast
changed the title
robertfernandez-vast
changed the title
This branch was successfully deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
HOST-2752: Host SLA API documentation
Branch:
HOST-2752-SLA-API-DocumentationBase:
origin/main(merge-base112323ba)Scope: Changes on the subject branch relative to
origin/main(git diff origin/main...HEAD).Summary
This branch adds host-facing documentation for SLA (Service Level Agreement) offers on Vast.ai: how hosts enable uptime guarantees, set pricing parameters, preview economics, list via console or REST, and monitor settlements. It introduces two new guide pages (
host/sla-offers,host/sla-backtester), extends OpenAPI for listing, backtesting, and earnings monitoring, and updates CLI/SDK snippets to state honestly that SLA flags are REST/console-only today.The work went through 12 iterative doc-review fix cycles after the initial draft. Latest multi-persona review reported no critical issues; remaining feedback is polish and edge-case clarity (sliced-machine search verification, client-facing SLA guide as a future follow-up).
Audience: Hosts (console-first and API automation). Risk: Documentation-only — no application code changes. Hosts should treat CLI/SDK SLA parameters as unavailable until tooling ships.
Details
Host guides (new)
/host/sla-offerscreate_asks, fleet listing, monitoring, common errors/host/sla-backtesterGET /api/v0/host/sla_backtest/— historical replay,worst_day_loss, fleet workflow, error responsesKey themes documented on SLA Offers:
PUT /api/v0/machines/create_asks/publishes in one request.sla_r_target,sla_r_claim,sla_sigma_x(and legacysla_reliability); validation bounds andinvalid_sla_params.dph_total, daily UTC settlement, asymmetric payout risk (worst_day_loss).GET /api/v0/users/{user_id}/machine-earnings/— useper_machine[].sla_earn; avoid fleet-wideper_day[].sla_earnfor single-machine checks.OpenAPI and API reference
PUT /api/v0/machines/create_asks/— SLA request fields,invalid_sla_params, 401 permission shape, 403machine_lockedGET /api/v0/host/sla_backtest/spec (sla_backtest.yaml)sla_earnonper_machine[]andper_day[]; fleet-scope note whenmachidis set--rawoutput for read-modify-write partial updatesmachine_readSynced monolithic
api-reference/openapi.yamlwith YAML sources underapi-reference/openapi/yaml/.Snippets and cross-links
snippets/host/cli/list-machine.mdxandsnippets/host/sdk/list-machine.mdx: SLA parameters marked not yet available in published CLI/SDK; point to console or REST.host/hosting-overview.mdx: SLA bullet, maintenance + SLA section, search/setup URL fixes, storageGBwording, FAQ grammar.docs.json: Nav entries forhost/sla-offersandhost/sla-backtester.API endpoints documented (REST)
PUT/api/v0/machines/create_asks/machine,sla_r_target,sla_r_claim,sla_sigma_x)GET/api/v0/host/sla_backtest/machine_id,r,p, optional date range)GET/api/v0/users/{user_id}/machine-earnings/machid,last_days,per_machine[].sla_earn)GET/api/v0/machines/show machines --raw)Files / areas touched
host/sla-offers.mdx(new),host/sla-backtester.mdx(new),host/hosting-overview.mdxopenapi.yaml,list_machine.yaml,sla_backtest.yaml,show_earnings.yaml,show_machines.yamlsnippets/host/cli/list-machine.mdx,snippets/host/sdk/list-machine.mdxdocs.json,api-reference/permissions.mdxTotal: 12 files, ~1,700 insertions, ~80 deletions.
Upgrade / rollout
create_asks/until CLI/SDK SLA support is released. API keys needmachine_write(listing),machine_read(backtester),billing_read(earnings).Commits
Newest first (
origin/main..HOST-2752-SLA-API-Documentation):302c873— docs(sla): address doc-review consensus (cycle 12)a6f228a— docs(sla): address doc-review consensus (cycle 11)150d8b7— docs(sla): address doc-review consensus (cycle 10)89be3c4— docs(sla): address doc-review consensus (cycle 9)db4003d— docs(sla): address doc-review consensus (cycle 8)b3ce882— docs(sla): address doc-review consensus (cycle 7)5f8d63a— docs(sla): address doc-review consensus (cycle 6)40ce178— docs(sla): address doc-review consensus (cycle 5)603e773— docs(sla): address doc-review consensus (cycle 4)cbfe3f5— docs(sla): address doc-review consensus (cycle 3)09f8084— docs(sla): address doc-review consensus (cycle 2)5078cdc— docs(sla): address doc-review consensus (cycle 1)50b9465— Address doc-review feedback for host SLA documentation.d66ac30— First draft for SLA documentation