v1

latestOpenAPI 3.1.02026-07-263644911022.4 KB

Configuration

Update a source binding

Updates fields on a source binding by ID. The rail (kind) is immutable.

patch/v1/contexts/{contextId}/sources/{sourceId}/bindings/{bindingId}

Path parameters

contextIdstring uuid required

Context ID

sourceIdstring uuid required

Source ID

bindingIdstring uuid required

Binding ID

Request body

connectionIdstring uuid

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

enabledboolean

Whether the binding runs.

formatstring

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

scheduleSpecstring

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

Example request

{
  "connectionId": "550e8400-e29b-41d4-a716-446655440000",
  "format": "br/cnab400/default",
  "scheduleSpec": "@every 30m",
  "transportConfig": {
    "credentialRef": "cred-bank-sftp",
    "glob": "*.csv",
    "host": "sftp.bank.example.com",
    "kind": "sftp",
    "path": "/statements",
    "port": 22
  }
}

Response

connectionIdstring

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

contextIdstring required

Identifier of the context this binding belongs to.

createdAtstring required

Creation timestamp in RFC 3339 format.

enabledboolean required

Whether the binding runs.

formatstring required

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

idstring required

Unique identifier of the binding.

kind'file' | 'query' required

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

scheduleSpecstring required

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

sourceIdstring required

Identifier of the source this binding belongs to.

updatedAtstring required

Last update timestamp in RFC 3339 format.

Example response

{
  "connectionId": "550e8400-e29b-41d4-a716-446655440000",
  "contextId": "550e8400-e29b-41d4-a716-446655440000",
  "createdAt": "2025-01-15T10:30:00Z",
  "enabled": true,
  "format": "br/cnab400/default",
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "kind": "file",
  "scheduleSpec": "@every 1h",
  "sourceId": "550e8400-e29b-41d4-a716-446655440000",
  "transportConfig": {
    "credentialRef": "cred-bank-sftp",
    "glob": "*.csv",
    "host": "sftp.bank.example.com",
    "kind": "sftp",
    "path": "/statements",
    "port": 22
  },
  "updatedAt": "2025-01-15T10:30:00Z"
}