---
title: domains
description: ブランドの検証・取り込み用ドメインを管理する。
canonical_url: https://orchestor.io/docs/cli/domain
markdown_url: https://orchestor.io/docs/cli/domain.md
contentType: reference
---

# domains

`orc domains` は、ブランドに関連する検証・取り込み用Domainリソースを管理します。一覧・詳細・登録・更新・削除と、所有権検証の開始、状態確認、再確認を行います。`primary` と `alternate` のrole、検証状態、取り込み状態で一覧を絞れます。

認証と対象Workspaceへのアクセスが必要です。操作の `id` は一覧で返されたDomainリソースIDで、ホスト名ではありません。ブランドの `domain`・`domains` の登録とは別のリソースです。検証を開始する前に、保存された検証方法とtokenの公開手順を確認してください。

## 使い方

```bash title="terminal"
orc domains list --workspace <workspace-id>
```

*Domainリソースと検証状態を確認します。*

## サブコマンド

### `list`

削除されていないDomainを一覧します。`--brand-id`、`--role`、`--verification-status`、`--ingestion-status` は組み合わせて絞り込みます。cursorを続ける場合は条件を保持してください。

```bash title="terminal"
orc domains list [options]
```

#### 固有のオプション

##### `--brand-id`

Filter by brand id in the selected workspace. Omit to include domains or suggestions for all brands.

型: `string`。任意。

```bash title="terminal"
orc domains list --brand-id <value>
```

##### `--role`

Filter by the stored domain role. Omit to include both primary and alternate domains.; enum: primary|alternate

型: `string`。任意。

```bash title="terminal"
orc domains list --role <value>
```

##### `--verification-status`

Filter by the stored ownership verification state. Omit to include all states.; enum: unverified|pending|verified|failed

型: `string`。任意。

```bash title="terminal"
orc domains list --verification-status <value>
```

##### `--ingestion-status`

Filter by the stored ingestion state. Omit to include all states.; enum: not_configured|configured|active|error

型: `string`。任意。

```bash title="terminal"
orc domains list --ingestion-status <value>
```

### `create`

`domain` と現在のWorkspaceの `brand_id` が必須です。roleは既定で `alternate`、検証状態は `unverified` です。検証方法を設定するとtokenが作られますが、検証は開始しません。

```bash title="terminal"
orc domains create [options]
```

#### 固有のオプション

##### `--idempotency-key`

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: `string`。任意。

```bash title="terminal"
orc domains create --idempotency-key <value>
```

##### `--domain`

(required) Hostname stored for ownership verification and ingestion, without a protocol or path.

型: `string`。任意。

```bash title="terminal"
orc domains create --domain <value>
```

##### `--brand-id`

(required) Existing non-deleted brand in the selected workspace to which this domain belongs.

型: `string`。任意。

```bash title="terminal"
orc domains create --brand-id <value>
```

##### `--role`

Stored domain role: primary for the main domain, alternate for an additional domain. Defaults to alternate.; enum: primary|alternate

型: `string`。任意。

```bash title="terminal"
orc domains create --role <value>
```

##### `--verification-method`

Ownership check method: dns_txt publishes the token in DNS; file_upload serves it at /.well-known/orchestor-domain-verify; manual requires support. Null means no method is configured. Omitted or null leaves the method unconfigured.; enum: |dns_txt|file_upload|manual; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc domains create --verification-method <value>
```

##### `--ingestion-method`

Configured traffic ingestion method. Null means no method is selected. Omitted or null leaves the method unconfigured.; enum: |log_forwarder|edge_worker|manual_upload; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc domains create --ingestion-method <value>
```

#### 使用例

```bash title="terminal"
orc domains create --domain acme.example --brand-id <brand-id> --verification-method dns_txt --workspace <workspace-id>
```

*DNS検証用のDomainを登録する*

### `get`

Domain IDで詳細を取得します。tokenと検証手順は `verification get` から取得してください。不明・削除済み・Workspace外のIDは404です。

```bash title="terminal"
orc domains get <id> [options]
```

### `update`

指定した `role`、`verification_method`、`ingestion_method` だけを変更します。非nullの検証方法を指定すると、同じ方法でもtokenを再生成し `unverified` に戻ります。nullは方法を解除しますが、保存tokenと状態を保持します。検証は開始しません。

```bash title="terminal"
orc domains update <id> [options]
```

#### 固有のオプション

##### `--role`

Stored domain role: primary for the main domain, alternate for an additional domain. Omit to keep the stored value.; enum: primary|alternate

型: `string`。任意。

```bash title="terminal"
orc domains update <id> --role <value>
```

##### `--verification-method`

Ownership check method: dns_txt publishes the token in DNS; file_upload serves it at /.well-known/orchestor-domain-verify; manual requires support. Null means no method is configured. Omit to keep the stored value. A non-null value replaces the token and resets status to unverified. Null clears the method without clearing the existing token or status.; enum: |dns_txt|file_upload|manual; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc domains update <id> --verification-method <value>
```

##### `--ingestion-method`

Configured traffic ingestion method. Null means no method is selected. Omit to keep the stored value.; enum: |log_forwarder|edge_worker|manual_upload; (use "null" or "reset" to clear)

型: `string`。任意。

```bash title="terminal"
orc domains update <id> --ingestion-method <value>
```

### `delete`

Domainを論理削除し、`id` と `deleted: true` を返します。以後の一覧・取得から外れます。不明・削除済みIDは404です。

```bash title="terminal"
orc domains delete <id> [options]
```

### `verify`

保存済みの `verification_method` で非同期の所有権検証を開始します。方法が未設定なら400です。状態を `pending` にし、試行回数と以前のエラーをresetします。返された `poll_url` の状態を確認してください。

```bash title="terminal"
orc domains verify <id> [options]
```

#### 固有のオプション

##### `--idempotency-key`

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: `string`。任意。

```bash title="terminal"
orc domains verify <id> --idempotency-key <value>
```

#### 使用例

```bash title="terminal"
orc domains verify <domain-id> --workspace <workspace-id>
```

*token公開後に検証を開始する*

### `verification get`

保存された状態・token・方法別の手順を取得します。verified状態の最終確認が24時間より前なら、背景の再確認を要求する場合があります。`stale_recheck_enqueued` は要求済みの印で、完了の印ではありません。

```bash title="terminal"
orc domains verification get <id> [options]
```

#### 固有のオプション

##### `--idempotency-key`

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: `string`。任意。

```bash title="terminal"
orc domains verification get <id> --idempotency-key <value>
```

#### 使用例

```bash title="terminal"
orc domains verification get <domain-id> --workspace <workspace-id> --json
```

*tokenと公開手順を取得する*

### `verification refresh`

設定済みの方法と公開したtokenで所有権を再確認します。202と `poll_url` を返し、状態は `pending` になります。tokenを再公開する必要がある場合は先に手順を確認してください。

```bash title="terminal"
orc domains verification refresh <id> [options]
```

#### 固有のオプション

##### `--idempotency-key`

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: `string`。任意。

```bash title="terminal"
orc domains verification refresh <id> --idempotency-key <value>
```

### `verification recheck`

Recheck domain verification

```bash title="terminal"
orc domains verification recheck <id> [options]
```

#### 固有のオプション

##### `--idempotency-key`

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: `string`。任意。

```bash title="terminal"
orc domains verification recheck <id> --idempotency-key <value>
```

## 所有権検証の流れ

1. `create` または `update` で `verification_method` を設定します。方法は `dns_txt`、`file_upload`、`manual` です。
2. `verification get` のtokenと手順に従って、DNSやファイルを公開します。manualはサポートによる確認が必要です。
3. `verify` または `verification refresh` を実行します。受付応答は検証成功を意味しません。
4. `verification get` を繰り返し取得し、`verified` または `failed` の結果を確認します。

`verify` に方法を渡しても保存された設定を上書きしません。方法の変更は `update --verification-method` で行います。登録・検証設定だけで取り込みが稼働するとは限りません。取り込み方法は `log_forwarder`、`edge_worker`、`manual_upload` です。

## 必要な権限

対象Workspaceへのアクセスが必要です。変更操作には対応する書き込み権限が必要です。

## グローバルオプション

`orc domains` では、次の[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を使用できます。

- [`--help`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%98%E3%83%AB%E3%83%97)
- [`--workspace`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AF%E3%83%BC%E3%82%AF%E3%82%B9%E3%83%9A%E3%83%BC%E3%82%B9)
- [`--json`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B)
- [`--pretty`](https://orchestor.io/docs/cli/global-flags.md#json-%E5%87%BA%E5%8A%9B)
- [`--format`](https://orchestor.io/docs/cli/global-flags.md#%E5%87%BA%E5%8A%9B%E5%BD%A2%E5%BC%8F)
- [`--field`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA)
- [`--fields`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A3%E3%83%BC%E3%83%AB%E3%83%89%E3%81%AE%E6%8A%BD%E5%87%BA)
- [`--raw`](https://orchestor.io/docs/cli/global-flags.md#%E5%80%A4%E3%81%A0%E3%81%91%E3%82%92%E5%87%BA%E5%8A%9B)
- [`--output`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%95%E3%82%A1%E3%82%A4%E3%83%AB%E3%81%B8%E3%81%AE%E5%87%BA%E5%8A%9B)
- [`--no-pager`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%9A%E3%83%BC%E3%82%B8%E9%80%81%E3%82%8A)
- [`--dry-run`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E3%81%AE%E4%BA%8B%E5%89%8D%E7%A2%BA%E8%AA%8D)
- [`--yes`](https://orchestor.io/docs/cli/global-flags.md#%E7%A2%BA%E8%AA%8D%E3%81%AE%E7%9C%81%E7%95%A5)
- [`--limit`](https://orchestor.io/docs/cli/global-flags.md)
- [`--cursor`](https://orchestor.io/docs/cli/global-flags.md)
- [`--stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B)
- [`--from-stdin`](https://orchestor.io/docs/cli/global-flags.md#%E6%A8%99%E6%BA%96%E5%85%A5%E5%8A%9B)
- [`--page-all`](https://orchestor.io/docs/cli/global-flags.md#%E3%81%99%E3%81%B9%E3%81%A6%E3%81%AE%E3%83%9A%E3%83%BC%E3%82%B8%E3%82%92%E5%8F%96%E5%BE%97)
- [`--timing`](https://orchestor.io/docs/cli/global-flags.md#%E3%83%AA%E3%82%AF%E3%82%A8%E3%82%B9%E3%83%88%E6%99%82%E9%96%93)
- [`--readonly`](https://orchestor.io/docs/cli/global-flags.md#%E8%AA%AD%E3%81%BF%E5%8F%96%E3%82%8A%E5%B0%82%E7%94%A8%E3%83%A2%E3%83%BC%E3%83%89)
- [`--wrap-untrusted`](https://orchestor.io/docs/cli/global-flags.md#%E5%A4%96%E9%83%A8%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%81%AE%E7%9B%AE%E5%8D%B0%E4%BB%98%E3%81%91)

各オプションの詳細と使用例は、[グローバルオプション](https://orchestor.io/docs/cli/global-flags.md)を参照してください。

---

[Documentation index](https://orchestor.io/docs/llms.txt)