Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

exports

Data sources that read records from external systems — HTTP APIs, files, databases, webhooks, NetSuite, Salesforce, and so on. Exports sit in a flow's pageGenerators[] (delta/once/scheduled) or are referenced as lookups from page processors.

REST API: Exports

celigo exports <subcommand> [args] [flags]

Supports all global flags.

Subcommands

Subcommand
Purpose

list

List all exports.

get <id>

Fetch one export by ID.

create

Create an export from a JSON body (--file <path> or stdin).

update <id>

Full replace from a JSON body (--file <path> or stdin); destructive PUT.

set <id> key=value …

Safe field edit: GET → modify → PUT. Supports key=file://<path>.

delete <id>

Delete an export. -y skips confirmation.

dependencies <id> (alias used-by)

List resources that depend on this export.

audit <id>

Show the audit log (change history) for one export.

clone <id>

Clone an export (same-env or cross-env).

replace-connection <id> <newConnectionId>

Swap the underlying connection reference.

invoke [id]

Run an export and return data (no job created).

enable-debug <id>

Turn on debug request logging.

disable-debug <id>

Turn off debug request logging.

reset-cursor <id>

Reset the CDC cursor on a stream (Debezium) export.

celigo exports list

List all exports in the account.

Signature

Arguments

None.

Flags

Flag
Type
Default
Description

--integration <id>

string

—

List only exports belonging to this integration.

Output columns: _id, name, adaptorType, _connectionId, lastModified.

Example

Corresponds to: GET /v1/exports

celigo exports get <id>

Fetch a single export by ID.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Export ID.

Flags

None beyond global flags.

Example

Corresponds to: GET /v1/exports/{_id}

celigo exports create

Create an export from a JSON body. Read the body from a file with -f, --file (recommended), or pipe it on stdin.

Signature

Arguments

None.

Flags

Flag
Type
Default
Description

-f, --file <path>

string

—

Read the JSON body from a file instead of stdin (--file - also means stdin). Added in celigo-cli 2026.6.1.

Request body

A JSON object matching the POST /v1/exports request schema (adaptor-specific variants: HTTPExport, NetSuiteExport, FTPExport, RDBMSExport, WebhookExport, etc.).

Example

Corresponds to: POST /v1/exports

celigo exports update <id>

Replace an export in full from a JSON body. Read the body from a file with -f, --file, or pipe it on stdin. This is a destructive PUT: omitted fields are erased.

⚠️ PUT fully replaces the export. Any field omitted from the body is erased. GET the export first, edit, then send the complete object back — or use set for targeted edits.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Export ID.

Flags

Flag
Type
Default
Description

-f, --file <path>

string

—

Read the JSON body from a file instead of stdin (--file - also means stdin). Added in celigo-cli 2026.6.1.

--force

boolean

false

Submit even if the body contains masked credential values (***) copied from a GET.

Request body

A complete export object matching the PUT /v1/exports/{_id} request schema.

Example

Corresponds to: PUT /v1/exports/{_id}

celigo exports set <id> [assignments...]

Safely edit fields in place. Whitelisted fields (e.g. name, debugUntil, schedule.*) are applied via an atomic PATCH; other fields go through GET → modify → PUT so you don't lose unrelated fields.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Export ID.

[assignments...]

key=value pairs

Yes (≥ 1)

Dot notation (http.relativeURI=...) and array indexing (filter[0]=...) are supported. key=null removes the field. Values are JSON-parsed first (e.g. disabled=false → boolean), then fall back to string. Use key=file://<path> to load a value from a file (a leading ~ and relative paths are supported); added in celigo-cli 2026.6.1.

Flags

None beyond global flags.

Example

Corresponds to: GET /v1/exports/{_id} followed by PUT /v1/exports/{_id}

celigo exports delete <id>

Delete an export. Prompts for confirmation unless -y is supplied.

⚠️ Deleting an export is destructive. Flows that reference it will break. Run dependencies first to confirm nothing depends on it.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Export ID.

Flags

Flag
Type
Default
Description

-y, --yes

boolean

false

Skip the interactive confirmation prompt.

Example

Corresponds to: DELETE /v1/exports/{_id}

celigo exports dependencies <id>

List resources that depend on this export (flows, tools, APIs, and so on). Use it to check whether an export is safe to delete: empty means no dependents. Aliased as used-by.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Export ID.

Flags

None beyond global flags.

Example

Corresponds to: GET /v1/exports/{_id}/dependencies

celigo exports audit <id>

Show the audit log (change history) for one export.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Export ID.

Flags

None beyond global flags.

Example

Corresponds to: GET /v1/exports/{_id}/audit

celigo exports clone <id>

Clone an export. Same-env clones auto-build a connection self-map from the source export's _connectionId. Cross-env clones require a connectionMap on stdin.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Source export ID.

Flags

Flag
Type
Default
Description

--name <name>

string

Clone - <source name>

Name for the cloned export. Matches the UI default when omitted.

Request body (optional, cross-env clone only)

Reads JSON on stdin when you need to remap connections across environments:

Omit stdin for same-env clones — the CLI derives the self-map automatically.

Example

Corresponds to: POST /v1/exports/{_id}/clone

celigo exports replace-connection <id> <newConnectionId>

Swap the _connectionId on an export to a different connection.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Export ID.

<newConnectionId>

string

Yes

ID of the replacement connection.

Flags

None beyond global flags.

Example

Corresponds to: POST /v1/exports/{_id}/replaceConnection

celigo exports invoke [id]

Run an export and return its data without creating a job. Two modes:

  • By ID — invokes a saved export.

  • By stdin doc — pipes an export document in for ad-hoc preview (no ID required, no save).

Signature

Arguments

Argument
Type
Required
Description

[id]

string

No

Saved export ID. Omit to invoke a preview from stdin.

Flags

Flag
Type
Default
Description

--all

boolean

false

Auto-paginate through all pages by chaining pagedExportState (ID mode only; safety cap 1000 pages).

Request body (stdin mode only)

Reads a full export document on stdin. See the POST /v1/exports/preview request schema in the Exports OpenAPI spec.

Example

Corresponds to: POST /v1/exports/{_id}/invoke (ID mode) or POST /v1/exports/preview (stdin mode)

celigo exports enable-debug <id>

Turn on debug request logging by setting debugUntil via PATCH. Capped at 60 minutes by the server.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Export ID.

Flags

Flag
Type
Default
Description

--duration <minutes>

integer

60

Minutes to keep debug enabled. Clamped to a maximum of 60.

Example

Corresponds to: PATCH /v1/exports/{_id} with [{ "op": "replace", "path": "/debugUntil", "value": "<ISO timestamp>" }]

celigo exports disable-debug <id>

Turn off debug request logging by removing debugUntil.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Export ID.

Flags

None beyond global flags.

Example

Corresponds to: PATCH /v1/exports/{_id} with [{ "op": "remove", "path": "/debugUntil" }]

celigo exports reset-cursor <id>

Reset the CDC cursor on a stream (Debezium) export. The platform deletes the stored stream offset and restarts the stream consumer — about a minute to restart, with fresh offsets persisting within ~5 minutes of streaming. No flow toggle is required.

The save is fail-soft: the server returns HTTP 200 either way and puts the verdict in _cursorResetStatus. The CLI prints the verdict and exits non-zero when the reset was refused. The server refuses a reset while the export's saved cdc.snapshotMode is initial_only (a one-shot snapshot that already fired) — pass --snapshot-mode when_needed to flip the mode and reset in the same save, which re-arms a one-shot snapshot export without cloning and deleting it.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

Export ID. Must be a stream (CDC) export — other types are refused before any write.

Flags

Flag
Type
Default
Description

--snapshot-mode <mode>

string

—

Also set cdc.snapshotMode (and the snapshot.mode properties-grid entry) in the same save — e.g. when_needed, no_data. Required to reset an initial_only export.

Example

Corresponds to: PUT /v1/exports/{_id} with root pendingCursorReset: true and cdc.cursor omitted; the outcome returns in _cursorResetStatus / _cursorResetError.

Gotchas

  • adaptorType is PascalCase and case-sensitive (HTTPExport, NetSuiteExport, FTPExport, RDBMSExport, WebhookExport, …).

  • HTTP delta exports use Handlebars for the cursor — {{{lastExportDateTime}}} in relativeURI. delta.dateField is for RDBMS only.

  • Don't include a rest: block. That creates a legacy RESTExport resource. Use http: with adaptorType: "HTTPExport" for new exports.

  • mockOutput shape is { "page_of_records": [ { "record": { ... } } ] } — object, not array.

  • No standalone exports preview CLI command. Use celigo exports invoke (pipe a doc via stdin) for an unsaved preview, or celigo flows test-run once the export is wired into a flow.

Related

  • imports — destination side of a flow.

  • flows — exports plug into pageGenerators[].

  • connections — every export references a _connectionId.

Previousevent-reports
Nextfeedback

Last updated

Was this helpful?