Lexicon Garden

at.happyproto.server.getDeployment

One change to one of the caller's own instances, with its steps. Customers only.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityserver.happyproto.at
Indexed
Compare Edit in builder → Fork →

Query

query · GET

Parameters

query string

deploymentId

requiredstring

The change's UUID, as listDeployments returns it.

id

requiredstring

The instance's UUID.

Output

application/json

deployment

requiredref
Reference

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

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

InvalidRequest

id or deploymentId is not a UUID.

NotFound

No such instance or change, or either is not the caller's, or the change belongs to another instance. These 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

version

ref

The HappyView release, for an upgrade.

Reference

#deploymentView

object

A change with its steps.

Properties

change

requiredref
Reference

createdAt

requiredstring · datetime

error

ref
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

steps

requiredarray

In the order they ran.

itemsref
Reference

#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

#step

object

Properties

at

requiredstring · datetime

detail

string

Why the step failed, present only when the change's error code is one written for the owner.

name

requiredstring
  • knownValues: apply | healthy | stopped | owner | route | dns | store | domain | remove | rollback

status

requiredstring
  • knownValues: succeeded | failed

Similar lexicons

semantic match

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