Skip to main content
PATCH
Updates one configured resource in place. Send custom_instructions, acl, or both. At least one is required, and any field you omit is left unchanged. This is the safe way to edit a resource that is already syncing. resource_id in the path is the id from List Connector Resources, for example a Slack channel id or a Supabase schema.table name. URL-encode it if it contains spaces or other reserved characters.
  • custom_instructions sets instructions for documents from this resource only. They replace the connector-level instructions for this resource rather than adding to them. Send "" to clear them so the resource uses the connector’s instructions again. Up to 4,000 characters. They apply from the next sync; documents already synced are not processed again. See Custom Ingestion Instructions.
  • acl sets who can read this resource’s objects, and applies to already-synced objects on the next query, with no re-sync. Use ["__public__"] to open the resource to everyone and [] to allow nobody. For providers whose own permissions HydraDB reads, those permissions take over again at the next sync; your rule applies whenever the provider reports the resource as public or its permissions cannot be read. See Access Control.
The response includes custom_instructions and acl only when the request set them, showing the stored values.

Errors

  • 400: neither field was sent, custom_instructions is over 4,000 characters, or the access rule is malformed. Nothing is changed.
  • 404: no connector with this id in your workspace, or no configured resource with this resource_id on it.

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Connector ID

Example:

"HydraDoc1234"

resource_id
string
required

Resource ID

Example:

"C0123456789"

Body

application/json

Resource settings to change

acl
string[]

Who can read this resource's objects: emails, group:<provider>:<id>, domain:<domain>, or ["__public__"]. [] allows nobody. Provider permissions, where read, take over at the next sync.

custom_instructions
string

Ingestion and indexing instructions for this resource, replacing the connector's. Omit to leave unchanged; "" clears back to the connector's. Up to 4000 characters, applied from the next sync.

Response

OK

acl
string[]

The access rule as stored. Present only when the request set acl.

connector_id
string

Connector this resource belongs to.

Example:

"conn_abc123"

custom_instructions
string

The resource's instructions as stored; "" means they were cleared. Present only when the request set them.

custom_instructions_updated
boolean

true when this request set or cleared the resource's custom_instructions.

Example:

true

resource_id
string

Resource identifier from the Discover endpoint.

Example:

"C0123456789"