at.happyproto.admin.cancelHostRequest

Cancel a host request and remove its server and volume. confirm must be the request's host name. Staff only.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority

Details · procedure

Kind	procedure
Authority	admin.happyproto.at
Indexed	12d ago · 2026-10-29

Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

confirm

requiredstring

The request's host name, typed by the member of staff.

maxLength: 63

id

requiredstring

A UUID.

idempotencyKey

requiredstring

A UUID. Repeating a request with the same key replays its answer.

Output

application/json

request

requiredref

Reference

at.happyproto.admin.defs#hostRequest

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is not HappyProto staff, or the provisioner does not treat them as staff.

InvalidRequest

The input was malformed, or the provisioner refused it as malformed.

NotFound

No such host request.

InvalidSlug

Passed through from the provisioner.

SlugTaken

Passed through from the provisioner.

NotEntitled

Passed through from the provisioner.

InstanceLimit

Passed through from the provisioner.

NoCapacity

Passed through from the provisioner.

OperationInProgress

Passed through from the provisioner.

NotRetryable

Only a failed request can be retried.

NotCancellable

A registered or cancelled request cannot be cancelled.

RequestInFlight

Another host request is under way.

ScalerNotConfigured

The provisioner has no GitHub App to start workflows with.

HostRegistered

The request's host already has a host row: retire it, or set it active and leave the request. The message says which.

ConfirmationMismatch

confirm is not the request's host name.

DispatchFailed

GitHub would not start the workflow. The request is unchanged.

Upstream

The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

at.happyproto.admin.getHostRequest
query

One host request with its timeline, oldest event first. Staff only.
at.happyproto.admin.retryHostRequest
procedure

Start a failed host request again. The workflow skips what already exists, so a retry never orders a second server. Staff only.
at.happyproto.admin.listHostRequests
query

The autoscaler's host requests, newest first, without their timelines. Staff only.
at.happyproto.server.deleteInstance
procedure

Delete one of the caller's instances, and start a job that follows the deletion. Customers only.
at.happyproto.server.removeDomain
procedure

Remove a custom domain from one of the caller's instances. HappyProto stops serving it. Customers only.