# at.happyproto.admin.listInstances

> Published by [happyproto.at](https://lexicon.garden/identity/did:plc:mo7vq4jbioxwafy5zkcc3eux)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.admin.listInstances)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.admin.listInstances/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mo7vq4jbioxwafy5zkcc3eux/at.happyproto.admin.listInstances/examples)

## Definitions

### `at.happyproto.admin.listInstances#adminInstance`

**Type**: `object`

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

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `createdAt` | `string` (datetime) | Yes |  |
| `desiredState` | `string` | Yes | The provisioner's desired_state. |
| `hostId` | `string` | No | The host it is placed on. Absent until it is placed. |
| `hostName` | `string` | No | That host's name. Absent when the hosts list does not have it. |
| `id` | `string` | Yes | A UUID. |
| `observedState` | `string` | Yes | The provisioner's observed_state. |
| `operation` | `ref` → `#operation` | No | The change in progress, if any. |
| `ownerDid` | `string` (did) | Yes |  |
| `plan` | `string` | Yes | The plan's id. |
| `routed` | `boolean` | Yes | Whether its public URL routes to it. |
| `slug` | `string` | Yes |  |
| `state` | `string` | Yes |  |
| `url` | `string` (uri) | Yes |  |
| `version` | `string` | Yes | The HappyView release it runs. |

### `at.happyproto.admin.listInstances`

**Type**: `query`

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

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `owner` | `string` (did) | No | Only this owner's instances. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `instances` | `array` | Yes |  |

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

### `at.happyproto.admin.listInstances#operation`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `error` | `string` | No | The provisioner's error code, when it failed. |
| `id` | `string` | Yes |  |
| `kind` | `string` | Yes |  |
| `status` | `string` | Yes |  |
| `step` | `string` | No | The step it last reached. |

## Raw Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "adminInstance": {
      "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"
    },
    "main": {
      "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"
    },
    "operation": {
      "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"
    }
  },
  "id": "at.happyproto.admin.listInstances",
  "lexicon": 1
}
```