uip insights export-configurations

Syntax and options for `uip insights export-configurations`, which lists an organization's Insights unified export configurations and checks their destinations.

uip insights export-configurations reads the organization's Insights unified export configurations and has Insights check their destinations. The rows cover the export configurations of every tenant in the organization and the organization-level audit-log export.

Note:

These commands require the organization administrator role, not an Insights tenant role. The unified export routes are behind the unifiedExportAPI feature flag. When the Insights Portal does not serve them, the commands fail with a ConfigError.

Synopsis

uip insights export-configurations list [-l <n>] [-o <n>]
uip insights export-configurations verify [configuration-id]

These commands honor the global options and the standard exit codes.

uip insights export-configurations list

List the organization's unified export configurations. Rows never carry a stored connection string, AWS secret access key, or API key. Custom header values are shown as [redacted]. Every other destination field is shown as stored.

Options

Flag	Description
-l, --limit <number>	Maximum rows to return. Defaults to 50.
-o, --offset <number>	Rows to skip before returning results.

The backend does not paginate this list, so every --offset page repeats the whole backend request.

Example

uip insights export-configurations list

Data shape (--output json)

Every row has these fields:

Field	Description
Id	Export configuration ID (integer). Pass it to verify.
TenantId	Tenant the configuration is stored under.
ExportProtocol	Export protocol.
DataSources	Data sources the configuration exports.
DestinationType	AzureEventHub, AwsSqs, IsDatabricks, GenericEndpoint, or Arize.
CreatedAt	Creation timestamp.

Rows also carry the fields of their destination type:

DestinationType	Extra fields
AzureEventHub	None.
AwsSqs	AccessKeyId, QueueUrl, Region
GenericEndpoint	Url, HasApiKey, CustomHeaders
Arize	Url, SpaceId, ProjectName, CustomHeaders
IsDatabricks	ConnectionId, TableName

HasApiKey only says whether an API key is stored. A row with a destination type the installed CLI version does not know shows only the shared fields. Update the CLI to see its destination fields.

The command returns Code: "InsightsExportConfigurationsList". An empty list is a successful result, not an error.

uip insights export-configurations verify

Have Insights test export destinations with the credentials it has stored. Insights probes Azure Event Hub and AWS SQS destinations only. Other destination types are not probed. Nothing is exported and nothing is written.

Arguments

Name	Required	Purpose
[configuration-id]	no	Export configuration ID (integer), from list. Omit it to check every configuration except Splunk HEC rows and rows Insights has not migrated.

Examples

# Check every configuration
uip insights export-configurations verify

# Check one configuration
uip insights export-configurations verify 42

Data shape (--output json)

Without an ID, the command returns Code: "InsightsExportConfigurationsVerify" and one row per configuration, with these fields:

Field	Description
Id	Export configuration ID.
Success	Whether the destination check passed. A placeholder when VerifySupported is false.
VerifySupported	true when Insights probed the destination. false for destination types Insights does not test.
Message	The check result message.

With an ID, the command returns Code: "InsightsExportConfigurationVerify" and one object with the same fields plus DestinationType, TenantId, and DataSources.

Errors

Condition	ErrorCode
The ID is not in the organization's export configuration list. list leaves out deleted, unmigrated, and Splunk HEC configurations, and any row Insights cannot read.	not_found
The configuration answers 404 on verify after being listed.	not_found

Related

• uip insights for the tool overview.