# social.colibri.beta.server.describeServer

> Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.server.describeServer)
- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.server.describeServer/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.server.describeServer/examples)

## Definitions

### `social.colibri.beta.server.describeServer`

**Type**: `query`

Gets information about this AppView.

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `did` | `string` (did) | Yes | The AppView's own identity. |
| `pds` | `string` (uri) | Yes | The PDS communities are created on. |
| `flavor` | `string` | Yes | Which build of the software this is. 'vanilla' for the stock AppView, and any string a fork or a customised deployment chooses for itself. |
| `contact` | `string` | No | How to reach the operator. |
| `version` | `string` | Yes | The running software version. |
| `features` | `array` | No | Optional features this AppView supports. |
| `software` | `string` | Yes | Stable software identifier, always 'colibri-appview'. Clients key on this to confirm a host is a Colibri AppView before pointing themselves at it. |
| `spaceTypes` | `array` | No | The space types this AppView understands. |
| `handleDomain` | `string` | Yes | The domain community handles are minted under. |

## Raw Schema

```json
{
  "id": "social.colibri.beta.server.describeServer",
  "defs": {
    "main": {
      "type": "query",
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "did",
            "software",
            "flavor",
            "version",
            "handleDomain",
            "pds"
          ],
          "properties": {
            "did": {
              "type": "string",
              "format": "did",
              "description": "The AppView's own identity."
            },
            "pds": {
              "type": "string",
              "format": "uri",
              "description": "The PDS communities are created on."
            },
            "flavor": {
              "type": "string",
              "description": "Which build of the software this is. 'vanilla' for the stock AppView, and any string a fork or a customised deployment chooses for itself."
            },
            "contact": {
              "type": "string",
              "description": "How to reach the operator."
            },
            "version": {
              "type": "string",
              "description": "The running software version."
            },
            "features": {
              "type": "array",
              "items": {
                "type": "string",
                "description": "A feature identifier.",
                "knownValues": [
                  "voice",
                  "push",
                  "gifs",
                  "embeds"
                ]
              },
              "description": "Optional features this AppView supports."
            },
            "software": {
              "type": "string",
              "description": "Stable software identifier, always 'colibri-appview'. Clients key on this to confirm a host is a Colibri AppView before pointing themselves at it."
            },
            "spaceTypes": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "nsid",
                "description": "A space type."
              },
              "description": "The space types this AppView understands."
            },
            "handleDomain": {
              "type": "string",
              "description": "The domain community handles are minted under."
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Gets information about this AppView."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
