POST /api/v1/hosts/pairings/approve

Operation: approveHostPairing.

Approve a pairing code (verified session, or an API key with the host scope)

The consent step of one-line host onboarding. Applies the same hosting rules as createEnrollmentToken (verified email, host scope, admin block, new-host cap; the first use turns hosting on). go_live (default true) lists the machine’s seeded offer, unverified, on its first healthy heartbeat through the same path as listMachine with x-accept-unverified, paid-admission guard included. Audited. Wrong codes are limited as in lookup.

Endpoint

POST https://amplerun-api.spiry.org/api/v1/hosts/pairings/approve

Authentication

Use the credential and scope required by this operation. For programmatic renter/host calls: Authorization: Bearer $AMPLERUN_API_KEY. A host-agent signature or other specialized proof is required where the description specifies it.

Parameters

Name	Location	Presence	Type	Description
Idempotency-Key	header	Required	UUID	UUID scoped to authenticated principal, route and canonical request hash.

Request body

Required body.

application/json

Field	Type	Presence	Description
user_code	string	Required
go_live	boolean	Optional

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "user_code"
  ],
  "properties": {
    "user_code": {
      "type": "string",
      "maxLength": 32
    },
    "go_live": {
      "type": "boolean",
      "default": true
    }
  }
}

Responses

200

Approved.

application/json

Field	Type	Presence	Description
approved	schema	Required
go_live	boolean	Required
summary	object	Required

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "approved",
    "go_live",
    "summary"
  ],
  "properties": {
    "approved": {
      "const": true
    },
    "go_live": {
      "type": "boolean"
    },
    "summary": {
      "type": "object"
    }
  }
}

default

Error envelope. 401 unauthenticated, 403/404 forbidden, 409 conflict, 422 invalid input, 429 rate limited (code UNAVAILABLE, retryable:true, no Retry-After header), 503 unavailable money/provider state with retryable:true.

application/json

Field	Type	Presence	Description
error	object	Required

{
  "$ref": "#/components/schemas/ErrorEnvelope"
}

Static request outline

Replace path/query placeholders and provide the required JSON body, headers and credential from the sections above. This is a request outline, not a command that chooses an amount or starts a rental for you.

curl --request POST 'https://amplerun-api.spiry.org/api/v1/hosts/pairings/approve' \
  --header "Authorization: Bearer $AMPLERUN_API_KEY"

Schema definitions · Download OpenAPI · Authentication · Errors and recovery