# airdress.admin.*

{/* Generated by scripts/generate-event-reference.mjs from https://schemas.airdress.co/operator/events/v1.json (operator v0.1.138).
    Do not edit by hand: run `pnpm generate:event-reference` and commit the result. */}

The events in the `airdress.admin` family. How to read a section, and what
each audience means, is on the [event reference](/events/) page.

## `airdress.admin.credential_refused`

Owner warn

A request to the host-local admin listener did not carry the admin credential and was refused. `presented` says whether a wrong one was.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- Not functions bound to this operator's events: it is kept off that path as too frequent or too internal. A subscription with a function target still receives it.

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `path` | string | yes |  |
| `presented` | boolean | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "A request to the host-local admin listener did not carry the admin credential and was refused. `presented` says whether a wrong one was.",
  "properties": {
    "path": {
      "type": "string"
    },
    "presented": {
      "type": "boolean"
    }
  },
  "required": [
    "path",
    "presented"
  ],
  "title": "AdminCredentialRefused",
  "type": "object"
}
```

</details>

## `airdress.admin.credential_unavailable`

Owner error Functions

The admin credential could not be written under `dir`, so every admin TLS request is refused.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- **Functions bound to this operator's events** (`source: operator`).

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `dir` | string | yes |  |
| `error` | string | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "The admin credential could not be written under `dir`, so every admin TLS request is refused.",
  "properties": {
    "dir": {
      "type": "string"
    },
    "error": {
      "type": "string"
    }
  },
  "required": [
    "dir",
    "error"
  ],
  "title": "AdminCredentialUnavailable",
  "type": "object"
}
```

</details>

## `airdress.admin.not_started`

Owner error Functions

The admin listener was not started: its bind address is invalid, or (with `bind`) it could not be bound. The operator serves on without it.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- **Functions bound to this operator's events** (`source: operator`).

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `bind` | string or null | no |  |
| `error` | string | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "The admin listener was not started: its bind address is invalid, or (with `bind`) it could not be bound. The operator serves on without it.",
  "properties": {
    "bind": {
      "type": [
        "string",
        "null"
      ]
    },
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "title": "AdminNotStarted",
  "type": "object"
}
```

</details>

## `airdress.admin.peer_refused`

Owner warn

A request reached the admin listener from beyond loopback and was refused.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- Not functions bound to this operator's events: it is kept off that path as too frequent or too internal. A subscription with a function target still receives it.

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `peer` | string | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "A request reached the admin listener from beyond loopback and was refused.",
  "properties": {
    "peer": {
      "type": "string"
    }
  },
  "required": [
    "peer"
  ],
  "title": "AdminPeerRefused",
  "type": "object"
}
```

</details>

## `airdress.admin.stopped`

Owner error Functions

The admin listener stopped serving with an error.

**Audience: owner.** About the airdress as a whole. Only the owner receives it: the owner's devices and the owner's subscriptions.

**Where it goes**

- **The operator's journal**, as one log line at this level, and **the event log**, where `airdress events tail` reads it.
- **Subscriptions** that name it, within its audience.
- **Functions bound to this operator's events** (`source: operator`).

**Versions**

- Version 1: first carried by operator v0.1.138.

**Data**

| Field | Type | Required | Description |
| ----- | ---- | -------- | ----------- |
| `error` | string | yes |  |

<details>
<summary>JSON Schema</summary>

```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "description": "The admin listener stopped serving with an error.",
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "title": "AdminStopped",
  "type": "object"
}
```

</details>