# HTTP Connectors
## List HTTP connectors
> Returns a list of all HTTP Connectors in the account.
```json
{"openapi":"3.1.0","info":{"title":"HTTP Connectors","version":"1.0.0"},"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"parameters":{"Include":{"name":"include","in":"query","required":false,"description":"Comma-separated list of fields to project into each returned record.\nTriggers **summary projection** on supported list endpoints: the server\nreturns a minimal identity set for each record (`_id`, `name`, plus a\nresource-specific always-on set like `adaptorType` on exports/imports,\nor richer defaults on `ashares`, `audit`, `httpconnectors`, `transfers`,\netc.) and adds any listed fields that exist on the record. Listed fields\nthe record doesn't carry are silently dropped.\n\nDot notation is supported for projecting nested sub-fields — e.g.\n`include=ftp.directoryPath` on `/v1/exports` returns just that nested\nfield inside `ftp` for FTP-type exports (and omits `ftp` entirely for\nnon-FTP exports).\n\nRules:\n- Value regex is `{a-z A-Z . _}` (letters, dots, underscores) plus the\n comma separator; digits are also accepted in practice. Any other\n character returns **400 `invalid_query_params`**.\n- Empty value (`include=`) or bare `include` is ignored — the full\n default record is returned.\n- `include` and `exclude` are **mutually exclusive**. Passing both\n returns **400 `invalid_query_params`**: *\"Please provide either\n include or exclude param in the request query and not both.\"*\n- Array-bracket syntax (`include[]=...`) is not supported and can return\n a 500.\n- Only list endpoints honor projection — on GET-by-id the parameter is\n silently ignored.\n- A small set of list endpoints explicitly reject both `include` and\n `exclude` with **400 `invalid_query_params`** and a message of the form\n *\"Include or exclude query params are not applicable for ``\n resource.\"* Known rejections: `/v1/ediprofiles`, `/v1/environments`,\n `/v1/iClients`, `/v1/lookupcaches`, `/v1/tags`.","schema":{"type":"string"}},"Exclude":{"name":"exclude","in":"query","required":false,"description":"Comma-separated list of fields to remove from the default response on\nsupported list endpoints. Unlike `include`, `exclude` does NOT trigger\nsummary projection — callers get the standard full-record shape with the\nnamed fields stripped out.\n\nRules:\n- Value regex is `{a-z A-Z . _}` (letters, dots, underscores) plus the\n comma separator; digits are also accepted in practice. Any other\n character returns **400 `invalid_query_params`**.\n- Empty value (`exclude=`) is ignored.\n- Certain protected identity fields **cannot be stripped** — e.g.\n `exclude=name` on `/v1/exports` is silently ignored and `name` remains\n in the response. Protected sets vary per resource.\n- `include` and `exclude` are **mutually exclusive**. Passing both\n returns **400 `invalid_query_params`**: *\"Please provide either\n include or exclude param in the request query and not both.\"*\n- Only list endpoints honor stripping — on GET-by-id the parameter is\n silently ignored.\n- A small set of list endpoints explicitly reject both `include` and\n `exclude` with **400 `invalid_query_params`** and a message of the form\n *\"Include or exclude query params are not applicable for ``\n resource.\"* Known rejections: `/v1/ediprofiles`, `/v1/environments`,\n `/v1/iClients`, `/v1/lookupcaches`, `/v1/tags`.","schema":{"type":"string"}}},"schemas":{"Response":{"type":"object","description":"HTTP Connector object as returned by the API","allOf":[{"$ref":"#/components/schemas/Request"},{"$ref":"#/components/schemas/ResourceResponse"},{"$ref":"#/components/schemas/IAResourceResponse"},{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"Unique identifier for the HTTP Connector","readOnly":true},"_userId":{"type":"string","format":"objectId","description":"Owner user id","readOnly":true},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when created","readOnly":true},"lastModified":{"type":"string","format":"date-time","description":"Timestamp when last modified","readOnly":true},"deletedAt":{"type":"string","format":"date-time","description":"Timestamp when soft-deleted (if applicable)","readOnly":true},"__numOfBlobEndpoints":{"type":"number","description":"Number of blob endpoints for this connector","readOnly":true}}}]},"Request":{"type":"object","description":"Fields that can be sent when creating or updating an HTTP Connector","properties":{"name":{"type":"string","description":"Human-readable name for this HTTP Connector","maxLength":255},"published":{"type":"boolean","description":"Whether this HTTP Connector is published"},"baseURIs":{"type":"array","description":"Base URI templates for this connector (used when apis[] is empty)","items":{"type":"string"}},"helpURL":{"type":"string","description":"Optional documentation URL"},"legacyId":{"type":"string","description":"Optional legacy assistant id for this connector"},"isGraphQL":{"type":"boolean","description":"Whether this connector represents a GraphQL API"},"requireBodyMatchForLinking":{"type":"boolean","description":"Require body matching for auto-linking"},"disableAutoLinking":{"type":"boolean","description":"Disable auto-linking behavior"},"versioning":{"type":"object","description":"Versioning strategy for this connector","properties":{"location":{"type":"string","enum":["uri","query_parameter","header"]},"headerName":{"type":"string"},"queryParameterName":{"type":"string"}}},"versions":{"type":"array","description":"Connector versions (used when apis[] is empty)","items":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"Version identifier","readOnly":true},"name":{"type":"string"},"published":{"type":"boolean"},"baseURIs":{"type":"array","items":{"type":"string"}},"supportedBy":{"type":"object","description":"Supported-by configuration for this version (framework-defined)","additionalProperties":true}}}},"apis":{"type":"array","description":"Optional API groups under this connector","items":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","readOnly":true},"name":{"type":"string"},"description":{"type":"string","maxLength":10240},"published":{"type":"boolean"},"baseURIs":{"type":"array","items":{"type":"string"}},"helpURL":{"type":"string"},"legacyId":{"type":"string"},"isGraphQL":{"type":"boolean"},"versioning":{"type":"object","additionalProperties":true},"versions":{"type":"array","items":{"type":"object","additionalProperties":true}},"supportedBy":{"type":"object","additionalProperties":true},"setDefault":{"type":"boolean"}}}},"supportedBy":{"type":"object","description":"Supported-by configuration for this connector (framework-defined)","additionalProperties":true},"preBuiltExports":{"type":"array","description":"Optional references to pre-built exports associated with this connector","items":{"type":"object","properties":{"_exportId":{"type":"string","format":"objectId"},"published":{"type":"boolean"}},"required":["_exportId"]}},"preBuiltImports":{"type":"array","description":"Optional references to pre-built imports associated with this connector","items":{"type":"object","properties":{"_importId":{"type":"string","format":"objectId"},"published":{"type":"boolean"}},"required":["_importId"]}}},"required":["name"]},"ResourceResponse":{"type":"object","description":"Core response fields shared by all Celigo resources","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource.\n\nThe _id is used in:\n- API endpoints that operate on a specific resource (e.g., GET, PUT, DELETE)\n- References from other resources (e.g., flows that use this resource)\n- Job history and error tracking\n\nFormat: 24-character hexadecimal string\n"},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was initially created.\n\nThis read-only field is automatically set during resource creation and cannot\nbe modified. It provides an audit trail for when the resource was first added\nto the system, which can be useful for:\n\n- Resource lifecycle management\n- Audit and compliance reporting\n- Troubleshooting integration timelines\n- Identifying older resources that may need review\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix).\n"},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was most recently updated.\n\nThis read-only field is automatically updated whenever any property of the\nresource is modified. It provides an audit trail that can be used for:\n\n- Determining if a resource has changed since it was last reviewed\n- Monitoring configuration changes during troubleshooting\n- Implementing cache invalidation strategies\n- Synchronizing related resources based on modification time\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix)\nand will always be equal to or later than the createdAt timestamp.\n"},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was marked for deletion.\n\nWhen this field is present and contains a valid timestamp, it indicates\nthat the resource has been soft-deleted (moved to the recycle bin) but not\nyet permanently removed from the system. This allows for recovery of\naccidentally deleted resources within a specified retention period.\n\nThe deletedAt timestamp enables:\n- Filtering deleted resources from active resource listings\n- Implementing time-based retention policies for permanent deletion\n- Tracking deletion events for audit and compliance purposes\n- Resource recovery workflows with clear timeframes\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix).\nWhen null or absent, the resource is considered active.\n"}},"required":["_id"]},"IAResourceResponse":{"type":"object","description":"Integration app response fields for resources that are part of integration apps","properties":{"_integrationId":{"type":"string","format":"objectId","readOnly":true,"description":"Reference to the specific integration instance that contains this resource.\n\nThis field is only populated for resources that are part of an integration app\ninstallation. It contains the unique identifier (_id) of the integration\nresource that was installed in the account.\n\nThe integration instance represents a specific installed instance of an\nintegration app, with its own configuration, settings, and runtime environment.\n\nThis reference enables:\n- Tracing the resource back to its parent integration instance\n- Permission and access control based on integration ownership\n- Lifecycle management (enabling/disabling, updating, or uninstalling)\n"},"_connectorId":{"type":"string","format":"objectId","readOnly":true,"description":"Reference to the integration app that defines this resource.\n\nThis field is only populated for resources that are part of an integration app.\nIt contains the unique identifier (_id) of the integration app (connector)\nthat defines the structure, behavior, and templates for this resource.\n\nThe integration app is the published template that can be installed\nmultiple times across different accounts, with each installation creating\na separate integration instance (referenced by _integrationId).\n\nThis reference enables:\n- Identifying the source integration app for this resource\n- Determining which template version is being used\n- Linking to documentation, support, and marketplace information\n"}}}},"responses":{"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}}}},"paths":{"/v1/httpconnectors":{"get":{"summary":"List HTTP connectors","description":"Returns a list of all HTTP Connectors in the account.\n","operationId":"listHttpConnectors","tags":["HTTP Connectors"],"parameters":[{"name":"publishedOnly","in":"query","description":"If true, only return published HTTP Connectors","schema":{"type":"boolean"}},{"$ref":"#/components/parameters/Include"},{"$ref":"#/components/parameters/Exclude"}],"responses":{"200":{"description":"Successfully retrieved list of HTTP Connectors","headers":{"Link":{"description":"RFC-5988 pagination links. When more pages remain, includes a `<...>; rel=\"next\"` entry;\nabsent on the final page.\n","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Response"}}}}},"204":{"description":"No HTTP Connectors exist in the account"},"401":{"$ref":"#/components/responses/401-unauthorized"}}}}}}
```
## Create an HTTP connector
> Creates a new HTTP Connector framework definition.
```json
{"openapi":"3.1.0","info":{"title":"HTTP Connectors","version":"1.0.0"},"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Request":{"type":"object","description":"Fields that can be sent when creating or updating an HTTP Connector","properties":{"name":{"type":"string","description":"Human-readable name for this HTTP Connector","maxLength":255},"published":{"type":"boolean","description":"Whether this HTTP Connector is published"},"baseURIs":{"type":"array","description":"Base URI templates for this connector (used when apis[] is empty)","items":{"type":"string"}},"helpURL":{"type":"string","description":"Optional documentation URL"},"legacyId":{"type":"string","description":"Optional legacy assistant id for this connector"},"isGraphQL":{"type":"boolean","description":"Whether this connector represents a GraphQL API"},"requireBodyMatchForLinking":{"type":"boolean","description":"Require body matching for auto-linking"},"disableAutoLinking":{"type":"boolean","description":"Disable auto-linking behavior"},"versioning":{"type":"object","description":"Versioning strategy for this connector","properties":{"location":{"type":"string","enum":["uri","query_parameter","header"]},"headerName":{"type":"string"},"queryParameterName":{"type":"string"}}},"versions":{"type":"array","description":"Connector versions (used when apis[] is empty)","items":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"Version identifier","readOnly":true},"name":{"type":"string"},"published":{"type":"boolean"},"baseURIs":{"type":"array","items":{"type":"string"}},"supportedBy":{"type":"object","description":"Supported-by configuration for this version (framework-defined)","additionalProperties":true}}}},"apis":{"type":"array","description":"Optional API groups under this connector","items":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","readOnly":true},"name":{"type":"string"},"description":{"type":"string","maxLength":10240},"published":{"type":"boolean"},"baseURIs":{"type":"array","items":{"type":"string"}},"helpURL":{"type":"string"},"legacyId":{"type":"string"},"isGraphQL":{"type":"boolean"},"versioning":{"type":"object","additionalProperties":true},"versions":{"type":"array","items":{"type":"object","additionalProperties":true}},"supportedBy":{"type":"object","additionalProperties":true},"setDefault":{"type":"boolean"}}}},"supportedBy":{"type":"object","description":"Supported-by configuration for this connector (framework-defined)","additionalProperties":true},"preBuiltExports":{"type":"array","description":"Optional references to pre-built exports associated with this connector","items":{"type":"object","properties":{"_exportId":{"type":"string","format":"objectId"},"published":{"type":"boolean"}},"required":["_exportId"]}},"preBuiltImports":{"type":"array","description":"Optional references to pre-built imports associated with this connector","items":{"type":"object","properties":{"_importId":{"type":"string","format":"objectId"},"published":{"type":"boolean"}},"required":["_importId"]}}},"required":["name"]},"Response":{"type":"object","description":"HTTP Connector object as returned by the API","allOf":[{"$ref":"#/components/schemas/Request"},{"$ref":"#/components/schemas/ResourceResponse"},{"$ref":"#/components/schemas/IAResourceResponse"},{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"Unique identifier for the HTTP Connector","readOnly":true},"_userId":{"type":"string","format":"objectId","description":"Owner user id","readOnly":true},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when created","readOnly":true},"lastModified":{"type":"string","format":"date-time","description":"Timestamp when last modified","readOnly":true},"deletedAt":{"type":"string","format":"date-time","description":"Timestamp when soft-deleted (if applicable)","readOnly":true},"__numOfBlobEndpoints":{"type":"number","description":"Number of blob endpoints for this connector","readOnly":true}}}]},"ResourceResponse":{"type":"object","description":"Core response fields shared by all Celigo resources","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource.\n\nThe _id is used in:\n- API endpoints that operate on a specific resource (e.g., GET, PUT, DELETE)\n- References from other resources (e.g., flows that use this resource)\n- Job history and error tracking\n\nFormat: 24-character hexadecimal string\n"},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was initially created.\n\nThis read-only field is automatically set during resource creation and cannot\nbe modified. It provides an audit trail for when the resource was first added\nto the system, which can be useful for:\n\n- Resource lifecycle management\n- Audit and compliance reporting\n- Troubleshooting integration timelines\n- Identifying older resources that may need review\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix).\n"},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was most recently updated.\n\nThis read-only field is automatically updated whenever any property of the\nresource is modified. It provides an audit trail that can be used for:\n\n- Determining if a resource has changed since it was last reviewed\n- Monitoring configuration changes during troubleshooting\n- Implementing cache invalidation strategies\n- Synchronizing related resources based on modification time\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix)\nand will always be equal to or later than the createdAt timestamp.\n"},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was marked for deletion.\n\nWhen this field is present and contains a valid timestamp, it indicates\nthat the resource has been soft-deleted (moved to the recycle bin) but not\nyet permanently removed from the system. This allows for recovery of\naccidentally deleted resources within a specified retention period.\n\nThe deletedAt timestamp enables:\n- Filtering deleted resources from active resource listings\n- Implementing time-based retention policies for permanent deletion\n- Tracking deletion events for audit and compliance purposes\n- Resource recovery workflows with clear timeframes\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix).\nWhen null or absent, the resource is considered active.\n"}},"required":["_id"]},"IAResourceResponse":{"type":"object","description":"Integration app response fields for resources that are part of integration apps","properties":{"_integrationId":{"type":"string","format":"objectId","readOnly":true,"description":"Reference to the specific integration instance that contains this resource.\n\nThis field is only populated for resources that are part of an integration app\ninstallation. It contains the unique identifier (_id) of the integration\nresource that was installed in the account.\n\nThe integration instance represents a specific installed instance of an\nintegration app, with its own configuration, settings, and runtime environment.\n\nThis reference enables:\n- Tracing the resource back to its parent integration instance\n- Permission and access control based on integration ownership\n- Lifecycle management (enabling/disabling, updating, or uninstalling)\n"},"_connectorId":{"type":"string","format":"objectId","readOnly":true,"description":"Reference to the integration app that defines this resource.\n\nThis field is only populated for resources that are part of an integration app.\nIt contains the unique identifier (_id) of the integration app (connector)\nthat defines the structure, behavior, and templates for this resource.\n\nThe integration app is the published template that can be installed\nmultiple times across different accounts, with each installation creating\na separate integration instance (referenced by _integrationId).\n\nThis reference enables:\n- Identifying the source integration app for this resource\n- Determining which template version is being used\n- Linking to documentation, support, and marketplace information\n"}}},"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}},"responses":{"400-bad-request":{"description":"Bad request. The server could not understand the request because of malformed syntax or invalid parameters.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}},"403-forbidden":{"description":"Forbidden. The authenticated caller does not have permission to perform this operation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422-unprocessable-entity":{"description":"Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/httpconnectors":{"post":{"summary":"Create an HTTP connector","description":"Creates a new HTTP Connector framework definition.\n","operationId":"createHttpConnector","tags":["HTTP Connectors"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"responses":{"201":{"description":"HTTP Connector created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/400-bad-request"},"401":{"$ref":"#/components/responses/401-unauthorized"},"403":{"$ref":"#/components/responses/403-forbidden"},"422":{"$ref":"#/components/responses/422-unprocessable-entity"}}}}}}
```
## Get an HTTP connector
> Retrieves a specific HTTP Connector by its unique identifier.
```json
{"openapi":"3.1.0","info":{"title":"HTTP Connectors","version":"1.0.0"},"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Response":{"type":"object","description":"HTTP Connector object as returned by the API","allOf":[{"$ref":"#/components/schemas/Request"},{"$ref":"#/components/schemas/ResourceResponse"},{"$ref":"#/components/schemas/IAResourceResponse"},{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"Unique identifier for the HTTP Connector","readOnly":true},"_userId":{"type":"string","format":"objectId","description":"Owner user id","readOnly":true},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when created","readOnly":true},"lastModified":{"type":"string","format":"date-time","description":"Timestamp when last modified","readOnly":true},"deletedAt":{"type":"string","format":"date-time","description":"Timestamp when soft-deleted (if applicable)","readOnly":true},"__numOfBlobEndpoints":{"type":"number","description":"Number of blob endpoints for this connector","readOnly":true}}}]},"Request":{"type":"object","description":"Fields that can be sent when creating or updating an HTTP Connector","properties":{"name":{"type":"string","description":"Human-readable name for this HTTP Connector","maxLength":255},"published":{"type":"boolean","description":"Whether this HTTP Connector is published"},"baseURIs":{"type":"array","description":"Base URI templates for this connector (used when apis[] is empty)","items":{"type":"string"}},"helpURL":{"type":"string","description":"Optional documentation URL"},"legacyId":{"type":"string","description":"Optional legacy assistant id for this connector"},"isGraphQL":{"type":"boolean","description":"Whether this connector represents a GraphQL API"},"requireBodyMatchForLinking":{"type":"boolean","description":"Require body matching for auto-linking"},"disableAutoLinking":{"type":"boolean","description":"Disable auto-linking behavior"},"versioning":{"type":"object","description":"Versioning strategy for this connector","properties":{"location":{"type":"string","enum":["uri","query_parameter","header"]},"headerName":{"type":"string"},"queryParameterName":{"type":"string"}}},"versions":{"type":"array","description":"Connector versions (used when apis[] is empty)","items":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"Version identifier","readOnly":true},"name":{"type":"string"},"published":{"type":"boolean"},"baseURIs":{"type":"array","items":{"type":"string"}},"supportedBy":{"type":"object","description":"Supported-by configuration for this version (framework-defined)","additionalProperties":true}}}},"apis":{"type":"array","description":"Optional API groups under this connector","items":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","readOnly":true},"name":{"type":"string"},"description":{"type":"string","maxLength":10240},"published":{"type":"boolean"},"baseURIs":{"type":"array","items":{"type":"string"}},"helpURL":{"type":"string"},"legacyId":{"type":"string"},"isGraphQL":{"type":"boolean"},"versioning":{"type":"object","additionalProperties":true},"versions":{"type":"array","items":{"type":"object","additionalProperties":true}},"supportedBy":{"type":"object","additionalProperties":true},"setDefault":{"type":"boolean"}}}},"supportedBy":{"type":"object","description":"Supported-by configuration for this connector (framework-defined)","additionalProperties":true},"preBuiltExports":{"type":"array","description":"Optional references to pre-built exports associated with this connector","items":{"type":"object","properties":{"_exportId":{"type":"string","format":"objectId"},"published":{"type":"boolean"}},"required":["_exportId"]}},"preBuiltImports":{"type":"array","description":"Optional references to pre-built imports associated with this connector","items":{"type":"object","properties":{"_importId":{"type":"string","format":"objectId"},"published":{"type":"boolean"}},"required":["_importId"]}}},"required":["name"]},"ResourceResponse":{"type":"object","description":"Core response fields shared by all Celigo resources","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource.\n\nThe _id is used in:\n- API endpoints that operate on a specific resource (e.g., GET, PUT, DELETE)\n- References from other resources (e.g., flows that use this resource)\n- Job history and error tracking\n\nFormat: 24-character hexadecimal string\n"},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was initially created.\n\nThis read-only field is automatically set during resource creation and cannot\nbe modified. It provides an audit trail for when the resource was first added\nto the system, which can be useful for:\n\n- Resource lifecycle management\n- Audit and compliance reporting\n- Troubleshooting integration timelines\n- Identifying older resources that may need review\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix).\n"},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was most recently updated.\n\nThis read-only field is automatically updated whenever any property of the\nresource is modified. It provides an audit trail that can be used for:\n\n- Determining if a resource has changed since it was last reviewed\n- Monitoring configuration changes during troubleshooting\n- Implementing cache invalidation strategies\n- Synchronizing related resources based on modification time\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix)\nand will always be equal to or later than the createdAt timestamp.\n"},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was marked for deletion.\n\nWhen this field is present and contains a valid timestamp, it indicates\nthat the resource has been soft-deleted (moved to the recycle bin) but not\nyet permanently removed from the system. This allows for recovery of\naccidentally deleted resources within a specified retention period.\n\nThe deletedAt timestamp enables:\n- Filtering deleted resources from active resource listings\n- Implementing time-based retention policies for permanent deletion\n- Tracking deletion events for audit and compliance purposes\n- Resource recovery workflows with clear timeframes\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix).\nWhen null or absent, the resource is considered active.\n"}},"required":["_id"]},"IAResourceResponse":{"type":"object","description":"Integration app response fields for resources that are part of integration apps","properties":{"_integrationId":{"type":"string","format":"objectId","readOnly":true,"description":"Reference to the specific integration instance that contains this resource.\n\nThis field is only populated for resources that are part of an integration app\ninstallation. It contains the unique identifier (_id) of the integration\nresource that was installed in the account.\n\nThe integration instance represents a specific installed instance of an\nintegration app, with its own configuration, settings, and runtime environment.\n\nThis reference enables:\n- Tracing the resource back to its parent integration instance\n- Permission and access control based on integration ownership\n- Lifecycle management (enabling/disabling, updating, or uninstalling)\n"},"_connectorId":{"type":"string","format":"objectId","readOnly":true,"description":"Reference to the integration app that defines this resource.\n\nThis field is only populated for resources that are part of an integration app.\nIt contains the unique identifier (_id) of the integration app (connector)\nthat defines the structure, behavior, and templates for this resource.\n\nThe integration app is the published template that can be installed\nmultiple times across different accounts, with each installation creating\na separate integration instance (referenced by _integrationId).\n\nThis reference enables:\n- Identifying the source integration app for this resource\n- Determining which template version is being used\n- Linking to documentation, support, and marketplace information\n"}}},"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}},"responses":{"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}},"403-forbidden":{"description":"Forbidden. The authenticated caller does not have permission to perform this operation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404-not-found":{"description":"Not found. The requested resource does not exist or is not visible to the caller.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/httpconnectors/{_id}":{"get":{"summary":"Get an HTTP connector","description":"Retrieves a specific HTTP Connector by its unique identifier.\n","operationId":"getHttpConnectorById","tags":["HTTP Connectors"],"parameters":[{"in":"path","name":"_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the HTTP Connector"}],"responses":{"200":{"description":"HTTP Connector retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"401":{"$ref":"#/components/responses/401-unauthorized"},"403":{"$ref":"#/components/responses/403-forbidden"},"404":{"$ref":"#/components/responses/404-not-found"}}}}}}
```
## Update an HTTP connector
> Updates an existing HTTP Connector framework definition.
```json
{"openapi":"3.1.0","info":{"title":"HTTP Connectors","version":"1.0.0"},"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"Request":{"type":"object","description":"Fields that can be sent when creating or updating an HTTP Connector","properties":{"name":{"type":"string","description":"Human-readable name for this HTTP Connector","maxLength":255},"published":{"type":"boolean","description":"Whether this HTTP Connector is published"},"baseURIs":{"type":"array","description":"Base URI templates for this connector (used when apis[] is empty)","items":{"type":"string"}},"helpURL":{"type":"string","description":"Optional documentation URL"},"legacyId":{"type":"string","description":"Optional legacy assistant id for this connector"},"isGraphQL":{"type":"boolean","description":"Whether this connector represents a GraphQL API"},"requireBodyMatchForLinking":{"type":"boolean","description":"Require body matching for auto-linking"},"disableAutoLinking":{"type":"boolean","description":"Disable auto-linking behavior"},"versioning":{"type":"object","description":"Versioning strategy for this connector","properties":{"location":{"type":"string","enum":["uri","query_parameter","header"]},"headerName":{"type":"string"},"queryParameterName":{"type":"string"}}},"versions":{"type":"array","description":"Connector versions (used when apis[] is empty)","items":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"Version identifier","readOnly":true},"name":{"type":"string"},"published":{"type":"boolean"},"baseURIs":{"type":"array","items":{"type":"string"}},"supportedBy":{"type":"object","description":"Supported-by configuration for this version (framework-defined)","additionalProperties":true}}}},"apis":{"type":"array","description":"Optional API groups under this connector","items":{"type":"object","properties":{"_id":{"type":"string","format":"objectId","readOnly":true},"name":{"type":"string"},"description":{"type":"string","maxLength":10240},"published":{"type":"boolean"},"baseURIs":{"type":"array","items":{"type":"string"}},"helpURL":{"type":"string"},"legacyId":{"type":"string"},"isGraphQL":{"type":"boolean"},"versioning":{"type":"object","additionalProperties":true},"versions":{"type":"array","items":{"type":"object","additionalProperties":true}},"supportedBy":{"type":"object","additionalProperties":true},"setDefault":{"type":"boolean"}}}},"supportedBy":{"type":"object","description":"Supported-by configuration for this connector (framework-defined)","additionalProperties":true},"preBuiltExports":{"type":"array","description":"Optional references to pre-built exports associated with this connector","items":{"type":"object","properties":{"_exportId":{"type":"string","format":"objectId"},"published":{"type":"boolean"}},"required":["_exportId"]}},"preBuiltImports":{"type":"array","description":"Optional references to pre-built imports associated with this connector","items":{"type":"object","properties":{"_importId":{"type":"string","format":"objectId"},"published":{"type":"boolean"}},"required":["_importId"]}}},"required":["name"]},"Response":{"type":"object","description":"HTTP Connector object as returned by the API","allOf":[{"$ref":"#/components/schemas/Request"},{"$ref":"#/components/schemas/ResourceResponse"},{"$ref":"#/components/schemas/IAResourceResponse"},{"type":"object","properties":{"_id":{"type":"string","format":"objectId","description":"Unique identifier for the HTTP Connector","readOnly":true},"_userId":{"type":"string","format":"objectId","description":"Owner user id","readOnly":true},"createdAt":{"type":"string","format":"date-time","description":"Timestamp when created","readOnly":true},"lastModified":{"type":"string","format":"date-time","description":"Timestamp when last modified","readOnly":true},"deletedAt":{"type":"string","format":"date-time","description":"Timestamp when soft-deleted (if applicable)","readOnly":true},"__numOfBlobEndpoints":{"type":"number","description":"Number of blob endpoints for this connector","readOnly":true}}}]},"ResourceResponse":{"type":"object","description":"Core response fields shared by all Celigo resources","properties":{"_id":{"type":"string","format":"objectId","readOnly":true,"description":"Unique identifier for the resource.\n\nThe _id is used in:\n- API endpoints that operate on a specific resource (e.g., GET, PUT, DELETE)\n- References from other resources (e.g., flows that use this resource)\n- Job history and error tracking\n\nFormat: 24-character hexadecimal string\n"},"createdAt":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was initially created.\n\nThis read-only field is automatically set during resource creation and cannot\nbe modified. It provides an audit trail for when the resource was first added\nto the system, which can be useful for:\n\n- Resource lifecycle management\n- Audit and compliance reporting\n- Troubleshooting integration timelines\n- Identifying older resources that may need review\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix).\n"},"lastModified":{"type":"string","format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was most recently updated.\n\nThis read-only field is automatically updated whenever any property of the\nresource is modified. It provides an audit trail that can be used for:\n\n- Determining if a resource has changed since it was last reviewed\n- Monitoring configuration changes during troubleshooting\n- Implementing cache invalidation strategies\n- Synchronizing related resources based on modification time\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix)\nand will always be equal to or later than the createdAt timestamp.\n"},"deletedAt":{"type":["string","null"],"format":"date-time","readOnly":true,"description":"Timestamp indicating when the resource was marked for deletion.\n\nWhen this field is present and contains a valid timestamp, it indicates\nthat the resource has been soft-deleted (moved to the recycle bin) but not\nyet permanently removed from the system. This allows for recovery of\naccidentally deleted resources within a specified retention period.\n\nThe deletedAt timestamp enables:\n- Filtering deleted resources from active resource listings\n- Implementing time-based retention policies for permanent deletion\n- Tracking deletion events for audit and compliance purposes\n- Resource recovery workflows with clear timeframes\n\nThe timestamp is recorded in ISO 8601 format with UTC timezone (Z suffix).\nWhen null or absent, the resource is considered active.\n"}},"required":["_id"]},"IAResourceResponse":{"type":"object","description":"Integration app response fields for resources that are part of integration apps","properties":{"_integrationId":{"type":"string","format":"objectId","readOnly":true,"description":"Reference to the specific integration instance that contains this resource.\n\nThis field is only populated for resources that are part of an integration app\ninstallation. It contains the unique identifier (_id) of the integration\nresource that was installed in the account.\n\nThe integration instance represents a specific installed instance of an\nintegration app, with its own configuration, settings, and runtime environment.\n\nThis reference enables:\n- Tracing the resource back to its parent integration instance\n- Permission and access control based on integration ownership\n- Lifecycle management (enabling/disabling, updating, or uninstalling)\n"},"_connectorId":{"type":"string","format":"objectId","readOnly":true,"description":"Reference to the integration app that defines this resource.\n\nThis field is only populated for resources that are part of an integration app.\nIt contains the unique identifier (_id) of the integration app (connector)\nthat defines the structure, behavior, and templates for this resource.\n\nThe integration app is the published template that can be installed\nmultiple times across different accounts, with each installation creating\na separate integration instance (referenced by _integrationId).\n\nThis reference enables:\n- Identifying the source integration app for this resource\n- Determining which template version is being used\n- Linking to documentation, support, and marketplace information\n"}}},"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}},"responses":{"400-bad-request":{"description":"Bad request. The server could not understand the request because of malformed syntax or invalid parameters.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}},"403-forbidden":{"description":"Forbidden. The authenticated caller does not have permission to perform this operation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404-not-found":{"description":"Not found. The requested resource does not exist or is not visible to the caller.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422-unprocessable-entity":{"description":"Unprocessable entity. The request was well-formed but was unable to be followed due to semantic errors.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/v1/httpconnectors/{_id}":{"put":{"summary":"Update an HTTP connector","description":"Updates an existing HTTP Connector framework definition.\n","operationId":"updateHttpConnector","tags":["HTTP Connectors"],"parameters":[{"in":"path","name":"_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the HTTP Connector to update"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Request"}}}},"responses":{"200":{"description":"HTTP Connector updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/400-bad-request"},"401":{"$ref":"#/components/responses/401-unauthorized"},"403":{"$ref":"#/components/responses/403-forbidden"},"404":{"$ref":"#/components/responses/404-not-found"},"422":{"$ref":"#/components/responses/422-unprocessable-entity"}}}}}}
```
## Delete an HTTP connector
> Deletes an HTTP Connector. This operation cannot be undone.
```json
{"openapi":"3.1.0","info":{"title":"HTTP Connectors","version":"1.0.0"},"servers":[{"url":"https://api.integrator.io","description":"Production (US / default region)"},{"url":"https://api.eu.integrator.io","description":"Production (EU region)"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"responses":{"400-bad-request":{"description":"Bad request. The server could not understand the request because of malformed syntax or invalid parameters.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401-unauthorized":{"description":"Unauthorized. The request lacks a valid bearer token, or the provided token\nfailed to authenticate.\n\nNote: the 401 response is produced by the auth middleware **before** the\nrequest reaches the endpoint handler, so it does **not** follow the\nstandard `{errors: [...]}` envelope. Instead the body is a bare\n`{message: string}` object with no `code`, no `errors` array. Callers\nhandling 401s should key off the HTTP status and the `message` string,\nnot try to destructure an `errors[]`.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable description of the auth failure. Known values:\n- `\"Unauthorized\"` — no `Authorization` header on the request.\n- `\"Bearer Authentication Failed\"` — header present but token\n is invalid, revoked, or expired."}},"required":["message"]}}}},"403-forbidden":{"description":"Forbidden. The authenticated caller does not have permission to perform this operation.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404-not-found":{"description":"Not found. The requested resource does not exist or is not visible to the caller.\n","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","description":"Standard error response envelope returned by integrator.io APIs.","properties":{"errors":{"type":"array","description":"List of errors that occurred while processing the request.","items":{"type":"object","properties":{"code":{"oneOf":[{"type":"string"},{"type":"integer"}],"description":"Machine-readable error code. Usually a string like\n`invalid_ref`, `missing_required_field`, or `unauthorized`;\nmay be an **integer** when the error mirrors an upstream HTTP\nstatus (e.g. `500`) — most commonly returned by connection-ping\nand adaptor-proxy responses."},"message":{"type":"string","description":"Human-readable description of the error."},"field":{"type":"string","description":"Optional pointer to the document field that caused the error.\nUsed by structural validation errors (`missing_required_field`,\n`invalid_ref`) to indicate which field is at fault\n(e.g. `_id`, `type`, `http.baseURI`)."},"source":{"type":"string","description":"Optional origin layer for the error — e.g. `application` when\nthe error came from the remote system the adaptor called,\n`connector` when the adaptor itself rejected the request."}},"required":["message"]}}},"required":["errors"]}}},"paths":{"/v1/httpconnectors/{_id}":{"delete":{"summary":"Delete an HTTP connector","description":"Deletes an HTTP Connector. This operation cannot be undone.\n","operationId":"deleteHttpConnector","tags":["HTTP Connectors"],"parameters":[{"in":"path","name":"_id","required":true,"schema":{"type":"string"},"description":"The unique identifier of the HTTP Connector to delete"}],"responses":{"204":{"description":"HTTP Connector deleted successfully"},"400":{"$ref":"#/components/responses/400-bad-request"},"401":{"$ref":"#/components/responses/401-unauthorized"},"403":{"$ref":"#/components/responses/403-forbidden"},"404":{"$ref":"#/components/responses/404-not-found"}}}}}}
```
---
# Agent Instructions: 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:
```
GET https://developer.celigo.com/api/api-reference/http-connectors.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.