PUT /api/v1/hosts/machines/{id}/custom-images

Operation: setMachineCustomImages.

Opt this machine in or out of renter-supplied public images (host owner)

Default false: a machine that never opted in never receives a custom image. Opting in is 409 while the marketplace has custom images disabled; opting out always works and wins any reservation in flight. Custom images still run under the mandatory launch profile. Each change is audited.

Endpoint

PUT https://amplerun-api.spiry.org/api/v1/hosts/machines/{id}/custom-images

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
id	path	Required	UUID
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
accept	boolean	Required

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "accept"
  ],
  "properties": {
    "accept": {
      "type": "boolean"
    }
  }
}

Responses

200

Current opt-in.

application/json

Field	Type	Presence	Description
machine_id	UUID	Required
accepts_custom_images	boolean	Required

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "machine_id",
    "accepts_custom_images"
  ],
  "properties": {
    "machine_id": {
      "$ref": "#/components/schemas/UUID"
    },
    "accepts_custom_images": {
      "type": "boolean"
    }
  }
}

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 PUT 'https://amplerun-api.spiry.org/api/v1/hosts/machines/{id}/custom-images' \
  --header "Authorization: Bearer $AMPLERUN_API_KEY"

Schema definitions · Download OpenAPI · Authentication · Errors and recovery