at.happyproto.server.removeDomain

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

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · procedure
Kindprocedure
Authorityserver.happyproto.at
Indexed

Procedure

procedure · POST

Input

application/json

domainId

requiredstring

The domain's UUID.

idempotencyKey

requiredstring

A UUID the client generates once per intended change and resends on every retry of it, so a retry gets the original reply instead of acting twice.

instanceId

requiredstring

The instance's UUID.

Output

application/json

jobId

string

The background job following the routing change, when there was one. Poll it with at.happyproto.server.getJob.

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is not a HappyProto customer, or the provisioner refused them.

InvalidRequest

instanceId, domainId or idempotencyKey is not a UUID.

NotFound

No such instance or domain, or it is not the caller's. The cases are indistinguishable.

NotAvailable

Custom domains are not switched on yet.

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: the instance is already changing, or a request with this idempotencyKey is still running.

InvalidHostname

Passed through from the provisioner.

PlatformHostname

Passed through from the provisioner.

DomainExists

Passed through from the provisioner.

DomainLimit

Passed through from the provisioner.

TooSoon

Passed through from the provisioner.

DomainIsPrimary

The domain is the instance's primary. Make the platform subdomain primary first.

NotVerified

Passed through from the provisioner.

CertificateNotReady

Passed through from the provisioner.

VersionTooOld

Passed through from the provisioner.

Upstream

The provisioner is unreachable, not configured, or answered with an error it does not explain to callers, or the job could not be started.

Similar lexicons

semantic match

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