HTTP Connector Resources

API for reading HTTP Connector Resource objects in Celigo. HTTP Connector Resources represent logical API resource groupings (e.g. "Account", "Contact", "Order") within an HTTP Connector. Each resource is associated with one or more connector versions and contains HTTP Connector Endpoints that define the available operations.

These endpoints are read-only — creating, updating, and deleting HTTP Connector Resources is only available through the Celigo UI (session authentication).

HTTP connector resource schema

List HTTP Connector Resources for a connector

get

/v1/httpconnectors/{_httpConnectorId}/httpconnectorresources

Returns all resources (logical API groupings) defined under the given HTTP Connector.

The list response is abridged — it omits published and _httpConnectorId compared to the detail endpoint. Use GET /v1/httpconnectors/{_httpConnectorId}/{_id} for the full object.

Each resource's _id doubles as the _httpConnectorResourceId path parameter used by the HTTP Connector Endpoints API.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_httpConnectorIdstring · objectIdRequired

HTTP Connector ID

Example: 63987132784a39b73aae63cd

Query parameters

limitinteger · min: 1Optional

Maximum number of records to return per page.

Example: 100

afterstringOptional

Opaque cursor for forward pagination. Pass the value from the Link response header (rel="next") to fetch the next page.

Responses

200

Successfully retrieved list of HTTP Connector Resources

application/json

204

No resources exist for this connector

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

404

Not found. The requested resource does not exist or is not visible to the caller.

application/json

get/v1/httpconnectors/{_httpConnectorId}/httpconnectorresources

GET /v1/httpconnectors/{_httpConnectorId}/httpconnectorresources HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "_id": "63987132784a39b73aae63e7",
    "name": "Answer",
    "createdAt": "2023-01-17T09:51:53.665Z",
    "lastModified": "2024-05-23T07:00:31.350Z",
    "_versionIds": [
      "63987132784a39b73aae63ce"
    ]
  },
  {
    "_id": "63987132784a39b73aae63e1",
    "name": "Attribute",
    "createdAt": "2023-01-17T09:51:52.118Z",
    "lastModified": "2024-05-23T07:00:29.858Z",
    "_versionIds": [
      "63987132784a39b73aae63ce"
    ]
  }
]

Get an HTTP connector resource

get

/v1/httpconnectors/{_httpConnectorId}/{_id}

Retrieves a specific HTTP Connector Resource by its unique identifier.

The path uses a shortcut form: /v1/httpconnectors/{_httpConnectorId}/{_id} where {_id} is the resource ID directly under the connector. The longer form /v1/httpconnectors/{_httpConnectorId}/httpconnectorresources/{_id} is not supported and fails with an invalid_ref error.

The detail response includes published and _httpConnectorId fields that are omitted from the list endpoint.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

_httpConnectorIdstring · objectIdRequired

HTTP Connector ID

Example: 63987132784a39b73aae63cd

_idstring · objectIdRequired

HTTP Connector Resource ID

Example: 63987132784a39b73aae63e7

Responses

200

HTTP Connector Resource retrieved successfully

application/json

HTTP Connector Resource object as returned by the API

_idstring · objectIdRead-onlyRequired

Unique identifier for the HTTP Connector Resource

Example: 63987132784a39b73aae63e7

namestringRequired

Human-readable name for this resource (e.g. "Account", "Contact", "Order")

Example: Account

publishedbooleanRequired

When true, this resource is published and visible to users.

_httpConnectorIdstring · objectIdRead-onlyRequired

Parent HTTP Connector ID. Only present in the detail (by-ID) response, omitted from list responses.

Example: 63987132784a39b73aae63cd

_versionIdsstring · objectId[]Optional

Connector version IDs this resource belongs to

createdAtstring · date-timeRead-onlyRequired

Timestamp when created

Example: 2023-01-17T09:51:53.665Z

lastModifiedstring · date-timeRead-onlyRequired

Timestamp when last modified

Example: 2024-05-23T07:00:31.350Z

400

Invalid resource ID

application/json

401

Unauthorized. The request lacks a valid bearer token, or the provided token failed to authenticate.

Note: the 401 response is produced by the auth middleware before the request reaches the endpoint handler, so it does not follow the standard {errors: [...]} envelope. Instead the body is a bare {message: string} object with no code, no errors array. Callers handling 401s should key off the HTTP status and the message string, not try to destructure an errors[].

application/json

404

Resource not found or not published. Also returned when the _httpConnectorId is valid but the resource ID doesn't belong to it.

application/json

get/v1/httpconnectors/{_httpConnectorId}/{_id}

GET /v1/httpconnectors/{_httpConnectorId}/{_id} HTTP/1.1
Host: api.integrator.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "_id": "63987132784a39b73aae63e7",
  "name": "Answer",
  "createdAt": "2023-01-17T09:51:53.665Z",
  "lastModified": "2024-05-23T07:00:31.350Z",
  "published": true,
  "_httpConnectorId": "63987132784a39b73aae63cd",
  "_versionIds": [
    "63987132784a39b73aae63ce"
  ]
}