> For the complete documentation index, see [llms.txt](https://developer.celigo.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developer.celigo.com/cli/commands/http-connectors.md).

# 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. Each definition also carries the base URIs, the versions, and the connection form (`supportedBy.connection`) that a connection created from it inherits: the pre-configured fields the form sets (`http.auth.type`, `http._iClientId` for a Celigo-managed global iClient, media type, ping, headers) and the fields it asks the user for (credentials, `settings.*`, OAuth scopes). A grouped connector nests API groups under `apis[]`, each with its own base URIs and form; a connection references one as `http._httpConnectorApiId`. A connection uses the connector's `legacyId` as its `assistant` value.

`match <url|name>` is the lookup to run before creating any HTTP connection — it reports what each fitting connector's form prescribes — and `connections create --connector <id>` creates the connection from it. `create`/`update`/`delete` apply to **custom** connector definitions; the Celigo-managed entries are read-only.

**REST API**: [HTTP Connector Endpoints](https://developer.celigo.com/api/api-reference/connections-and-http-connectors/http-connector-endpoints)

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

Supports all [global flags](/cli/getting-started/global-flags.md).

***

## Subcommands

| Subcommand                                 | Purpose                                                                                                                                                                              |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `list`                                     | List all HTTP connector definitions (abridged by the API: no base URIs or auth details). `--search <term>` filters by name or legacy application id.                                 |
| `match <url\|name>`                        | Find the pre-built connector(s) for a URL or an application name, with what each one's connection form prescribes. Run it before `connections create`. Added in celigo-cli 2026.9.1. |
| `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. The list is abridged by the API — no base URIs or auth details — so use it to find a connector by name, then `match <url|name>` or `get <id>` for the detail.

**Signature**

```bash
celigo http-connectors list [--search <term>] [--fields <spec>]
```

**Arguments**

None.

**Flags**

| Flag              | Type   | Default   | Description                                                                                                                                                                                                                         |
| ----------------- | ------ | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--search <term>` | string | —         | Keep only the connectors whose name or legacy application id contains `<term>` (case-insensitive). Filtering happens client-side. Added in celigo-cli 2026.9.1.                                                                     |
| `--fields <spec>` | string | `default` | Fields to request per row. `default` returns `_id`, `name`, and the table columns; `all` returns complete documents; a comma-separated list requests specific fields. See [field projection](/cli/getting-started/global-flags.md). |

This list has no `--limit` flag. To cap the output, filter with `--search` or `--jq`.

**Example**

```bash
celigo http-connectors list --format table

# Connectors whose name or legacy application id mentions "shopify"
celigo http-connectors list --search shopify
```

Table output columns: `_id`, `name`, `legacyId`, `isGraphQL`, `lastModified`. `legacyId` is the value a connection created from the connector carries as `assistant`. Before celigo-cli 2026.9.1 the table showed a `published` column that never populated — the collection returns no such field — in place of `lastModified`.

**Corresponds to**: [`GET /v1/httpconnectors`](https://developer.celigo.com/api/api-reference/connections-and-http-connectors/http-connector-endpoints)

***

## `celigo http-connectors match`

Find the pre-built connector(s) for a URL or an application name, with what each one's connection form prescribes. Run it before any `connections create`, then create the connection with [`connections create --connector <id>`](/cli/commands/connections.md#celigo-connections-create). Added in celigo-cli 2026.9.1.

A URL is matched on the connectors' base URIs — host first, then path — templated hosts included; a name is matched on connector names and legacy application ids. A grouped connector returns one row per API group (the `http._httpConnectorApiId` a connection would reference). A URL that matches no base URI falls back to the connectors whose name relates to its host, with a stderr note saying so.

Each row carries:

| Field                                  | Meaning                                                                                        |
| -------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `_id`, `name`, `legacyId`, `isGraphQL` | The connector. `legacyId` is the connection's `assistant` value.                               |
| `_apiId`, `api`                        | The API group, on a grouped connector.                                                         |
| `_versionId`, `version`, `versions`    | The version a new connection references (the first published one), and every version.          |
| `baseURIs`                             | The base URIs the connector (or API group) serves.                                             |
| `authTypes`                            | Every `http.auth.type` the connection form offers, in the connector's order.                   |
| `defaultAuth`                          | The auth type the form preselects. Unset when the form makes the user choose.                  |
| `globalIClientId`                      | Celigo's shared OAuth app (the `http._iClientId` the form sets), when the connector ships one. |
| `mustSet`                              | The fields the form requires you to fill in: credentials, `settings.*`, an own iClient.        |
| `scopes`                               | The OAuth scopes the form offers, when it offers a list.                                       |
| `matchedBy`, `matchedBaseURI`          | `baseURI` or `name`, and the base URI a URL query matched.                                     |

The list endpoint carries no base URIs, so a URL is confirmed against the connectors whose name relates to its host, with one detail request each. `--scan` confirms every connector instead — 600+ requests — for a host that does not name the application. Works in `read` mode.

**Signature**

```bash
celigo http-connectors match <url|name> [--scan]
```

**Arguments**

| Argument      | Type   | Required | Description                                                                                                  |
| ------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------ |
| `<url\|name>` | string | Yes      | A URL (matched on base URIs) or an application name (matched on connector names and legacy application ids). |

**Flags**

| Flag     | Type    | Default | Description                                                                                                                         |
| -------- | ------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `--scan` | boolean | `false` | Confirm every connector's base URIs, not only the name-related ones. 600+ detail requests; the command reports the count on stderr. |

**Example**

```bash
# The connector that serves an API, and what its form prescribes
celigo http-connectors match https://api.github.com

# By application name
celigo http-connectors match shopify --format table

# A host that does not name its application: check every connector
celigo http-connectors match https://api.example-erp.com/v2 --scan

# Then create the connection from the connector
celigo connections create --connector 5f83a9b2c7d3e8f1a2b3c4d5 --name "GitHub - Prod"
```

Table output columns: `_id`, `name`, `api`, `version`, `defaultAuth`, `globalIClientId`, `matchedBaseURI`. JSON output carries every field above.

**Corresponds to**: [`GET /v1/httpconnectors`](https://developer.celigo.com/api/api-reference/connections-and-http-connectors/http-connector-endpoints) for the candidates, then [`GET /v1/httpconnectors/{_id}`](https://developer.celigo.com/api/api-reference/connections-and-http-connectors/http-connector-endpoints) for each connector that is confirmed.

***

## `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**

```bash
celigo http-connectors get <id> [--full]
```

**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**

```bash
celigo http-connectors get 5f83a9b2c7d3e8f1a2b3c4d5 --full
```

**Corresponds to**: [`GET /v1/httpconnectors/{_id}`](https://developer.celigo.com/api/api-reference/connections-and-http-connectors/http-connector-endpoints) (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**

```bash
celigo http-connectors create --file <path>
celigo http-connectors create < body.json     # or pipe on stdin
```

**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**

```bash
celigo http-connectors create --file ./my-connector.json
```

**Corresponds to**: [`POST /v1/httpconnectors`](https://developer.celigo.com/api/api-reference/connections-and-http-connectors/http-connector-endpoints)

***

## `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**

```bash
celigo http-connectors update <id> --file <path>
celigo http-connectors update <id> < body.json     # or pipe on stdin
```

**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**

```bash
celigo http-connectors update 5f83a9b2c7d3e8f1a2b3c4d5 --file ./my-connector.json
```

**Corresponds to**: [`PUT /v1/httpconnectors/{_id}`](https://developer.celigo.com/api/api-reference/connections-and-http-connectors/http-connector-endpoints)

***

## `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**

```bash
celigo http-connectors delete <id> [-y]
```

**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**

```bash
celigo http-connectors delete 5f83a9b2c7d3e8f1a2b3c4d5 -y
```

**Corresponds to**: [`DELETE /v1/httpconnectors/{_id}`](https://developer.celigo.com/api/api-reference/connections-and-http-connectors/http-connector-endpoints)

***

## `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**

```bash
celigo http-connectors resources <connectorId>
```

**Arguments**

| Argument        | Type   | Required | Description           |
| --------------- | ------ | -------- | --------------------- |
| `<connectorId>` | string | Yes      | HTTP connector `_id`. |

**Example**

```bash
celigo http-connectors resources 5f83a9b2c7d3e8f1a2b3c4d5
```

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

***

## `celigo http-connectors resource`

Get one HTTP connector resource by ID.

**Signature**

```bash
celigo http-connectors resource <connectorId> <id>
```

**Arguments**

| Argument        | Type   | Required | Description           |
| --------------- | ------ | -------- | --------------------- |
| `<connectorId>` | string | Yes      | HTTP connector `_id`. |
| `<id>`          | string | Yes      | Resource `_id`.       |

**Example**

```bash
celigo http-connectors resource 5f83a9b2c7d3e8f1a2b3c4d5 6a1b2c3d4e5f6a7b8c9d0e1f
```

***

## `celigo http-connectors endpoints`

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

**Signature**

```bash
celigo http-connectors endpoints <connectorId> <resourceId>
```

**Arguments**

| Argument        | Type   | Required | Description           |
| --------------- | ------ | -------- | --------------------- |
| `<connectorId>` | string | Yes      | HTTP connector `_id`. |
| `<resourceId>`  | string | Yes      | Resource `_id`.       |

**Example**

```bash
celigo http-connectors endpoints 5f83a9b2c7d3e8f1a2b3c4d5 6a1b2c3d4e5f6a7b8c9d0e1f
```

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

***

## `celigo http-connectors endpoint`

Get one HTTP connector endpoint by ID.

**Signature**

```bash
celigo http-connectors endpoint <connectorId> <resourceId> <id>
```

**Arguments**

| Argument        | Type   | Required | Description           |
| --------------- | ------ | -------- | --------------------- |
| `<connectorId>` | string | Yes      | HTTP connector `_id`. |
| `<resourceId>`  | string | Yes      | Resource `_id`.       |
| `<id>`          | string | Yes      | Endpoint `_id`.       |

**Example**

```bash
celigo http-connectors endpoint 5f83a9b2c7d3e8f1a2b3c4d5 6a1b2c3d4e5f6a7b8c9d0e1f 7b2c3d4e5f6a7b8c9d0e1f2a
```

***

## `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**

```bash
celigo http-connectors catalog <id> --resource-type <export|import> [--blob] [--api <api>] [--version <version>] [--published-only]
```

**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**

```bash
celigo http-connectors catalog 5f83a9b2c7d3e8f1a2b3c4d5 --resource-type export --published-only
```

**Corresponds to**: [`GET /v1/httpconnectors/{_id}/catalog`](https://developer.celigo.com/api/api-reference/connections-and-http-connectors/http-connector-endpoints)

***

## `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**

```bash
celigo http-connectors endpoint-detail <id> --resource-type <export|import> --resource-id <resourceId> \
  [--blob] [--endpoint-id <endpointId> | --endpoint-ids <ids>] [--api <api>] [--version <version>] [--published-only]
```

**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**

```bash
celigo http-connectors endpoint-detail 5f83a9b2c7d3e8f1a2b3c4d5 \
  --resource-type export --resource-id 6a1b2c3d4e5f6a7b8c9d0e1f \
  --endpoint-id 7b2c3d4e5f6a7b8c9d0e1f2a
```

**Corresponds to**: [`GET /v1/httpconnectors/{_id}/resourceEndpointDetail`](https://developer.celigo.com/api/api-reference/connections-and-http-connectors/http-connector-endpoints)

***

## 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, use `list --search <term>` (name or legacy application id), or `match <url|name>` when you hold the API's URL. `get --full` payloads can be substantial; pipe through `--jq` to project only what you need.
* **`list` is abridged by the API.** The collection carries no base URIs and no `supportedBy` form, and `include=` cannot add them — which is why `match` confirms a URL with one detail request per candidate, and why `--scan` (every connector) costs 600+ requests.
* **Run `match` before `connections create`.** Since celigo-cli 2026.9.1 a hand-written `type: http` connection whose base URI a pre-built connector serves is refused at create time, naming the connector. `match` is the detail view that refusal points at; `connections create --connector <id>` scaffolds the connection from the connector's form.
* **`defaultAuth` can be unset.** Some connection forms make the user choose the auth type; `connections create --connector` then needs `--auth-type <type>`, picked from `authTypes`.
* **A grouped connector is several surfaces.** Each API group under `apis[]` has its own base URIs and form, and `match` returns one row per group. A connection is created from one group (`connections create --api <id|name>`) and references it as `http._httpConnectorApiId`.
* **`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`.

## Related

* [trading-partner-connectors](/cli/commands/trading-partner-connectors.md) — sibling read-only catalog for trading partner connectors.
* [connections](/cli/commands/connections.md) — `connections create --connector <id>` scaffolds a connection from a connector in this catalog; HTTP-assistant connections reference a connector `_id`.
* [templates](/cli/commands/templates.md) — published marketplace templates that pair with connector definitions.