Skip to content

POST /api/v1/hosts/enrollment-tokens

Operation: createEnrollmentToken.

Host enrollment token (verified host account)

One-use 10-minute token plus signed release URL/digest and preflight steps. Rate-limited independently.

POST https://amplerun-api.spiry.org/api/v1/hosts/enrollment-tokens

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.

NameLocationPresenceTypeDescription
Idempotency-KeyheaderRequiredUUIDUUID scoped to authenticated principal, route and canonical request hash.

Enrollment material.

application/json

FieldTypePresenceDescription
tokenstringRequired
expires_atRfc3339UtcRequired
release_urlstringRequired
release_digestSha256HashRequired
preflight_stepsarray of stringRequired
{
"type": "object",
"additionalProperties": false,
"required": [
"token",
"expires_at",
"release_url",
"release_digest",
"preflight_steps"
],
"properties": {
"token": {
"type": "string"
},
"expires_at": {
"$ref": "#/components/schemas/Rfc3339Utc"
},
"release_url": {
"type": "string"
},
"release_digest": {
"$ref": "#/components/schemas/Sha256Hash"
},
"preflight_steps": {
"type": "array",
"items": {
"type": "string"
}
}
}
}

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

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

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.

Terminal window
curl --request POST 'https://amplerun-api.spiry.org/api/v1/hosts/enrollment-tokens' \
--header "Authorization: Bearer $AMPLERUN_API_KEY"

Schema definitions · Download OpenAPI · Authentication · Errors and recovery

Official AmpleRun documentation · Contract v3 · Generated from the API contract · Revision 52fe29de · Open AmpleRun · View Markdown · For agents