at.happyproto.server.getInstance Documentation (EN)

main query

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

Parameters

id string Required

The instance's UUID.

Output

Encodingapplication/json

instance ref#instance Required

No description available.

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.

Try It

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

Service Endpoint Base URL for XRPC calls (e.g., https://api.bsky.social)

Parameters

id * The instance's UUID.

View raw schema

{
  "description": "One of the caller's own instances. Customers only.",
  "errors": [
    {
      "description": "This endpoint requires an authenticated caller.",
      "name": "AuthRequired"
    },
    {
      "description": "The caller is not a HappyProto customer, or the provisioner refused them.",
      "name": "Forbidden"
    },
    {
      "description": "id is not a UUID.",
      "name": "InvalidRequest"
    },
    {
      "description": "No such instance, or it is not the caller's. The two are indistinguishable.",
      "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": {
        "instance": {
          "ref": "#instance",
          "type": "ref"
        }
      },
      "required": [
        "instance"
      ],
      "type": "object"
    }
  },
  "parameters": {
    "properties": {
      "id": {
        "description": "The instance's UUID.",
        "type": "string"
      }
    },
    "required": [
      "id"
    ],
    "type": "params"
  },
  "type": "query"
}

instance object

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

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

id string Required

A UUID.

operation ref #operation Optional

The change in progress, if any.

plan string Required

The plan's id.

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": "A customer's HappyView instance. Never carries the provisioner's placement or internal fields.",
  "properties": {
    "createdAt": {
      "format": "datetime",
      "type": "string"
    },
    "id": {
      "description": "A UUID.",
      "type": "string"
    },
    "operation": {
      "description": "The change in progress, if any.",
      "ref": "#operation",
      "type": "ref"
    },
    "plan": {
      "description": "The plan's id.",
      "type": "string"
    },
    "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"
  ],
  "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"
}