at.happyproto.server.getInstance

One of the caller's own instances. Customers only.

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

Details · query

Kind	query
Authority	server.happyproto.at
Indexed	11d ago · 2026-10-30

Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

id

requiredstring

The instance's UUID.

Output

application/json

instance

requiredref

Reference

#instance

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

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

InvalidRequest

id is not a UUID.

NotFound

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

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

#availableVersion

createdAt

requiredstring · datetime

id

requiredstring

A UUID.

operation

ref

The change in progress, if any.

Reference

#operation

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.

at.happyproto.server.listInstances
query

The caller's own instances. Customers only.
at.happyproto.admin.listInstances
query

Every instance, whoever owns it, with its placement. Staff only.
at.happyproto.server.upgradeInstance
procedure

Upgrade one of the caller's instances to the newer HappyView release its availableVersion offers, and start a job that follows the upgrade. The instance is offline for about 30 seconds; its database is snapshotted first, and a release that does not come up healthy is rolled back. Customers only.
at.happyproto.server.createInstance
procedure

Create an instance for the caller, and start a job that follows its provisioning. Customers only.
at.happyproto.server.updateInstance
procedure

Move one of the caller's instances to another plan or HappyView release, and start a job that follows the change. Customers only.