​

domains

orc domains manages Domain resources used for brand verification and ingestion. List, inspect, create, update, or delete domains, start ownership checks, inspect status, and request rechecks. Filter lists by the primary or alternate role, verification state, or ingestion state.

Authentication and access to the target Workspace are required. The id is the Domain resource ID returned by listing, not a hostname. This is separate from a brand’s domain and domains registry. Check the saved verification method and token-publication instructions before starting verification.

Inspect Domain resources and verification status.

List non-deleted Domains. Combine --brand-id, --role, --verification-status, and --ingestion-status to filter results. Preserve filters while following cursors.

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

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

domain and a brand_id in the current Workspace are required. Role defaults to alternate, and verification starts as unverified. Setting a verification method creates a token but does not start verification.

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.

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

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

Type: string. Optional.

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)

Type: string. Optional.

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)

Type: string. Optional.

Register a Domain for DNS verification

Retrieve details by Domain ID. Use verification get for the token and instructions. Missing, deleted, or out-of-Workspace IDs return 404.

Change only supplied role, verification_method, and ingestion_method. A non-null verification method regenerates the token and resets status to unverified, even if unchanged. Null clears the method but retains the stored token and state. Verification does not start.

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

Type: string. Optional.

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)

Type: string. Optional.

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)

Type: string. Optional.

Soft-delete a Domain and return id and deleted: true. Subsequent lists and reads exclude it. Missing or deleted IDs return 404.

Start asynchronous ownership verification using the saved verification_method. An unset method returns 400. Status becomes pending, and attempts and previous errors are reset. Check status through the returned poll_url.

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.

Type: string. Optional.

Start verification after publishing the token

Retrieve saved status, token, and method-specific instructions. A verified Domain checked more than 24 hours ago may enqueue a background recheck. stale_recheck_enqueued indicates a request, not completion.

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.

Type: string. Optional.

Retrieve the token and publication instructions

Request another ownership check with the configured method and published token. Return 202 and poll_url, with status set to pending. Check instructions first if the token needs to be republished.

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.

Type: string. Optional.

Recheck domain verification

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.

Type: string. Optional.

Passing a method to verify does not override saved settings. Change it with update --verification-method. Registration and verification settings alone do not guarantee active ingestion. Ingestion methods are log_forwarder, edge_worker, and manual_upload.

Access to the target Workspace is required. Changes require the corresponding write permissions.

The following global options can be used with orc domains:

For details and examples, see global options.