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}

Update a source binding

cURL

curl --request PATCH \
  --url https://matcher.sandbox.lerian.net/v1/contexts/{contextId}/sources/{sourceId}/bindings/{bindingId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connectionId": "550e8400-e29b-41d4-a716-446655440000",
  "enabled": false,
  "format": "br/cnab400/default",
  "scheduleSpec": "30m"
}
'

200

Example

{
  "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": "1h",
  "sourceId": "550e8400-e29b-41d4-a716-446655440000",
  "updatedAt": "2025-01-15T10:30:00Z",
  "connectionId": "550e8400-e29b-41d4-a716-446655440000",
  "transportConfig": {
    "host": "sftp.bank.example.com",
    "kind": "sftp",
    "connectOptions": {},
    "credentialRef": "cred-bank-sftp",
    "glob": "*.csv",
    "path": "/statements",
    "port": 22
  }
}

Autorizaciones

Authorization · string · header · requerido

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

Parámetros de ruta

contextId · string<uuid> · requerido

Context ID

sourceId · string<uuid> · requerido

Source ID

bindingId · string<uuid> · requerido

Binding ID

Cuerpo

application/json

connectionId · string<uuid>

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

Ejemplo:

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

enabled · boolean

Whether the binding runs.

Ejemplo:

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

Ejemplo:

"br/cnab400/default"

scheduleSpec · string

Interval schedule spec the binding scheduler reads.

Maximum string length: 100

Ejemplo:

"30m"

transportConfig · object

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

Show child attributes

Respuesta

200

application/json

OK

contextId · string · requerido

Identifier of the context this binding belongs to.

Ejemplo:

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

createdAt · string · requerido

Creation timestamp in RFC 3339 format.

Ejemplo:

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

enabled · boolean · requerido

Whether the binding runs.

Ejemplo:

true

format · string · requerido

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

Ejemplo:

"br/cnab400/default"

id · string · requerido

Unique identifier of the binding.

Ejemplo:

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

kind · enum<string> · requerido

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

Opciones disponibles: file, query

Ejemplo:

"file"

scheduleSpec · string · requerido

Interval schedule spec the binding scheduler reads.

Ejemplo:

"1h"

sourceId · string · requerido

Identifier of the source this binding belongs to.

Ejemplo:

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

updatedAt · string · requerido

Last update timestamp in RFC 3339 format.

Ejemplo:

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

connectionId · string

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

Ejemplo:

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

transportConfig · object

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

Show child attributes