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

http-connectors

Catalog of Celigo-managed HTTP connector definitions (550+) — each describes the endpoints, resources, and supported fields that power HTTP exports, imports, and connections for a target application. create/update/delete apply to custom connector definitions; the Celigo-managed entries are read-only.

REST API: HTTP Connector Endpoints

celigo http-connectors <subcommand> [args] [flags]

Supports all global flags.


Subcommands

Subcommand
Purpose

list

List all HTTP connector definitions.

get <id>

Fetch one HTTP connector by ID; --full includes endpoints, resources, and supportedBy fields.

create

Create a custom HTTP connector definition (--file <path> or stdin).

update <id>

Update a custom HTTP connector definition (--file <path> or stdin).

delete <id>

Delete a custom HTTP connector definition.

resources <connectorId>

List the resources defined on a connector.

resource <connectorId> <id>

Get one connector resource by ID.

endpoints <connectorId> <resourceId>

List the endpoints on a connector resource.

endpoint <connectorId> <resourceId> <id>

Get one connector endpoint by ID.

catalog <id>

Staged form-metadata catalog: projected resource and endpoint summaries for one plane.

endpoint-detail <id>

Scoped resource and endpoint detail documents (the catalog's companion).


celigo http-connectors list

List every HTTP connector definition published to the catalog.

Signature

Arguments

None.

Flags

None beyond the global flags (--format, --jq, --profile, --verbose).

Example

Table output columns: _id, name, published, isGraphQL.

Corresponds to: GET /v1/httpconnectors


celigo http-connectors get

Fetch a single HTTP connector definition by ID. By default returns the header fields only. Pass --full to include the complete catalog entry: endpoints, resources, supported fields, and global iClient references.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

HTTP connector _id.

Flags

Flag
Type
Default
Description

--full

boolean

false

Include all endpoints, resources, and supportedBy fields. Sends ?returnEverything=true on the request.

Example

Corresponds to: GET /v1/httpconnectors/{_id} (with ?returnEverything=true when --full is set)


celigo http-connectors create

Create a custom HTTP connector definition from a JSON body (--file <path> or stdin). Celigo-managed connectors cannot be created this way; this is for your own custom definitions.

Signature

Flags

Flag
Type
Default
Description

-f, --file <path>

string

JSON body file (or pipe via stdin).

Request body

A JSON object matching the POST /v1/httpconnectors request schema.

Example

Corresponds to: POST /v1/httpconnectors


celigo http-connectors update

Update a custom HTTP connector definition from a JSON body (--file <path> or stdin).

⚠️ PUT fully replaces the connector definition. Any field omitted from the body is erased. Only custom connectors can be updated — Celigo-managed catalog entries are read-only.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

HTTP connector _id.

Flags

Flag
Type
Default
Description

-f, --file <path>

string

JSON body file (or pipe via stdin).

Example

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


celigo http-connectors delete

Delete a custom HTTP connector definition. Prompts for confirmation unless -y is passed.

⚠️ Deleting a custom connector is destructive. Only custom definitions can be deleted; Celigo-managed catalog entries are read-only. Connections and resources that reference the connector may stop resolving it.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

HTTP connector _id.

Flags

Flag
Type
Default
Description

-y, --yes

boolean

false

Skip the confirmation prompt.

Example

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


celigo http-connectors resources

List the resources defined on an HTTP connector. A resource groups the endpoints for one object type (e.g. orders, customers). This is a slice of what get --full returns.

Signature

Arguments

Argument
Type
Required
Description

<connectorId>

string

Yes

HTTP connector _id.

Example

Corresponds to: GET /v1/httpconnectors/{connectorId}/httpconnectorresources


celigo http-connectors resource

Get one HTTP connector resource by ID.

Signature

Arguments

Argument
Type
Required
Description

<connectorId>

string

Yes

HTTP connector _id.

<id>

string

Yes

Resource _id.

Example


celigo http-connectors endpoints

List the endpoints on an HTTP connector resource. An endpoint is one operation (a method + path) within a resource.

Signature

Arguments

Argument
Type
Required
Description

<connectorId>

string

Yes

HTTP connector _id.

<resourceId>

string

Yes

Resource _id.

Example

Corresponds to: GET /v1/httpconnectors/{connectorId}/{resourceId}/httpconnectorendpoints


celigo http-connectors endpoint

Get one HTTP connector endpoint by ID.

Signature

Arguments

Argument
Type
Required
Description

<connectorId>

string

Yes

HTTP connector _id.

<resourceId>

string

Yes

Resource _id.

<id>

string

Yes

Endpoint _id.

Example


celigo http-connectors catalog

Get the staged form-metadata catalog for an HTTP connector — projected resource and endpoint summaries for one plane (export or import). These are the staged reads that drive the UI's assistant-based form metadata. Added in celigo-cli 2026.8.7.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

HTTP connector _id.

Flags

Flag
Type
Default
Description

--resource-type <type>

export | import

Required. Resource plane to project. Any other value is rejected locally.

--blob

boolean

false

Select the blob endpoint plane (default: non-blob).

--api <api>

string

Optional API group scope filter.

--version <version>

string

Optional version scope filter.

--published-only

boolean

false

Only include published documents.

Example

Corresponds to: GET /v1/httpconnectors/{_id}/catalog


celigo http-connectors endpoint-detail

Get scoped resource and endpoint detail documents for an HTTP connector resource — the staged-metadata companion to catalog. Added in celigo-cli 2026.8.7.

Signature

Arguments

Argument
Type
Required
Description

<id>

string

Yes

HTTP connector _id.

Flags

Flag
Type
Default
Description

--resource-type <type>

export | import

Required. Resource plane to resolve.

--resource-id <resourceId>

string

Required. HTTP connector resource ID.

--blob

boolean

false

Select the blob endpoint plane (default: non-blob).

--endpoint-id <endpointId>

string

Single endpoint ID (mutually exclusive with --endpoint-ids). The server requires it for the export plane (400 without it).

--endpoint-ids <ids>

string

Comma-separated pair of import endpoint IDs for create/update batches.

--api <api>

string

Optional API group scope filter.

--version <version>

string

Optional version scope filter.

--published-only

boolean

false

Only include published documents.

Example


Gotchas

  • Celigo-managed entries are read-only. create / update / delete apply only to custom connector definitions you author; attempting to modify a Celigo-managed catalog entry is rejected. The trading partner catalog (trading-partner-connectors) is read-only from the CLI.

  • Catalog is large (550+ entries). To find a connector by name, filter list with --jq (e.g. list --jq 'map(select(.name | test("shopify";"i")))') rather than scrolling. get --full payloads can be substantial; pipe through --jq to project only what you need.

  • get is header-only without --full. If you need endpoints, resources, or the supportedBy field list, you must pass --full — otherwise those arrays are omitted. The resources / resource / endpoints / endpoint subcommands drill into the same data without inlining everything at once.

  • Used with connections, not exports/imports directly. HTTP connectors drive the UI's assistant-based connection, export, and import authoring; at the resource level they surface via http._httpConnectorId, _httpConnectorEndpointId, and _httpConnectorResourceId.

  • trading-partner-connectors — sibling read-only catalog for trading partner connectors.

  • connections — HTTP-assistant connections reference a connector _id from this catalog.

  • templates — published marketplace templates that pair with connector definitions.

Last updated

Was this helpful?