Lexicon Garden

at.happyproto.admin.listInstances

Every instance, whoever owns it, with its placement. Staff only.

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

Showing version bafyreicilgnrkvcujsfuvrnlpxy4fdrvcut3fydzoojhtdarmzwru7f5gy. Show the latest

Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

owner

string · did

Only this owner's instances.

Output

application/json

instances

requiredarray
itemsref
Reference

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

owner is not a DID, or the provisioner refused the request as malformed.

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.

#adminInstance

object

An instance as staff see it: the customer's view, plus its owner, placement and raw states.

Properties

availableVersion

ref

A newer release, when one is on offer.

Reference

createdAt

requiredstring · datetime

desiredState

requiredstring

The provisioner's desired_state.

encryptionStage

string

Where its encryption key is in a rotation: none, rotating (the new key is not live yet), sealing (HappyView is re-sealing with it), retiring (the old key is being removed) or failed (a rotate_key or retire_key failed and the instance with it). From the provisioner's database alone.

  • knownValues: none | rotating | sealing | retiring | failed

hostId

string

The host it is placed on. Absent until it is placed.

hostName

string

That host's name. Absent when the hosts list does not have it.

id

requiredstring

A UUID.

observedState

requiredstring

The provisioner's observed_state.

operation

ref

The change in progress, if any.

Reference

ownerDid

requiredstring · did

plan

requiredstring

The plan's id.

routed

requiredboolean

Whether its public URL routes to it.

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.

#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.

#operation

object

Properties

error

string

The provisioner's error code, when it failed.

id

requiredstring

kind

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

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.