com.publicdomainrelay.temp.gateway.requestComputeVM

Request a VM through the compute contract gateway. Gateway builds cloud-init from sshPublicKey, creates compute.vm and market.rfp records, discovers bidders, runs the full RFP protocol, submits accept, and verifies the receipt. Returns receipt refs and websocatUrl for SSH access.

Details · procedure
Kindprocedure
Authoritygateway.temp.publicdomainrelay.com
Indexed

Procedure

procedure · POST

Input

application/json

Seconds to wait for bids before picking a winner.

  • default: 30

computeVm

requiredref

Compute VM specification (cpus, mem, disk, network, role). user_data is populated by the gateway from sshPublicKey.

Program to execute over SSH after VM is ready.

  • default: "bash"

Additional bidder DIDs beyond relay discovery.

itemsstring · did

keepVm

boolean

Skip VM teardown after contract completion.

  • default: true

Fulfillment policy mode for bidder selection.

  • enum: only_me | direct_network | policy_based

skipSsh

boolean

Skip SSH session after contract. When true, returns immediately after receipt.

  • default: true

sshPublicKey

requiredstring

OpenSSH public key for root SSH access to the VM.

Seconds to wait for SSH readiness after provisioning.

Output

application/json

bids

array
itemsobject

error

string

receiptCid

string · cid

receiptOk

boolean

receiptUri

string · at-uri

rfpCid

string · cid

rfpUri

string · at-uri

sshReady

boolean

vmFqdn

string

websocatUrl

string · uri

winnerBidCid

string · cid

winnerBidUri

string · at-uri

winnerDid

string · did

Errors

InvalidRequest

No description in schema.

AuthRequired

No description in schema.

NoBidders

No description in schema.

ProvisioningFailed

No description in schema.