POST /api/v1/hosts/pairings/lookup

Operation: lookupHostPairing.

Show the machine behind a pairing code (verified session)

Returns the installer’s report for a pending, unexpired code. Same session and guessing rules as approve; a wrong code counts as a miss (10 per hour per account and per address).

Endpoint

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

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.

Request body

Required body.

application/json

Field	Type	Presence	Description
user_code	string	Required

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

Responses

200

Pending pairing.

application/json

Field	Type	Presence	Description
summary	object	Required
expires_at	Rfc3339Utc	Required

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "summary",
    "expires_at"
  ],
  "properties": {
    "summary": {
      "type": "object"
    },
    "expires_at": {
      "$ref": "#/components/schemas/Rfc3339Utc"
    }
  }
}

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/lookup' \
  --header "Authorization: Bearer $AMPLERUN_API_KEY"

Schema definitions · Download OpenAPI · Authentication · Errors and recovery