client.connectors.update(
"{connector_id}",
custom_instructions=(
"Aurora was renamed to Nimbus in January 2025; they are the same product. "
"Index all Aurora content under Nimbus."
),
sync_interval_seconds=3600,
)
await client.connectors.update({
id: "{connector_id}",
customInstructions:
"Aurora was renamed to Nimbus in January 2025; they are the same product. " +
"Index all Aurora content under Nimbus.",
syncIntervalSeconds: 3600,
});
curl -X PATCH 'https://api.hydradb.com/connectors/{id}' \
-H "Authorization: Bearer $HYDRADB_API_KEY" \
-H "API-Version: 2" \
-H "Content-Type: application/json" \
-d '{
"custom_instructions": "Aurora was renamed to Nimbus in January 2025; they are the same product. Index all Aurora content under Nimbus.",
"sync_interval_seconds": 3600
}'
{
"connector_id": "{connector_id}",
"sync_interval_seconds": 3600,
"enforce_acl": false,
"next_sync_at": "2026-06-01T13:00:00Z",
"min_sync_interval_seconds": 300,
"max_sync_interval_seconds": 604800,
"custom_instructions_updated": true
}
Connectors
Update Connector
Change a connector’s instructions, sync interval, credentials, or ACL enforcement in place.
PATCH
/
connectors
/
{id}
client.connectors.update(
"{connector_id}",
custom_instructions=(
"Aurora was renamed to Nimbus in January 2025; they are the same product. "
"Index all Aurora content under Nimbus."
),
sync_interval_seconds=3600,
)
await client.connectors.update({
id: "{connector_id}",
customInstructions:
"Aurora was renamed to Nimbus in January 2025; they are the same product. " +
"Index all Aurora content under Nimbus.",
syncIntervalSeconds: 3600,
});
curl -X PATCH 'https://api.hydradb.com/connectors/{id}' \
-H "Authorization: Bearer $HYDRADB_API_KEY" \
-H "API-Version: 2" \
-H "Content-Type: application/json" \
-d '{
"custom_instructions": "Aurora was renamed to Nimbus in January 2025; they are the same product. Index all Aurora content under Nimbus.",
"sync_interval_seconds": 3600
}'
{
"connector_id": "{connector_id}",
"sync_interval_seconds": 3600,
"enforce_acl": false,
"next_sync_at": "2026-06-01T13:00:00Z",
"min_sync_interval_seconds": 300,
"max_sync_interval_seconds": 604800,
"custom_instructions_updated": true
}
Updates a connector’s instructions, sync interval, credentials, or ACL enforcement. Omitted fields keep their existing values.
A connector’s
client.connectors.update(
"{connector_id}",
custom_instructions=(
"Aurora was renamed to Nimbus in January 2025; they are the same product. "
"Index all Aurora content under Nimbus."
),
sync_interval_seconds=3600,
)
await client.connectors.update({
id: "{connector_id}",
customInstructions:
"Aurora was renamed to Nimbus in January 2025; they are the same product. " +
"Index all Aurora content under Nimbus.",
syncIntervalSeconds: 3600,
});
curl -X PATCH 'https://api.hydradb.com/connectors/{id}' \
-H "Authorization: Bearer $HYDRADB_API_KEY" \
-H "API-Version: 2" \
-H "Content-Type: application/json" \
-d '{
"custom_instructions": "Aurora was renamed to Nimbus in January 2025; they are the same product. Index all Aurora content under Nimbus.",
"sync_interval_seconds": 3600
}'
{
"connector_id": "{connector_id}",
"sync_interval_seconds": 3600,
"enforce_acl": false,
"next_sync_at": "2026-06-01T13:00:00Z",
"min_sync_interval_seconds": 300,
"max_sync_interval_seconds": 604800,
"custom_instructions_updated": true
}
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_instructionsapplies to resources without their own instructions. Send""to clear it. Changes affect future syncs. See Custom ingestion instructions.sync_interval_secondsreschedules the next sync. Stay within the returnedmin_sync_interval_secondsandmax_sync_interval_seconds, or send0for the provider default.credentialsreconnects the existing connector. Send the provider’s complete credential set. Resources and saved sync positions are preserved.enforce_aclenables or disables ACL enforcement for this connector. Sendtrueto enforce the captured ACL for the authenticated caller on every content read, orfalseto return to opt-in requestaclfiltering. Existing connectors remainfalseuntil 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, andtruerequires the provider to reportacl_supported: true. API-key-authenticated requests cannot set it. See ACL on synced content and Query.
PATCH request, or use Enforce ACL in the dashboard’s connector settings:
{
"enforce_acl": true
}
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 reportacl_supportedforenforce_acl: true,custom_instructionsis over 4,000 characters, orsync_interval_secondsis outside the provider’s range. Nothing is changed.403: the request tries to setenforce_aclwithout a signed-in dashboard session for a workspace owner or writer. The ACL authorization error message isonly workspace owners and writers can change ACL enforcement.404: no connector with this id in your organization.422:credentialsdoes not match the provider’scredential_schema.503: HydraDB could not read its provider catalog to checkacl_supportedforenforce_acl: true. Nothing is changed. Retry the request.
Related resources
- Update Connector Resource: instructions for one resource
- Custom ingestion instructions: what instructions do and how they combine
- Get Connector: read the stored settings back
Authorizations
Body
application/json
Connector update request
Response
OK
Was this page helpful?
