> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hydradb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Add Connector Resource

> Add a single resource to a connector.

export const Field = ({name, type, required, recommended}) => {
  const label = required ? 'required' : recommended ? 'recommended' : null;
  const typeLabel = typeof type === 'string' ? type : null;
  const ariaParts = [name, typeLabel && `${typeLabel}`, label].filter(Boolean);
  return <span aria-label={ariaParts.join(', ')} className={label ? 'field-wrap has-field-tip' : 'field-wrap'} style={{
    position: 'relative',
    cursor: label ? 'default' : undefined
  }} tabIndex={label ? 0 : undefined}>
      <span className="field-name-row">
        <code>{name}</code>
        {required && <span className="field-req"> *</span>}
        {recommended && <span className="field-rec"> ●</span>}
      </span>
      {type && <span className="field-type">{type}</span>}
      {label && <span className="field-tip" role="tooltip">
          {label}
        </span>}
    </span>;
};

Adds a single resource without going through the full [configure](/api-reference/v2/endpoint/configure-connector) flow. Use [Configure Connector](/api-reference/v2/endpoint/configure-connector) instead when activating multiple resources or setting `metadata` / `lookback_days`.

<RequestExample>
  ```bash cURL theme={"dark"}
  curl -X POST 'https://api.hydradb.com/connectors/{id}/resources' \
    -H "Authorization: Bearer $HYDRA_DB_API_KEY" \
    -H "API-Version: 2" \
    -H "Content-Type: application/json" \
    -d '{
      "resource_id": "{resource_id}",
      "resource_type": "channel",
      "display_name": "general",
      "sub_tenant_id_override": "all-hands"
    }'
  ```
</RequestExample>

## Path parameters

| Name | Description                                    |
| ---- | ---------------------------------------------- |
| `id` | Connector UUID returned by `POST /connectors`. |

## Request body

| Name                                                  | Description                                                                    |
| ----------------------------------------------------- | ------------------------------------------------------------------------------ |
| <Field name="resource_id" type="string" required />   | Resource identifier from `GET /connectors/:id/discover`.                       |
| <Field name="resource_type" type="string" required /> | Resource type from `GET /connectors/:id/discover`.                             |
| <Field name="display_name" type="string" />           | Human-readable name for this resource.                                         |
| <Field name="sub_tenant_id_override" type="string" /> | Routes synced objects from this resource into a specific sub-tenant partition. |

<ResponseExample>
  ```json 201 theme={"dark"}
  {
    "connector_id": "{connector_id}",
    "resource_id": "{resource_id}",
    "resource_type": "channel",
    "display_name": "general",
    "status": "active",
    "provider_cursor": "",
    "tenant_id_override": "",
    "sub_tenant_id_override": "all-hands",
    "provider_metadata": null,
    "filters": null
  }
  ```
</ResponseExample>

<div className="api-before-related-resources" />

## Related Resources

* [List Connector Resources](/api-reference/v2/endpoint/connector-resources)  -  view all resources and sync state
* [Delete Connector Resource](/api-reference/v2/endpoint/delete-connector-resource)  -  remove a resource
* [Configure Connector](/api-reference/v2/endpoint/configure-connector)  -  add multiple resources with metadata and lookback settings


## OpenAPI

````yaml api-reference/v2/openapi.json POST /connectors/{id}/resources
openapi: 3.1.0
info:
  contact:
    email: support@hydradb.com
    name: HydraDB Support
  description: >-
    HydraDB Application API — knowledge ingestion, search, and memory
    management.
  license:
    name: Proprietary
  title: HydraDB Application API
  version: 0.1.0
servers:
  - description: Production server
    url: https://api.hydradb.com
security: []
externalDocs:
  description: ''
  url: ''
paths:
  /connectors/{id}/resources:
    post:
      tags:
        - connectors
      summary: Create a connector resource
      description: Add a resource mapping to a connector.
      parameters:
        - description: Connector ID
          in: path
          name: id
          required: true
          schema:
            example: HydraDoc1234
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/handler.resourceCreateReq'
        description: Resource configuration
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connectors.Resource'
          description: Created
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.ErrorResponse'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.ErrorResponse'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/handler.ErrorResponse'
          description: Internal Server Error
      security:
        - BearerAuth: []
components:
  schemas:
    handler.resourceCreateReq:
      properties:
        additional_metadata:
          additionalProperties: {}
          description: >-
            Key-value pairs merged into document metadata on every synced object
            from this resource.
          example:
            author: ada
            doc_version: 3
          type: object
        collection_override:
          type: string
        database_override:
          type: string
        display_name:
          description: Human-readable name for this resource.
          example: general
          type: string
        filters:
          additionalProperties: {}
          description: >-
            Provider-specific filters applied during sync (e.g.
            `{"lookback_days": 30}`).
          example:
            channel: general
          type: object
        metadata:
          additionalProperties: {}
          description: >-
            Key-value pairs merged into tenant metadata on every synced object
            from this resource.
          example:
            department: finance
            priority: 7
          type: object
        provider_metadata:
          additionalProperties: {}
          description: Additional provider-supplied metadata for this resource.
          example:
            workspace_id: T12345ACME
          type: object
        resource_id:
          description: Resource identifier from the Discover endpoint.
          example: C0123456789
          type: string
        resource_type:
          description: >-
            Type of resource within the provider (e.g. `channel`, `repo`,
            `linear_team`).
          example: channel
          type: string
        sub_tenant_id_override:
          deprecated: true
          description: 'deprecated: use collection_override'
          type: string
          x-deprecated: 'true'
        tenant_id_override:
          deprecated: true
          description: |-
            DatabaseOverride/CollectionOverride are the canonical v2 names;
            TenantIDOverride/SubTenantIDOverride are their deprecated aliases.
          type: string
          x-deprecated: 'true'
      required:
        - resource_id
      type: object
    connectors.Resource:
      properties:
        additional_metadata:
          additionalProperties: {}
          description: >-
            AdditionalMetadata is merged into the additional_metadata (document

            metadata) layer of every object synced from this resource.
            User-supplied

            keys are shallow-merged as the base; provider-generated fields are

            applied on top and always win on conflict.
          example:
            author: ada
            doc_version: 3
          type: object
        backfill_chunk_interval_seconds:
          description: >-
            BackfillChunkIntervalSeconds is the pacing interval persisted at
            configure

            time so the scheduler can thread it into each chunk's workflow
            input.
          example: 86400
          type: integer
        backfill_next_chunk_at:
          description: >-
            BackfillNextChunkAt is the RFC3339 time the next chunk becomes due.
            The

            backfill workflow processes one chunk then sets this to now+interval
            and

            exits; the connector scheduler starts the next chunk once it passes.
          type: string
        backfill_oldest:
          description: >-
            BackfillOldest is an RFC3339 timestamp marking the oldest boundary
            remaining

            for async historical backfill. Empty means backfill is complete or
            not needed.
          example: '2026-06-01T00:00:00Z'
          type: string
        backfill_status:
          description: >-
            BackfillStatus gates the sparse ResourcesByBackfillNextChunkAt GSI:
            it is

            set to BackfillStatusActive while a historical backfill is in
            progress and

            removed when it completes, so only actively-backfilling resources
            appear in

            the scheduler's due query. Pacing between chunks is driven by that
            scheduler

            (see BackfillNextChunkAt), not by an in-workflow sleep.
          type: string
        collection_override:
          description: >-
            Routes this resource's synced objects into a specific collection,
            overriding the connector's. Canonical name; mirrors the deprecated
            `sub_tenant_id_override` alias.
          type: string
        connector_id:
          description: Connector this resource belongs to.
          example: conn_abc123
          type: string
        database_override:
          description: >-
            DatabaseOverride/CollectionOverride are the canonical v2 names for
            the

            deprecated tenant_id_override/sub_tenant_id_override wire fields.
            Empty

            means the resource inherits the connector's database/collection,
            exactly

            as the deprecated fields do. Not persisted (dynamodbav:"-"):
            mirrored from

            the tenant_id_override/sub_tenant_id_override values at construction
            time.
          type: string
        display_name:
          description: Human-readable name for this resource.
          example: general
          type: string
        filters:
          additionalProperties: {}
          description: >-
            Provider-specific filters applied during sync (e.g.
            `{"lookback_days": 30}`).
          example:
            channel: general
          type: object
        metadata:
          additionalProperties: {}
          description: >-
            Metadata is merged into the tenant metadata layer of every object
            synced

            from this resource. User-supplied keys are shallow-merged as the
            base;

            system defaults (connector_id, provider) are applied on top so they

            always win on conflict — user keys extend the map but cannot
            override

            system-set fields.
          example:
            department: finance
            priority: 7
          type: object
        provider_cursor:
          description: >-
            Bookmark of the last synced position. Non-empty value confirms the
            first sync has run.
          example: '1699999999.000100'
          type: string
        provider_metadata:
          additionalProperties: {}
          description: Additional provider-supplied metadata for this resource.
          example:
            workspace_id: T12345ACME
          type: object
        resource_id:
          description: Resource identifier from the Discover endpoint.
          example: C0123456789
          type: string
        resource_type:
          description: >-
            Type of resource within the provider (e.g. `channel`, `repo`,
            `linear_team`).
          example: channel
          type: string
        status:
          description: Current sync state of this resource (e.g. `active`, `paused`).
          example: completed
          type: string
        sub_tenant_id_override:
          deprecated: true
          description: >-
            Overrides the connector-level collection for objects synced from
            this resource.
          type: string
          x-deprecated: 'true'
        tenant_id_override:
          deprecated: true
          description: >-
            Overrides the connector-level database for objects synced from this
            resource. Deprecated.
          type: string
          x-deprecated: 'true'
      type: object
    handler.ErrorResponse:
      properties:
        detail:
          $ref: '#/components/schemas/handler.ErrorDetail'
          description: Structured error detail with code, message, and deprecation hints.
          example:
            deprecated: true
            deprecated_field: tenant_id
            error_code: VALIDATION_ERROR
            message: Request validation failed
            preferred_field: database
            success: true
      type: object
    handler.ErrorDetail:
      properties:
        deprecated:
          description: Whether this response concerns a deprecated field or route.
          example: true
          type: boolean
        deprecated_field:
          description: The deprecated field name.
          example: tenant_id
          type: string
        error_code:
          description: Machine-readable error classification code.
          example: VALIDATION_ERROR
          type: string
        message:
          description: Human-readable description of the error.
          example: Request validation failed
          type: string
        preferred_field:
          description: The canonical replacement for the deprecated field.
          example: database
          type: string
        success:
          description: Always false for error responses.
          example: true
          type: boolean
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: API key
      description: 'API key sent as a Bearer token: "Bearer prefix.secret"'
      scheme: bearer
      type: http

````