at.happyproto.server.listDeployments

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

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

Query

query · GET

Parameters

query string

cursor

string

The cursor a previous page returned.

id

requiredstring

The instance's UUID.

limit

integer
  • minimum: 1
  • maximum: 100
  • default: 20

Output

application/json

cursor

string

Pass as cursor for the next page. Absent on the last page.

deployments

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

id is not a UUID, limit is outside 1 to 100, or cursor is not one this method returned.

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.

#change

object

What the change was for.

Properties

plan

ref

The plan, for a resize.

Reference

reason

string

Why an update ran, when it was not a plan or version change.

  • knownValues: retry | drift | domains | primary | primary_forced

The HappyView release, for an upgrade.

Reference

#deployment

object

One change to an instance: a provisioner operation. Never carries the host, a staff member's identity, or an error message not written for the owner.

Properties

change

requiredref
Reference

createdAt

requiredstring · datetime
Reference

finishedAt

string · datetime

id

requiredstring

The change's UUID.

isDeployment

requiredboolean

Whether the change started the instance's container. Stopping, deleting, and domain-only updates are not deployments.

kind

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

requestedBy

requiredstring

Who asked: the instance's owner, HappyProto staff, or HappyProto's own reconciler.

  • knownValues: owner | staff | system

startedAt

string · datetime

When a worker last picked it up.

status

requiredstring
  • knownValues: pending | running | succeeded | failed

#error

object

Properties

code

requiredstring

The provisioner's error code.

message

string

Present only for codes whose message is written for the owner.

#fromTo

object

A value before and after the change. Either side is absent when unknown.

Properties

from

string

to

string

Similar lexicons

semantic match

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