Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cloudx.io/llms.txt

Use this file to discover all available pages before exploring further.

Configuration

The cloudx config commands inspect, validate, edit, and publish inventory configuration stored in CloudX. Available commands:
  • cloudx config show for the live config, a published version, or a draft
  • cloudx config validate for local YAML files or remote configs
  • cloudx config edit create-line-item for adding a line item to a draft
  • cloudx config edit update-line-item for patching a line item in a draft
  • cloudx config edit delete-line-item for deleting a line item from a draft
  • cloudx config publish for publishing a draft as the live config
  • cloudx config history for published config history and publish-time diff counts

cloudx config show

Shows a config as YAML by default. Use this command when you need to review the exact inventory config that CloudX has stored for an account, compare a published version, or inspect a draft before publishing.

Usage

cloudx config show [flags]

Address Modes

By default, config show returns the live config. Use only one address mode at a time:
ModeDescription
No address flagShow the live config.
--id <config-id>Show a specific config row by stable ID. Can address a published version or draft.
--version <number>Show a published version number within the account.
--draftShow the account draft. If multiple drafts exist, use --id instead.

Flags

FlagRequiredDefaultDescription
--idNoStable config row ID.
--versionNoPublished config version number. Must be greater than 0.
--draftNofalseShow the current account draft.
--with-metadataNofalseInclude config row metadata in the output.
--jsonNofalsePrint structured JSON instead of the default YAML output.
Validation rules:
  • Use only one of --id, --version, or --draft.
  • --version must be greater than 0.

Output Format

By default, the command prints the config YAML without row metadata:
cloudx config show
Use --json to print only the raw config data as JSON:
cloudx config show --version 12 --json
Use --with-metadata when you need fields such as config ID, account ID, kind, version number, created time, creator metadata, YAML, and raw data:
cloudx config show --version 12 --with-metadata
cloudx config show --id cfg_123 --with-metadata --json

Examples

Show the live config
cloudx config show
Show a published version
cloudx config show --version 12
Show a config by ID
cloudx config show --id cfg_123
Show the draft with metadata
cloudx config show --draft --with-metadata

cloudx config validate

Validates either a local YAML file or a remote config. Use this command before sending a config for review, after creating a draft with cloudx config edit, or when you need JSON validation output for automation.

Usage

cloudx config validate [file] [flags]

Local And Remote Validation

When you pass a file path, validation runs locally and does not call the API:
cloudx config validate config.yaml
When you omit the file path, validation runs against the remote live config by default:
cloudx config validate
Use --id to validate a specific config row, including a draft created by config edit, or --version to validate a published version:
cloudx config validate --id draft_123
cloudx config validate --version 12

Flags

FlagRequiredDefaultDescription
fileNoLocal YAML file to validate. Omit to validate the remote live config.
--idNoStable config row ID to validate remotely.
--versionNoPublished config version number to validate remotely. Must be greater than 0.
--strictNofalseExit non-zero when validation warnings are present.
--jsonNofalsePrint structured JSON instead of human-readable output.
Validation rules:
  • Local file validation does not support --id or --version.
  • Remote validation supports only one of --id or --version.
  • --version must be greater than 0.
  • Without --strict, warnings are shown but do not make the command fail.
  • With --strict, either errors or warnings make the command exit non-zero.

Examples

Validate a local YAML file
cloudx config validate config.yaml
Fail on warnings
cloudx config validate config.yaml --strict
Validate the live config
cloudx config validate
Validate a draft and print JSON
cloudx config validate --id draft_123 --json
Validate a published version
cloudx config validate --version 12

cloudx config edit

Edits line items in a draft config. The edit commands save a draft and do not publish the config. By default, the CLI creates a draft from the live config. Use --config-id to edit an existing draft in place or copy a specific config row into a new draft. Use cloudx config publish when the draft is ready to become live. After each edit, CloudX validates the resulting draft. The default human-readable output includes the draft ID, whether a draft was created or updated, the base config ID, changed paths, and validation counts. If validation finds issues, the output also shows the cloudx config validate --id <draft-id> command to inspect details.

Commands

CommandDescription
cloudx config edit create-line-itemCreate a line item in a draft config.
cloudx config edit update-line-itemPatch an existing line item in a draft config.
cloudx config edit delete-line-itemDelete a line item from a draft config.

Shared Flags

FlagRequiredDefaultDescription
--config-idNoConfig row ID to edit. Drafts are edited in place; published or live configs are copied into a new draft.
--summaryNoGenerated from the editDraft label or edit summary.
--strictNofalseExit non-zero when validation warnings are present. Validation errors always exit non-zero.
--jsonNofalsePrint structured JSON instead of the default concise output.

Create A Line Item

cloudx config edit create-line-item [flags]
Create requires the core line-item fields below:
FlagDescription
--name <name>Line item name.
--priority <number>Line item priority. Lower numbers are evaluated first.
--bidfloor <usd-cpm>Line item floor in decimal USD CPM. For example, 1.5 is $1.50 CPM.
Create also requires exactly one target:
FlagDescription
--ad-unit-id <id>Target ad unit ID.
--ad-unit-group-id <id>Target ad unit group ID.
Optional fields:
FlagDescription
--status <status>Line item status, such as draft, active, or paused.
--bidder <adapter>Bidder adapter to enable. Repeat for multiple bidders.
Example:
cloudx config edit create-line-item \
  --name "US Rewarded" \
  --priority 2 \
  --bidfloor 1.5 \
  --ad-unit-id au_123 \
  --bidder meta \
  --bidder unityAds

Update A Line Item

cloudx config edit update-line-item --id <line-item-id> [fields]
Update commands are patch-like. Only --id is always required; pass at least one patch field to change. Omitted fields keep their current values. Changing the target with --ad-unit-id or --ad-unit-group-id clears the previous target reference. Patch fields:
FlagDescription
--id <id>Line item ID. Required.
--name <name>Optional. Patch the line item name.
--priority <number>Optional. Patch the line item priority.
--bidfloor <usd-cpm>Optional. Patch the line item floor in decimal USD CPM.
--status <status>Optional. Patch the line item status.
--ad-unit-id <id>Optional. Patch the target ad unit ID and clear any ad unit group target.
--ad-unit-group-id <id>Optional. Patch the target ad unit group ID and clear any ad unit target.
--bidder <adapter>Optional. Replace bidders with the provided bidder adapter list. Repeat for multiple bidders.
--clear-biddersOptional. Clear all bidders from the line item. Cannot be used with --bidder.
Validation rules:
  • Pass at least one patch field in addition to --id.
  • Use only one of --ad-unit-id or --ad-unit-group-id.
  • Use only one of --bidder or --clear-bidders.
Examples:
cloudx config edit update-line-item --id li_123 --bidfloor 1.5
cloudx config edit update-line-item --id li_123 --priority 3 --status paused
cloudx config edit update-line-item --id li_123 --clear-bidders

Delete A Line Item

cloudx config edit delete-line-item --id <line-item-id>
Only --id is required. Examples:
cloudx config edit delete-line-item --id li_123
cloudx config edit delete-line-item --id li_123 --summary "Remove old rewarded line item"

cloudx config publish

Publishes a draft config as the live config. Use this command after editing and validating a draft. CloudX runs the same publish-time validation checks used by the dashboard before the draft becomes live.

Usage

cloudx config publish --id <draft-id> [flags]

Flags

FlagRequiredDefaultDescription
--idYesDraft config row ID to publish as live.
--version-labelNoOptional label for the published config version.
--jsonNofalsePrint structured JSON instead of the default concise output.
Validation behavior:
  • Validation errors prevent publishing and make the command exit non-zero.
  • Warnings are shown after a successful publish but do not make the command fail.
  • When warnings remain, the output shows a cloudx config validate --id <config-id> command to inspect details.

Examples

Publish a draft
cloudx config publish --id draft_123
Publish with a version label
cloudx config publish --id draft_123 --version-label "May floor update"
Print the publish response as JSON
cloudx config publish --id draft_123 --json
Adjust a bid floor and publish
cloudx config edit update-line-item --id li_123 --bidfloor 1.5 --summary "Raise US rewarded floor"
cloudx config validate --id draft_123
cloudx config publish --id draft_123 --version-label "Raise US rewarded floor"

cloudx config history

Lists config history rows as a table by default. Use this command when you need to review recent config publishes, see who created each row, or check the precomputed publish-time diff counts for additions and deletions.

Usage

cloudx config history [flags]

Flags

FlagRequiredDefaultDescription
--sinceNoOnly include configs created at or after this time. Supports RFC3339 timestamps or YYYY-MM-DD dates.
--authorNoFilter by creator user ID, email, or name substring.
--include-draftsNofalseInclude config drafts. By default only published versions are returned.
--jsonNofalsePrint structured JSON instead of the default table output.
Validation rules:
  • --since must be an RFC3339 timestamp or a YYYY-MM-DD date.

Output Format

The default table includes the config ID, version number, kind, created time, author, diff summary, version label, and description.
cloudx config history
Diff values are shown as +additions/-deletions, using the diff_additions and diff_deletions values computed when the config was published. Use --json when scripts need the raw response fields:
cloudx config history --since 2026-05-01 --json

Examples

List published config history
cloudx config history
List recent config changes
cloudx config history --since 2026-05-01
Filter by author
cloudx config history --author alice@example.com
Include drafts
cloudx config history --include-drafts