Skip to main content
PATCH
Update a source binding

Authorizations

Authorization
string
header
required

Bearer token authentication (format: "Bearer {token}")

Path Parameters

contextId
string<uuid>
required

Context ID

sourceId
string<uuid>
required

Source ID

bindingId
string<uuid>
required

Binding ID

Body

application/json
connectionId
string<uuid>

Query-rail engine connection reference (UUID). Applies only to query-rail bindings.

Example:

"550e8400-e29b-41d4-a716-446655440000"

enabled
boolean

Whether the binding runs.

Example:

false

format
string

Declared format the binding produces, as a region/family-namespaced descriptor key. The rail (kind) is immutable on update.

Maximum string length: 255
Example:

"br/cnab400/default"

scheduleSpec
string

Interval schedule spec the binding scheduler reads (cron or @every duration).

Maximum string length: 100
Example:

"@every 30m"

transportConfig
object

File-rail transport configuration. Applies only to file-rail bindings.

Response

OK

contextId
string
required

Identifier of the context this binding belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

createdAt
string
required

Creation timestamp in RFC 3339 format.

Example:

"2025-01-15T10:30:00Z"

enabled
boolean
required

Whether the binding runs.

Example:

true

format
string
required

Declared format the binding produces, as a region/family-namespaced descriptor key.

Example:

"br/cnab400/default"

id
string
required

Unique identifier of the binding.

Example:

"550e8400-e29b-41d4-a716-446655440000"

kind
enum<string>
required

Rail the source is pulled on. file fetches files via a transport; query pulls rows through a discovery-engine connection.

Available options:
file,
query
Example:

"file"

scheduleSpec
string
required

Interval schedule spec the binding scheduler reads (cron or @every duration).

Example:

"@every 1h"

sourceId
string
required

Identifier of the source this binding belongs to.

Example:

"550e8400-e29b-41d4-a716-446655440000"

updatedAt
string
required

Last update timestamp in RFC 3339 format.

Example:

"2025-01-15T10:30:00Z"

connectionId
string

Query-rail engine connection reference (UUID). Omitted for file-rail bindings.

Example:

"550e8400-e29b-41d4-a716-446655440000"

transportConfig
object

File-rail transport configuration. Omitted for query-rail bindings.