Skip to main content
PATCH
Updates a connector’s instructions, sync interval, credentials, or ACL enforcement. Omitted fields keep their existing values.
custom_instructions_updated and credentials_updated are present when the request changed those fields. Sending {} changes nothing and returns the current interval and the allowed range. HydraDB validates every field before saving, so invalid input changes nothing. Credentials are saved before other settings: if a server error occurs afterward, only the credentials may have changed, and retrying the same request is safe.
  • custom_instructions applies to resources without their own instructions. Send "" to clear it. Changes affect future syncs. See Custom ingestion instructions.
  • sync_interval_seconds reschedules the next sync. Stay within the returned min_sync_interval_seconds and max_sync_interval_seconds, or send 0 for the provider default.
  • credentials reconnects the existing connector. Send the provider’s complete credential set. Resources and saved sync positions are preserved.
  • enforce_acl enables or disables ACL enforcement for this connector. Send true to enforce the captured ACL for the authenticated caller on every content read, or false to return to opt-in request acl filtering. Existing connectors remain false until an owner or writer enables it. The change takes effect on the next content request for already-synced sources and does not require re-ingestion. Only workspace owners and writers in a signed-in dashboard session can set it, and true requires the provider to report acl_supported: true. API-key-authenticated requests cannot set it. See ACL on synced content and Query.
To enable enforcement later, send this field in a PATCH request, or use Enforce ACL in the dashboard’s connector settings:
A connector’s name, database, collection, and provider_account_scope cannot be changed after creation. Omit them from the request; unsupported fields can cause a 400 response.

Errors

  • 400: the request includes an unsupported field, the provider does not report acl_supported for enforce_acl: true, custom_instructions is over 4,000 characters, or sync_interval_seconds is outside the provider’s range. Nothing is changed.
  • 403: the request tries to set enforce_acl without a signed-in dashboard session for a workspace owner or writer. The ACL authorization error message is only workspace owners and writers can change ACL enforcement.
  • 404: no connector with this id in your organization.
  • 422: credentials does not match the provider’s credential_schema.
  • 503: HydraDB could not read its provider catalog to check acl_supported for enforce_acl: true. Nothing is changed. Retry the request.

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer <your_api_key>.

Path Parameters

id
string
required

Connector ID

Example:

"HydraDoc1234"

Body

application/json

Connector update request

credentials
object

Provider-specific credentials. Their shape is the provider's credential_schema from GET /connectors/providers?id=<provider>, for example {"access_token": "..."}.

Example:
custom_instructions
string

Ingestion and indexing instructions for every resource on this connector that has no instructions of its own. Omit to leave unchanged; "" clears. Up to 4000 characters, applied from the next sync.

enforce_acl
boolean

ACL preference for workspace owners and writers in human sessions. Omit to leave unchanged; true requires provider catalog acl_supported.

Example:

true

sync_interval_seconds
integer

How frequently the scheduler triggers incremental syncs, in seconds. Bounded per provider; send 0 or omit to use the provider default. Change it later with PATCH /connectors/{id}.

Example:

3600

Response

OK

connector_id
string
required

Connector this resource belongs to.

Example:

"conn_abc123"

credentials_updated
boolean

true when this request replaced the stored credentials and cleared any reconnect-required state.

Example:

true

custom_instructions_updated
boolean

true when this request set or cleared the connector-level custom_instructions. The change applies from the next sync.

Example:

true

enforce_acl
boolean

The stored ACL enforcement preference.

Example:

true

max_sync_interval_seconds
integer

Largest sync_interval_seconds this connector's provider allows.

Example:

604800

min_sync_interval_seconds
integer

Smallest sync_interval_seconds this connector's provider allows. Values below it are rejected, never clamped.

Example:

300

next_sync_at
string

RFC3339 timestamp when the next scheduled sync will run.

Example:

"2026-07-02T18:00:00Z"

sync_interval_seconds
integer

How frequently the scheduler triggers incremental syncs, in seconds. Bounded per provider; send 0 or omit to use the provider default. Change it later with PATCH /connectors/{id}.

Example:

3600