# lol.dids.manage.getDomain

> Published by [ngerakines.me](https://lexicon.garden/identity/did:plc:cbkjy5n7bk3ax2wplmtjofq2)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:cbkjy5n7bk3ax2wplmtjofq2/lol.dids.manage.getDomain)
- [Documentation](https://lexicon.garden/lexicon/did:plc:cbkjy5n7bk3ax2wplmtjofq2/lol.dids.manage.getDomain/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:cbkjy5n7bk3ax2wplmtjofq2/lol.dids.manage.getDomain/examples)

## Definitions

### `lol.dids.manage.getDomain`

**Type**: `query`

Everything the caller needs during onboarding for one domain: its registration state, the DNS records to publish, the last verification result, and the certificate state. The single endpoint an authoring tool polls.

#### Parameters

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `domain` | `string` | Yes | The registered hostname. |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `tls` | `ref` → `lol.dids.defs#tlsView` | Yes |  |
| `domain` | `ref` → `lol.dids.defs#domainView` | Yes |  |
| `records` | `array` | Yes | The DNS records the registration asks for, exactly as register returned them. |
| `verification` | `ref` → `lol.dids.defs#verificationView` | Yes |  |

#### Errors

- **DomainNotFound**: No registration for that domain belongs to the caller.

## Raw Schema

```json
{
  "id": "lol.dids.manage.getDomain",
  "defs": {
    "main": {
      "type": "query",
      "errors": [
        {
          "name": "DomainNotFound",
          "description": "No registration for that domain belongs to the caller."
        }
      ],
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "domain",
            "records",
            "verification",
            "tls"
          ],
          "properties": {
            "tls": {
              "ref": "lol.dids.defs#tlsView",
              "type": "ref"
            },
            "domain": {
              "ref": "lol.dids.defs#domainView",
              "type": "ref"
            },
            "records": {
              "type": "array",
              "items": {
                "ref": "lol.dids.defs#dnsInstruction",
                "type": "ref"
              },
              "description": "The DNS records the registration asks for, exactly as register returned them."
            },
            "verification": {
              "ref": "lol.dids.defs#verificationView",
              "type": "ref"
            }
          }
        },
        "encoding": "application/json"
      },
      "parameters": {
        "type": "params",
        "required": [
          "domain"
        ],
        "properties": {
          "domain": {
            "type": "string",
            "maxLength": 253,
            "description": "The registered hostname."
          }
        }
      },
      "description": "Everything the caller needs during onboarding for one domain: its registration state, the DNS records to publish, the last verification result, and the certificate state. The single endpoint an authoring tool polls."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
