at.happyproto.admin.listInstances

happyproto.at

Documentation

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

main query

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

Parameters

owner string did Optional

Only this owner's instances.

Output

Encodingapplication/json
instances array Required

No description available.

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.
Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
Only this owner's instances.
View raw schema 
{
  "description": "Every instance, whoever owns it, with its placement. Staff only.",
  "errors": [
    {
      "description": "This endpoint requires an authenticated caller.",
      "name": "AuthRequired"
    },
    {
      "description": "The caller is not HappyProto staff, or the provisioner does not treat them as staff.",
      "name": "Forbidden"
    },
    {
      "description": "owner is not a DID, or the provisioner refused the request as malformed.",
      "name": "InvalidRequest"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "NotFound"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "InvalidSlug"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "SlugTaken"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "NotEntitled"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "InstanceLimit"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "NoCapacity"
    },
    {
      "description": "Passed through from the provisioner.",
      "name": "OperationInProgress"
    },
    {
      "description": "The provisioner is unreachable, not configured, or answered with an error it does not explain to callers.",
      "name": "Upstream"
    }
  ],
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "instances": {
          "items": {
            "ref": "#adminInstance",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "instances"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "owner": {
        "description": "Only this owner's instances.",
        "format": "did",
        "type": "string"
      }
    },
    "type": "params"
  },
  "type": "query"
}
adminInstance object

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

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

desiredState string Required

The provisioner's desired_state.

hostId string Optional

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

hostName string Optional

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

id string Required

A UUID.

observedState string Required

The provisioner's observed_state.

operation ref #operation Optional

The change in progress, if any.

ownerDid string did Required

A decentralized identifier (DID).

plan string Required

The plan's id.

routed boolean Required

Whether its public URL routes to it.

slug string Required

No description available.

state string Required

No description available.

Known values: provisioning, running, stopped, failed, deleting
url string uri Required

A valid URI.

version string Required

The HappyView release it runs.

View raw schema 
{
  "description": "An instance as staff see it: the customer's view, plus its owner, placement and raw states.",
  "properties": {
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "desiredState": {
      "description": "The provisioner's desired_state.",
      "type": "string"
    },
    "hostId": {
      "description": "The host it is placed on. Absent until it is placed.",
      "type": "string"
    },
    "hostName": {
      "description": "That host's name. Absent when the hosts list does not have it.",
      "type": "string"
    },
    "id": {
      "description": "A UUID.",
      "type": "string"
    },
    "observedState": {
      "description": "The provisioner's observed_state.",
      "type": "string"
    },
    "operation": {
      "description": "The change in progress, if any.",
      "ref": "#operation",
      "type": "ref"
    },
    "ownerDid": {
      "format": "did",
      "type": "string"
    },
    "plan": {
      "description": "The plan's id.",
      "type": "string"
    },
    "routed": {
      "description": "Whether its public URL routes to it.",
      "type": "boolean"
    },
    "slug": {
      "type": "string"
    },
    "state": {
      "knownValues": [
        "provisioning",
        "running",
        "stopped",
        "failed",
        "deleting"
      ],
      "type": "string"
    },
    "url": {
      "format": "uri",
      "type": "string"
    },
    "version": {
      "description": "The HappyView release it runs.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "slug",
    "url",
    "plan",
    "version",
    "state",
    "createdAt",
    "ownerDid",
    "desiredState",
    "observedState",
    "routed"
  ],
  "type": "object"
}
operation object

No description available.

Properties

error string Optional

The provisioner's error code, when it failed.

id string Required

No description available.

kind string Required

No description available.

Known values: create, update, upgrade, stop, start, destroy
status string Required

No description available.

Known values: pending, running, succeeded, failed
step string Optional

The step it last reached.

View raw schema 
{
  "properties": {
    "error": {
      "description": "The provisioner's error code, when it failed.",
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "kind": {
      "knownValues": [
        "create",
        "update",
        "upgrade",
        "stop",
        "start",
        "destroy"
      ],
      "type": "string"
    },
    "status": {
      "knownValues": [
        "pending",
        "running",
        "succeeded",
        "failed"
      ],
      "type": "string"
    },
    "step": {
      "description": "The step it last reached.",
      "type": "string"
    }
  },
  "required": [
    "id",
    "kind",
    "status"
  ],
  "type": "object"
}

Lexicon Garden

@