# com.publicdomainrelay.temp.gateway.requestComputeVM

> Published by [johnandersen777.bsky.social](https://lexicon.garden/identity/did:plc:5svqtrhheairglgiiyvutzik)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:5svqtrhheairglgiiyvutzik/com.publicdomainrelay.temp.gateway.requestComputeVM)
- [Documentation](https://lexicon.garden/lexicon/did:plc:5svqtrhheairglgiiyvutzik/com.publicdomainrelay.temp.gateway.requestComputeVM/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:5svqtrhheairglgiiyvutzik/com.publicdomainrelay.temp.gateway.requestComputeVM/examples)

## Definitions

### `com.publicdomainrelay.temp.gateway.requestComputeVM`

**Type**: `procedure`

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.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `keepVm` | `boolean` | No | Skip VM teardown after contract completion. |
| `skipSsh` | `boolean` | No | Skip SSH session after contract. When true, returns immediately after receipt. |
| `computeVm` | `ref` → `com.publicdomainrelay.temp.compute.vm` | Yes | Compute VM specification (cpus, mem, disk, network, role). user_data is populated by the gateway from sshPublicKey. |
| `policyMode` | `string` | No | Fulfillment policy mode for bidder selection. |
| `execProgram` | `string` | No | Program to execute over SSH after VM is ready. |
| `bidWindowSec` | `integer` | No | Seconds to wait for bids before picking a winner. |
| `sshPublicKey` | `string` | Yes | OpenSSH public key for root SSH access to the VM. |
| `extraBidderDids` | `array` | No | Additional bidder DIDs beyond relay discovery. |
| `vmReadyTimeoutSec` | `integer` | No | Seconds to wait for SSH readiness after provisioning. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `bids` | `array` | No |  |
| `error` | `string` | No |  |
| `rfpCid` | `string` (cid) | No |  |
| `rfpUri` | `string` (at-uri) | No |  |
| `vmFqdn` | `string` | No |  |
| `sshReady` | `boolean` | No |  |
| `receiptOk` | `boolean` | No |  |
| `winnerDid` | `string` (did) | No |  |
| `receiptCid` | `string` (cid) | No |  |
| `receiptUri` | `string` (at-uri) | No |  |
| `sshExitCode` | `integer` | No |  |
| `websocatUrl` | `string` (uri) | No |  |
| `winnerBidCid` | `string` (cid) | No |  |
| `winnerBidUri` | `string` (at-uri) | No |  |
| `winnerBidConfig` | `unknown` | No |  |

#### Errors

- **InvalidRequest**
- **AuthRequired**
- **NoBidders**
- **ProvisioningFailed**

## Raw Schema

```json
{
  "id": "com.publicdomainrelay.temp.gateway.requestComputeVM",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "computeVm",
            "sshPublicKey"
          ],
          "properties": {
            "keepVm": {
              "type": "boolean",
              "default": true,
              "description": "Skip VM teardown after contract completion."
            },
            "skipSsh": {
              "type": "boolean",
              "default": true,
              "description": "Skip SSH session after contract. When true, returns immediately after receipt."
            },
            "computeVm": {
              "ref": "com.publicdomainrelay.temp.compute.vm",
              "type": "ref",
              "description": "Compute VM specification (cpus, mem, disk, network, role). user_data is populated by the gateway from sshPublicKey."
            },
            "policyMode": {
              "enum": [
                "only_me",
                "direct_network",
                "policy_based"
              ],
              "type": "string",
              "description": "Fulfillment policy mode for bidder selection."
            },
            "execProgram": {
              "type": "string",
              "default": "bash",
              "description": "Program to execute over SSH after VM is ready."
            },
            "bidWindowSec": {
              "type": "integer",
              "default": 30,
              "description": "Seconds to wait for bids before picking a winner."
            },
            "sshPublicKey": {
              "type": "string",
              "description": "OpenSSH public key for root SSH access to the VM."
            },
            "extraBidderDids": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "did"
              },
              "description": "Additional bidder DIDs beyond relay discovery."
            },
            "vmReadyTimeoutSec": {
              "type": "integer",
              "description": "Seconds to wait for SSH readiness after provisioning."
            }
          }
        },
        "encoding": "application/json"
      },
      "errors": [
        {
          "name": "InvalidRequest"
        },
        {
          "name": "AuthRequired"
        },
        {
          "name": "NoBidders"
        },
        {
          "name": "ProvisioningFailed"
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "properties": {
            "bids": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "cost": {
                    "type": "integer"
                  },
                  "bidUri": {
                    "type": "string",
                    "format": "at-uri"
                  },
                  "bidderDid": {
                    "type": "string",
                    "format": "did"
                  }
                }
              }
            },
            "error": {
              "type": "string"
            },
            "rfpCid": {
              "type": "string",
              "format": "cid"
            },
            "rfpUri": {
              "type": "string",
              "format": "at-uri"
            },
            "vmFqdn": {
              "type": "string"
            },
            "sshReady": {
              "type": "boolean"
            },
            "receiptOk": {
              "type": "boolean"
            },
            "winnerDid": {
              "type": "string",
              "format": "did"
            },
            "receiptCid": {
              "type": "string",
              "format": "cid"
            },
            "receiptUri": {
              "type": "string",
              "format": "at-uri"
            },
            "sshExitCode": {
              "type": "integer"
            },
            "websocatUrl": {
              "type": "string",
              "format": "uri"
            },
            "winnerBidCid": {
              "type": "string",
              "format": "cid"
            },
            "winnerBidUri": {
              "type": "string",
              "format": "at-uri"
            },
            "winnerBidConfig": {
              "type": "unknown"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "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."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```