at.happyproto.server.checkSlug

Whether a slug can be used for a new instance. Customers only. An invalid or reserved slug is answered without asking the provisioner.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityserver.happyproto.at
Indexed

Query

query · GET

Parameters

query string

slug

requiredstring

Output

application/json

available

requiredboolean

reason

string

Why not, when it is not available.

  • knownValues: invalid | reserved | taken

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

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

InvalidRequest

slug is missing.

NotFound

Passed through from the provisioner.

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.

Upstream

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