> 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. `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/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.                                                            |
| `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**

```bash
celigo http-connectors list
```

**Arguments**

None.

**Flags**

None beyond the [global flags](/cli/getting-started/global-flags.md) (`--format`, `--jq`, `--profile`, `--verbose`).

**Example**

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

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

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

***

## `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/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/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/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/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/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/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, 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`.

## Related

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developer.celigo.com/cli/commands/http-connectors.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.