Add Connector Resource

Add one new resource to a connector.

POST /connectors/{id}/resources

cURL

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": "C0123456789",
    "resource_type": "channel",
    "display_name": "general",
    "collection_override": "all-hands",
    "filters": { "lookback_days": 30 }
  }'

201

{
  "connector_id": "{connector_id}",
  "resource_id": "C0123456789",
  "resource_type": "channel",
  "display_name": "general",
  "status": "active",
  "provider_cursor": "",
  "database_override": "",
  "collection_override": "all-hands",
  "tenant_id_override": "",
  "sub_tenant_id_override": "all-hands",
  "provider_metadata": null,
  "filters": {
    "lookback_days": 30
  }
}

Adds a single resource to a connector without going through Configure Connector. The resource is picked up by the next scheduled sync; unlike configure, this call does not test access to the resource or start a sync.

Use this only for resources the connector does not have yet. On a resource_id that already exists, this call replaces the whole resource with what you send. Every field you leave out, including its display name, type, collection, instructions and access rule, is cleared, and the resource syncs again from the beginning.

To change a resource that is already configured, use Update Connector Resource for instructions and access rules, or Configure Connector for routing and metadata.

cURL

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": "C0123456789",
    "resource_type": "channel",
    "display_name": "general",
    "collection_override": "all-hands",
    "filters": { "lookback_days": 30 }
  }'

201

{
  "connector_id": "{connector_id}",
  "resource_id": "C0123456789",
  "resource_type": "channel",
  "display_name": "general",
  "status": "active",
  "provider_cursor": "",
  "database_override": "",
  "collection_override": "all-hands",
  "tenant_id_override": "",
  "sub_tenant_id_override": "all-hands",
  "provider_metadata": null,
  "filters": {
    "lookback_days": 30
  }
}

Take resource_id and resource_type from Discover Resources, and always send display_name, since it is what the dashboard shows for the resource.

Related Resources

• Update Connector Resource: change an existing resource
• Configure Connector: add several resources and start a sync
• List Connector Resources: see what is configured

Authorizations

Authorization · string · header · required

API key sent as a Bearer token: "Bearer prefix.secret"

Path Parameters

id · string · required

Connector ID

Example:

"HydraDoc1234"

Body

application/json

Resource configuration

resource_id · string · required

Resource identifier from the Discover endpoint.

Example:

"C0123456789"

acl · string[]

Restricts every object synced from this resource to the listed principals (emails or prefixed principals). Omitted means unrestricted. See Access Control.

additional_metadata · object

Key-value pairs merged into the custom attributes of every synced object. Up to 1 KiB of compact JSON, checked when synced objects are ingested.

Show child attributes

Example:

{ "author": "ada", "doc_version": 3 }

collection_override · string

Routes objects synced from this resource into a specific collection. Empty means the connector's collection.

custom_instructions · string

Ingestion and indexing instructions for this resource, replacing the connector's custom_instructions; empty inherits it. Up to 4000 characters.

database_override · string

Routes objects synced from this resource into a different database. Empty means the connector's database.

display_name · string

Human-readable name for this resource.

Example:

"general"

filters · object

Provider-specific filters applied during sync (e.g. {"lookback_days": 30}).

Show child attributes

Example:

{ "channel": "general" }

metadata · object

Key-value pairs merged into the attributes of every synced object. Up to 16 KiB of compact JSON, checked when synced objects are ingested.

Show child attributes

Example:

{ "department": "finance", "priority": 7 }

provider_metadata · object

Additional provider-supplied metadata for this resource.

Show child attributes

Example:

{ "workspace_id": "T12345ACME" }

resource_type · string

Type of resource within the provider (e.g. channel, repo, linear_team).

Example:

"channel"

sub_tenant_id_override · string · deprecated

Deprecated: use collection_override.

tenant_id_override · string · deprecated

Deprecated: use database_override.

Response

201

application/json

Created

acl · string[]

Principals (emails or prefixed principals) allowed to read objects synced from this resource. Absent means unrestricted; provider permissions take precedence where supported.

acl_warning · string

Why this resource's permissions could not be read. Without an access rule of yours, its objects are readable by everyone meanwhile; with one, your rule applies. Clears on the next successful read.

acl_warning_at · string

When acl_warning last changed (RFC 3339). An unchanged warning keeps its original time.

additional_metadata · object

Key-value pairs merged into the custom attributes (additional_metadata) of every object synced from this resource. Provider-generated fields win on conflict.

Show child attributes

Example:

{ "author": "ada", "doc_version": 3 }

backfill_oldest · string

Oldest point (RFC 3339) the background fetch of older history has reached. Empty when that fetch is finished or not needed.

Example:

"2026-06-01T00:00:00Z"

collection_override · string

Routes this resource's synced objects into a specific collection, overriding the connector's. Formerly sub_tenant_id_override.

connector_id · string

Connector this resource belongs to.

Example:

"conn_abc123"

custom_instructions · string

Ingestion and indexing instructions for this resource, replacing the connector's custom_instructions; empty inherits it. Up to 4000 characters, applied from the next sync.

database_override · string

Database this resource's synced objects are routed to. Empty means the connector's own database.

display_name · string

Human-readable name for this resource.

Example:

"general"

filters · object

Provider-specific filters applied during sync (e.g. {"lookback_days": 30}).

Show child attributes

Example:

{ "channel": "general" }

metadata · object

Key-value pairs merged into the attributes (metadata) of every object synced from this resource. The system fields connector_id and provider always win on conflict.

Show child attributes

Example:

{ "department": "finance", "priority": 7 }

page_acl_warning · string

Set when page-level restrictions in this resource (for example Confluence pages) could not be resolved, so those pages are readable by everyone. Clears after a clean full sync.

page_acl_warning_at · string

When page_acl_warning last changed (RFC 3339).

provider_cursor · string

Bookmark of the last synced position. Non-empty value confirms the first sync has run.

Example:

"1699999999.000100"

provider_metadata · object

Additional provider-supplied metadata for this resource.

Show child attributes

Example:

{ "workspace_id": "T12345ACME" }

resource_id · string

Resource identifier from the Discover endpoint.

Example:

"C0123456789"

resource_type · string

Type of resource within the provider (e.g. channel, repo, linear_team).

Example:

"channel"

status · string

Current sync state of this resource (e.g. active, paused).

Example:

"active"

sub_tenant_id_override · string · deprecated

Deprecated: use collection_override.

sync_blocked · boolean

true when syncing stopped because the provider keeps refusing this resource, for example a deleted table or an inaccessible channel. sync_blocked_reason says why.

Example:

true

sync_blocked_at · string

When syncing of this resource was stopped (RFC 3339). Present only while sync_blocked is true.

sync_blocked_reason · string

The provider's explanation for why this resource is blocked. Present only while sync_blocked is true.

tenant_id_override · string · deprecated

Deprecated: use database_override.