Lexicon Garden

at.happyproto.server.listInstances

The caller's own instances. Customers only.

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

Showing version bafyreiejy46gwgwlkxedhjokyvphzumf3hovsww3j3ptzhzh5djyamogxe. Show the latest

Compare Edit in builder → Fork →

Query

query · GET

Output

application/json

instances

requiredarray
itemsref
Reference

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

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

InvalidRequest

The provisioner refused the request as malformed. Not expected from this read; declared because every provisioner refusal is mapped the same way.

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.

#availableVersion

object

A newer HappyView release the instance can upgrade to.

Properties

label

string

The HappyView version the release carries, e.g. 3.0.0-alpha.41, when known.

releasedAt

requiredstring · datetime

When HappyProto first offered it.

version

requiredstring

The release to pass to at.happyproto.server.upgradeInstance.

#instance

object

A customer's HappyView instance. Never carries the provisioner's placement or internal fields.

Properties

availableVersion

ref

A newer release, when one is on offer.

Reference

createdAt

requiredstring · datetime

id

requiredstring

A UUID.

operation

ref

The change in progress, if any.

Reference

plan

requiredstring

The plan's id.

slug

requiredstring

state

requiredstring
  • knownValues: provisioning | running | stopped | failed | deleting

url

requiredstring · uri

version

requiredstring

The HappyView release it runs.

versionLabel

string

The HappyView version the release carries, e.g. 3.0.0-alpha.41, when known.

#operation

object

Properties

error

string

The provisioner's error code, when it failed.

id

requiredstring

kind

requiredstring
  • knownValues: create | update | upgrade | stop | start | destroy

status

requiredstring
  • knownValues: pending | running | succeeded | failed

step

string

The step it last reached.

Similar lexicons

semantic match

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