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

templates

Browse, preview, manage, and install integration templates. Three things live here: the published marketplace catalog (marketplace), your own template resources (list, get, create, update, delete), and installation (preview, install).

REST API: Marketplace

celigo templates <subcommand> [args] [flags]

Supports all global flags.

Subcommands

Subcommand
Purpose

marketplace

Browse the published catalog (Integration Apps + Templates), sorted by install count. Filter by name with --jq.

list

List your own template resources (GET /v1/templates).

get <id>

Get one of your template resources.

create / update <id> / delete <id>

Manage your own template resources.

preview [id]

Preview a template's blueprint — by id, or --zip for a local bundle.

install [id]

Install a template (creating an integration) — by id, or --zip for a local bundle.

celigo templates marketplace

List published marketplace entries, sorted by numInstalls descending. Connectors (Integration Apps) are excluded by default because they install through the UI and can't be previewed — use --type Connector or --include-connectors to bring them in. (For your own template resources, use list.)

Signature

celigo templates marketplace [flags]

Flags

Flag
Type
Default
Description

--type <type>

string

(unset)

Filter by docType. Accepts Template or Connector (case-insensitive).

--include-connectors

boolean

false

Include docType=Connector entries in the unfiltered list. Ignored when --type is set.

Corresponds to: POST /v1/published/combined?sort_by=numInstalls

celigo templates list / get / create / update / delete

Manage your own template resources (the /v1/templates CRUD endpoint) — distinct from the published marketplace catalog. create/update/delete follow the standard resource conventions. create and update read the JSON body from a file with -f, --file <path> or from stdin; update is a full PUT; delete takes -y, --yes to skip the confirmation prompt.

⚠️ update and delete are destructive. update is a full PUT — any field you omit is erased, so GET first and send the complete object. delete permanently removes the template resource.

Corresponds to: GET /v1/templates, GET|POST|PUT|DELETE /v1/templates[/{_id}]

celigo templates preview

Preview a template's full blueprint — every {model, doc} object the installer would materialize (Integration, Connection, Export, Import, Flow, Script). Either pass a template id, or --zip to preview a local bundle (which uploads the zip and previews the integration it would create — nothing is saved). Run this before install --zip to discover the source connections you need to map.

Signature

Arguments

Argument
Type
Required
Description

[id]

string

Conditional

Template _id from marketplace (must be a docType=Template entry). Omit when using --zip.

Flags

Flag
Type
Default
Description

--zip <path>

path

(unset)

Preview a local template .zip instead of a template id. Mutually exclusive with [id].

--model <model>

string

(unset)

Scope the response to one object type (Flow, Export, Import, Script, Connection, Integration). Id-based preview only.

--summary

boolean

false

Show a {model, count} rollup instead of full configs. Takes precedence over --model.

Example

Corresponds to: GET /v1/templates/{_id}/preview (by id), or GET /v1/integrations/template/preview (by --zip, after a signed-URL upload).

celigo templates install

Install a template, creating a new integration. Either pass a template id, or --zip to install a local bundle. Templates that include connections require a source→target connection map piped via stdin: {"connectionMap":{"sourceConnId":"targetConnId", …}}. Run preview first to discover the source connections.

Signature

Arguments

Argument
Type
Required
Description

[id]

string

Conditional

Template _id to install. Omit when using --zip.

Flags

Flag
Type
Default
Description

--zip <path>

path

(unset)

Install from a local template .zip instead of a template id. Mutually exclusive with [id].

-f, --file <path>

path

(unset)

JSON body file for an id-based install (or pipe via stdin).

Example

Corresponds to: POST /v1/integrations/template/{_id} (by id), or POST /v1/integrations/template (by --zip, after a signed-URL upload). Requires full mode.

Gotchas

  • Template vs Connector. The combined marketplace endpoint returns two docTypes. Template entries are user-installable blueprints and are the only ones preview accepts — passing a Connector id returns 404 Not Found with invalid_ref "Template not found". Connector entries are Celigo-managed Integration Apps that install through the UI (or integrations install).

  • marketplace vs list. marketplace hits the published catalog (/v1/published/combined); list/get/CRUD operate on your own template resources (/v1/templates). Different datasets.

  • Connectors are hidden by default. marketplace filters them out. Use --type Connector or --include-connectors for the full catalog.

  • POST, not GET, for the combined catalog. /v1/published/combined is POST-only with an empty JSON body.

  • No server-side name search. The combined catalog endpoint has no q/name parameter — filter marketplace output by name with --jq (e.g. marketplace --jq 'map(select(.name | test("shopify";"i")))').

  • --zip is a two-step upload. preview --zip / install --zip first request a signed S3 URL, PUT the bundle there, then pass the resulting runKey to the preview/install call.

Related

Previoustags
Nexttools

Last updated

Was this helpful?