{"uid":"cap_Zt9erYPAVHVsmSyWJrOuC","slug":"hyrule-cloud-vm-create-db2c5aaf","name":"Hyrule Cloud VM Create","description":"Hyrule Cloud is pay-per-use infrastructure for AI agents on AS215932: IPv6-native compute, outbound requests over Direct, Tor, I2P, or Yggdrasil, BGP/routing intelligence, IP/ASN intelligence, DNS diagnostics, blocklist membership checks, filtering evidence, RDAP/WHOIS registry lookups, web and deep TLS checks, mail deliverability, outside-in port reachability, NAT port-forward checks, VoIP/SIP diagnostics. Calls settle in USDC via x402. Domain registration is deferred from this launch catalog. This OpenAPI document contains the launch-ready, independently payable agent surface plus the free supporting routes (quotes, status polling, pricing, template catalog) required to complete those workflows.","url":"https://cloud.hyrule.host/v1/vm/create?utm_source=zero.xyz","method":"POST","headers":{},"bodySchema":{"type":"object","properties":{"os":{"type":"string","title":"Os","default":"debian-13","description":"OS template name"},"size":{"enum":["xs","sm","md","lg"],"type":"string","title":"VMSize","default":"xs","description":"VM size tier"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain","default":null,"description":"Domain to register (required when domain_mode=custom)"},"quote_id":{"anyOf":[{"type":"string","maxLength":36},{"type":"null"}],"title":"Quote Id","default":null,"description":"Optional durable quote id from POST /v1/vm/quote. When set, the server provisions the spec stored on the quote at the quote-locked price; the rest of this body must match that stored spec. Omit for the legacy compute-price-from-body flow."},"resources":{"anyOf":[{"type":"object","title":"VMOrderResources","required":["vcpu","ram_mb","disk_gb"],"properties":{"vcpu":{"type":"integer","title":"Vcpu","exclusiveMinimum":0},"ram_mb":{"type":"integer","title":"Ram Mb","exclusiveMinimum":0},"disk_gb":{"type":"integer","title":"Disk Gb","exclusiveMinimum":0}},"description":"Requested final resources; validated against the live catalog server-side."},{"type":"null"}],"default":null,"description":"Optional exact final resources. New orders support 1-4 vCPU, 1-8 GiB RAM, and 10-40 GB SSD. The server selects the cheapest compatible base profile."},"open_ports":{"type":"array","items":{"type":"integer"},"title":"Open Ports","description":"Inbound TCP ports to allow (22 always included)"},"ssh_pubkey":{"type":"string","title":"Ssh Pubkey","description":"SSH public key for root access (ed25519 or rsa)"},"domain_mode":{"enum":["auto","custom"],"type":"string","title":"DomainMode","default":"auto"},"setup_script":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Setup Script","default":null,"description":"Optional shell script to execute after boot via cloud-init"},"duration_days":{"type":"integer","title":"Duration Days","maximum":365,"minimum":1,"description":"Hosting duration in days"}}},"responseSchema":{"type":"json","example":{"vm_id":"vm_a1b2c3d4e5f6","status":"provisioning","status_url":"/v1/vm/vm_a1b2c3d4e5f6/status"}},"example":null,"exampleRequest":null,"tags":["x402"],"displayCostAmount":"0.2","displayCostAsset":"USDC","priceDynamic":false,"priceHint":null,"priceStatus":"priced","priceSource":"probe","requiresHandshake":false,"reviewCount":0,"rating":{"score":"0.00","successRate":"0.00","reviews":0,"stars":null,"state":"unrated"},"availabilityStatus":"unknown","priceObserved":null,"sessionDeposit":null,"pricing":{"kind":"static","summary":"$0.2/call","primary":{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.2","per":"call","confidence":"exact"},"accepted":[{"kind":"static","protocol":"x402","network":"base","amountUsd":"0.2","per":"call","confidence":"exact"}]},"paymentMethods":[{"uid":"pm_3o_z7jh-zN56HtFpogOVX","protocol":"x402","methodType":"crypto","chain":"base","mode":"charge","costAmount":"0.2","costPer":"request","priority":0,"asset":"0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913","unit":"request","depositMicros":null,"planRef":null}],"brandName":null,"brandSlug":null,"brandBaseUrl":null,"brandDocsUrl":null,"whatItDoes":"Provisions a bare virtual machine with SSH access on IPv6-native infrastructure, billed per-use in USDC via x402","exampleAgentPrompt":"Spin up a small Debian 13 VM for 3 days with port 80 and 443 open, using my SSH key ssh-ed25519 AAAA...mykey, and run this setup script after boot to install nginx.","exampleUseCases":null,"resultDescription":"Returns details of the newly provisioned VM including IP address, hostname, SSH access credentials, assigned domain, and provisioning status.","failureModes":["Invalid or missing SSH public key — VM cannot be created without valid key","Invalid OS template name — returns 400 with list of supported templates","Duration out of range (must be 1–365 days) — returns 422 validation error","Invalid VM size tier — must be one of xs, sm, md, lg","quote_id provided but body spec does not match stored quote — returns 409 conflict","Insufficient USDC balance or x402 payment failure — returns 402 Payment Required","Custom domain_mode specified without domain field — returns 422 validation error","Setup script too large or malformed — may fail post-boot silently or with error"],"whenToPreferThis":"Choose this endpoint when you need a disposable or short-lived bare VM with SSH access billed pay-per-use in USDC, especially when you want IPv6-native infrastructure, no subscription commitment, or need to route traffic over Tor, I2P, or Yggdrasil via the Hyrule Cloud ecosystem.","instructions":null,"reviewSummary":null,"reviewSummaryHighlights":null,"reviewSummaryConcerns":null,"reviewSummaryGeneratedAt":null,"activationCount":0,"lastUsedAt":null,"lastSuccessfullyRanAt":null,"lastHealthCheckAt":"2026-10-27T18:30:18.951Z","isFirstParty":false,"canonicalSlug":"hyrule-cloud-vm-create-db2c5aaf"}