at.happyproto.server.listInstances

The caller's own instances. Customers only.

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

Details · query

Kind	query
Authority	server.happyproto.at
Indexed	22d ago · 2026-10-19

Showing version bafyreigokij3ivzwakee4hobjzdzblwxfvcllfdt5j27r6tlwp5nhpyyaq. Show the latest

Compare Edit in builder → Fork →

Query

query · GET

Output

application/json

instances

requiredarray

itemsref

Reference

#instance

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.

#instance

object

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

Properties

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.

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

One of 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.listDeployments
query

The changes made to one of the caller's own instances, newest first, a page at a time. Customers only.
at.happyproto.server.listPlans
query

The plans a new or changed instance can use. Customers only.
at.happyproto.server.createInstance
procedure

Create an instance for the caller, and start a job that follows its provisioning. Customers only.