Repository navigation
Host 2752 sla api documentation - #162
Open
robertfernandez-vast wants to merge 140 commits into
Open
robertfernandez-vast wants to merge 140 commits into
robertfernandez-vast wants to merge 140 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
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
Document console Save-then-LIST vs REST publish, host-centric economics tables, earnings rate limits, merge semantics, and maintenance webhooks. Co-authored-by: Cursor <[email protected]>
Fix API error shapes, UTC day-index docs, confidence/claim clarity, economics table wording, and host overview SLA publish steps. Co-authored-by: Cursor <[email protected]>
Fix confidence preset percentages, console step numbering, economics tail-risk cap, fleet listing workflow, and backtester error table. Co-authored-by: Cursor <[email protected]>
Clarify hourly vs daily premium framing, promote fleet listing section, fix setup URL consistency, and improve earnings API fleet guidance. Co-authored-by: Cursor <[email protected]>
Fix show machines jq path for partial updates, define dph_total early, and correct backtester economics walkthrough link. Co-authored-by: Cursor <[email protected]>
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 <[email protected]>
Fix SLA opt-in phrasing, fleet listing read-modify-write pattern, UTC monitoring dates, and confidence preset wording. Co-authored-by: Cursor <[email protected]>
Add claim headroom guidance, reframe confidence presets, fix search verification jq, and warn against copying backtester p into sla_sigma_x. Co-authored-by: Cursor <[email protected]>
Require ALLOWLIST before fleet DRY_RUN=0 so paused machines stay unlisted. Co-authored-by: Cursor <[email protected]>
Align Create Instance vs target_reliability, rent body required fields, and dph_total in the CLI table. Co-authored-by: Cursor <[email protected]>
Clarify CLI create-instance vs SLA RENT and pin the UTC day-index example to a unix timestamp. Co-authored-by: Cursor <[email protected]>
Keep dph_total as a --raw sort field, not a search query key, and rephrase interruptible SLA coverage. Co-authored-by: Cursor <[email protected]>
Point renter credit reconciliation at the real CLI charges command, not a nonexistent show charges. Co-authored-by: Cursor <[email protected]>
Echo per_machine sla_earn in the host key recipe and label the renter scoped-key recipe consistently. Co-authored-by: Cursor <[email protected]>
Clarify that instance verify is not billing credits, and drop informal encyclopedia wording on permissions. Co-authored-by: Cursor <[email protected]>
Point earnings poll limits at Show Earnings OpenAPI, keep console SLA off the permissions encyclopedia, and lead search-offers with examples. Co-authored-by: Cursor <[email protected]>
Collapse overlapping console-leave routing on the permissions page into one table. Co-authored-by: Cursor <[email protected]>
Align Reliability target with Search filters, harden fleet backtest success checks, and expand show-earnings SLA examples. Co-authored-by: Cursor <[email protected]>
Clarify earnings poll wording, SLA-before-LIST checklist order, and Normal-confidence fleet backtest p. Co-authored-by: Cursor <[email protected]>
Add show-earnings rate-limit guidance, map fleet backtest p from sla_sigma_x, and align bundles search defaults with CLI. Co-authored-by: Cursor <[email protected]>
Add a copy-paste sday/eday earnings example and a host jump link ahead of the renter key recipe. Co-authored-by: Cursor <[email protected]>
Add a host jump link ahead of the renter scoped-key recipe on permissions. Co-authored-by: Cursor <[email protected]>
Harden fleet backtest r validation, link CLI --storage to channel defaults, and clarify Save vs LIST and Destroy paths. Co-authored-by: Cursor <[email protected]>
Harden 429 rent recovery, use relative maintenance start times, and note CLI vs REST gpu_ram units. Co-authored-by: Cursor <[email protected]>
Guard fleet end_date, align CLI search defaults, clarify Search filters vs CLI, and harden backtester fleet hygiene. Co-authored-by: Cursor <[email protected]>
Align REST search defaults with CLI, clarify console verify vs billing, and fix Tight/p label plus relative backtester dates. Co-authored-by: Cursor <[email protected]>
Fix post-rent verify anchors, add --storage to host verify examples, and link overview to checklist/risk. Co-authored-by: Cursor <[email protected]>
Align fleet 429 prose with illustrative scripts, clarify REST earnings params, and fix host self-verify / permissions framing. Co-authored-by: Cursor <[email protected]>
Merge duplicate invalid_args rows, clarify REST vs CLI rented defaults, and tighten host/renter recipe routing. Co-authored-by: Cursor <[email protected]>
Fix permissions/search-offers ≥3/8 nits, surface host SLA early, and move earnings curls out of Warning. Co-authored-by: Cursor <[email protected]>
Co-authored-by: Cursor <[email protected]>
Fix USER_ID sourcing for billing_read keys, link checklist verify to jq filter, and add Destroy guidance for stuck rentals. Co-authored-by: Cursor <[email protected]>
Gate first LIST until checklist step 7, split console vs CLI verify, and align Profile-first user_id guidance. Co-authored-by: Cursor <[email protected]>
Match OpenAPI sla_backtest trailing slash and clarify SLA query vs response-only fields. Co-authored-by: Cursor <[email protected]>
Clarify console vs CLI filter carry-over, move self-test after LIST, and reword client-side API filtering. Co-authored-by: Cursor <[email protected]>
Use portable jq for fleet backtest r validation and clarify Save vs LIST checklist order. Co-authored-by: Cursor <[email protected]>
robertfernandez-vast
force-pushed
the
HOST-2752-SLA-API-Documentation
branch
from
October 5, 2026 23:23
c27cc74 to
77a4a71
Compare
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