connectors

Manage connectors — installable integration applications, their install base, install/update lifecycle, and per-connector licenses.

REST API: Connectors

celigo connectors <subcommand> [args] [flags]

Supports all global flags.

Subcommands

Subcommand	Purpose
list	List all connectors.
get <id>	Fetch one connector.
create	Create a connector from JSON (stdin or --file).
update <id>	Full replace from JSON (stdin or --file). Omitted fields are erased.
set <id> key=value …	Safe field edit: PATCH for whitelisted fields, else GET → modify → PUT.
delete <id>	Delete a connector.
install-base <id>	List the installed integrations (install base) for a connector.
install <id>	Install a connector from JSON (stdin or --file).
push-update <id>	Push an update to a connector's install base from JSON (stdin or --file).
licenses	Manage licenses for a connector (sub-group).

licenses sub-subcommands

Subcommand	Purpose
licenses list <id>	List all licenses for a connector.
licenses get <id> <licenseId>	Fetch one connector license.
licenses create <id>	Create a connector license from JSON (stdin or --file).
licenses update <id> <licenseId>	Update a connector license from JSON (stdin or --file).
licenses delete <id> <licenseId>	Delete a connector license.

---

celigo connectors list

List all connectors in the account.

Signature

celigo connectors list [flags]

Example

celigo connectors list --format table

Corresponds to: GET /v1/connectors (operationId: listConnectors)

---

celigo connectors get

Fetch one connector by ID.

Signature

celigo connectors get <id>

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.

Example

celigo connectors get 5f83a9b2c7d3e8f1a2b3c4d5

Corresponds to: GET /v1/connectors/{_id} (operationId: getConnectorById)

---

celigo connectors create

Create a connector from a JSON body.

Signature

celigo connectors create [flags]

Flags

Flag	Type	Default	Description
-f, --file <path>	string	stdin	Read the JSON body from a file instead of stdin (- also means stdin).

Request body

Reads JSON on stdin (or --file). See the POST /v1/connectors schema for the full payload shape.

Example

cat connector.json | celigo connectors create

Corresponds to: POST /v1/connectors (operationId: createConnector)

---

celigo connectors update

Full replace of a connector from a JSON body.

⚠️ update erases omitted fields. PUT is a full replace — any field missing from the body is cleared. GET the connector first, edit it, then send back the complete object — or use set for partial edits.

Signature

celigo connectors update <id> [flags]

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.

Flags

Flag	Type	Default	Description
-f, --file <path>	string	stdin	Read the JSON body from a file instead of stdin (- also means stdin).

Request body

Reads JSON on stdin (or --file). See the PUT /v1/connectors/{_id} schema for the full payload shape.

Example

celigo connectors get 5f83a9b2c7d3e8f1a2b3c4d5 --format json > connector.json
# edit connector.json
cat connector.json | celigo connectors update 5f83a9b2c7d3e8f1a2b3c4d5

Corresponds to: PUT /v1/connectors/{_id} (operationId: updateConnector)

---

celigo connectors set

Safe field edit. Whitelisted fields (e.g. name, debugUntil, schedule.*) are applied via an atomic PATCH; other fields go through GET → modify → PUT. Accepts key=value pairs; values auto-parse as JSON (disabled=false is a boolean; =null removes a field). Supports dot paths and array indexing.

Signature

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

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.
[assignments...]	key=value pairs	Yes	One or more field assignments.

Example

celigo connectors set 5f83a9b2c7d3e8f1a2b3c4d5 name="My Connector"

Corresponds to: PUT /v1/connectors/{_id} (operationId: updateConnector)

---

celigo connectors delete

Delete a connector.

⚠️ delete is immediate. Removing a connector affects its install base. Run install-base first to see the installed integrations.

Signature

celigo connectors delete <id> [flags]

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.

Flags

Flag	Type	Default	Description
-y, --yes	boolean	false	Skip confirmation.

Example

celigo connectors delete 5f83a9b2c7d3e8f1a2b3c4d5 -y

Corresponds to: DELETE /v1/connectors/{_id} (operationId: deleteConnector)

---

celigo connectors install-base

List the install base — the installed integrations — for a connector.

Signature

celigo connectors install-base <id>

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.

Example

celigo connectors install-base 5f83a9b2c7d3e8f1a2b3c4d5 --format table

Corresponds to: GET /v1/connectors/{_id}/installBase (operationId: getConnectorInstallBase)

---

celigo connectors install

Install a connector from a JSON body.

Signature

celigo connectors install <id> [flags]

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.

Flags

Flag	Type	Default	Description
-f, --file <path>	string	stdin	Read the JSON body from a file instead of stdin (- also means stdin).

Request body

Reads JSON on stdin (or --file). See the POST /v1/connectors/{_id}/install schema for the full payload shape.

Example

cat install.json | celigo connectors install 5f83a9b2c7d3e8f1a2b3c4d5

Corresponds to: POST /v1/connectors/{_id}/install (operationId: installConnector)

---

celigo connectors push-update

Push an update to a connector's install base from a JSON body.

Signature

celigo connectors push-update <id> [flags]

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.

Flags

Flag	Type	Default	Description
-f, --file <path>	string	stdin	Read the JSON body from a file instead of stdin (- also means stdin).

Request body

Reads JSON on stdin (or --file). See the PUT /v1/connectors/{_id}/update schema for the full payload shape.

Example

cat update.json | celigo connectors push-update 5f83a9b2c7d3e8f1a2b3c4d5

Corresponds to: PUT /v1/connectors/{_id}/update (operationId: pushConnectorUpdate)

---

celigo connectors licenses list

List all licenses for a connector.

Signature

celigo connectors licenses list <id>

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.

Example

celigo connectors licenses list 5f83a9b2c7d3e8f1a2b3c4d5

Corresponds to: GET /v1/connectors/{_id}/licenses (operationId: listConnectorLicenses)

---

celigo connectors licenses get

Fetch one connector license by ID.

Signature

celigo connectors licenses get <id> <licenseId>

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.
<licenseId>	string	Yes	License ID.

Example

celigo connectors licenses get 5f83a9b2c7d3e8f1a2b3c4d5 6a1b2c3d4e5f6a7b8c9d0e1f

Corresponds to: GET /v1/connectors/{_id}/licenses/{licenseId} (operationId: getConnectorLicenseById)

---

celigo connectors licenses create

Create a connector license from a JSON body.

Signature

celigo connectors licenses create <id> [flags]

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.

Flags

Flag	Type	Default	Description
-f, --file <path>	string	stdin	Read the JSON body from a file instead of stdin (- also means stdin).

Request body

Reads JSON on stdin (or --file). See the POST /v1/connectors/{_id}/licenses schema for the full payload shape.

Example

cat license.json | celigo connectors licenses create 5f83a9b2c7d3e8f1a2b3c4d5

Corresponds to: POST /v1/connectors/{_id}/licenses (operationId: createConnectorLicense)

---

celigo connectors licenses update

Update a connector license from a JSON body.

Signature

celigo connectors licenses update <id> <licenseId> [flags]

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.
<licenseId>	string	Yes	License ID.

Flags

Flag	Type	Default	Description
-f, --file <path>	string	stdin	Read the JSON body from a file instead of stdin (- also means stdin).

Request body

Reads JSON on stdin (or --file). See the PUT /v1/connectors/{_id}/licenses/{licenseId} schema for the full payload shape.

Example

cat license.json | celigo connectors licenses update 5f83a9b2c7d3e8f1a2b3c4d5 6a1b2c3d4e5f6a7b8c9d0e1f

Corresponds to: PUT /v1/connectors/{_id}/licenses/{licenseId} (operationId: updateConnectorLicense)

---

celigo connectors licenses delete

Delete a connector license.

⚠️ delete removes the license immediately. Any install that depends on this license may lose access. Confirm the licenseId first.

Signature

celigo connectors licenses delete <id> <licenseId> [flags]

Arguments

Argument	Type	Required	Description
<id>	string	Yes	Connector ID.
<licenseId>	string	Yes	License ID.

Flags

Flag	Type	Default	Description
-y, --yes	boolean	false	Skip confirmation.

Example

celigo connectors licenses delete 5f83a9b2c7d3e8f1a2b3c4d5 6a1b2c3d4e5f6a7b8c9d0e1f -y

Corresponds to: DELETE /v1/connectors/{_id}/licenses/{licenseId} (operationId: deleteConnectorLicense)

---

Related

• integrations — connector installs produce integrations; the install base lists them.
• connections — connectors bundle the connections an install will create.
• templates — browse published connectors and templates available to install.