ListResponse[ReplicationResponse]

Paginated response containing Replication Response records. The required field is items.

items object[]required

List of resource items

Array [

idId (string)required

Server-assigned unique identifier

nameName (string)required

Resource name

alias object

Display name shown to users.

anyOf

• string
• null

string

categoryCategory (string)required

Resource type tag

typeType (string)

Replication mode

Constant value: cdc

Default value: cdc

collection_id object

Parent collection ID

anyOf

• string
• null

string

folder_id object

Identifier of the containing folder.

anyOf

• string
• null

string

tags object

Classification labels

anyOf

• string[]
• null

Array [

string

]

description object

Resource description

anyOf

• string
• null

string

markingsstring[]

Mandatory marking ids this resource requires; read-only — set via the marking guard endpoints, not Create/PATCH.

Default value: []

created_at object

Creation timestamp (Unix ms)

anyOf

• integer
• null

integer

updated_at object

Last update timestamp (Unix ms)

anyOf

• integer
• null

integer

owners object[]

Users and groups that own the resource.

Array [

idId (string)required

"user." | "group." | "public.all"

typeType (string)required

Possible values: [user, group, public]

display_nameDisplay Name (string)required

avatar_url object

anyOf

• string
• null

string

avatar_config object

anyOf

• object
• null

object

email object

anyOf

• string<email>
• null

string<email>

]

my_share_scope object

How the current caller received access to the resource.

anyOf

• string
• null

string

Possible values: [owner, grant, admin]

source object

anyOf

• ReplicationSource
• null

connector_idConnector Id (string)required

Minimum length: 1.

Possible values: non-empty

slotSlot (string)required

Logical replication slot name (required)

Possible values: non-empty

publicationPublication (string)

Publication that decides which tables are streamed

Possible values: non-empty

Default value: datacdc

create_slotCreate Slot (boolean)

Create the slot on start when it does not exist

Default value: true

schema object

Single-relation filter (with table). Omit both to stream the whole publication

anyOf

• string
• null

string

table object

Single-relation filter (with schema)

anyOf

• string
• null

string

tlsTls (boolean)

Connect with TLS

Default value: false

tls_verifyTls Verify (boolean)

Verify the server certificate when tls is on

Default value: true

fetch_timeoutFetch Timeout (string)

Idle wait between change fetches

Default value: 1s

max_changesMax Changes (integer)

Max changes fetched per round

Possible values: >= 1

Default value: 256

commit_intervalCommit Interval (string)

Batch commit interval

Default value: 5s

target object

anyOf

• ReplicationTarget
• null

connector_idConnector Id (string)required

Minimum length: 1.

Possible values: non-empty

schema object

Override the target schema for every event; defaults to the event's own

anyOf

• string
• null

string

tables object

Per-relation target name mapping; unmapped relations keep their source name

property name*string

columns object

Per-relation column selection and rename; a mapped relation keeps only the listed columns

property name* object

property name*string

keystring[]

Key columns for upsert / UPDATE / DELETE. Empty uses the target table's primary key. This is a sink-wide setting in datasink, so a keyless table needs its own Replication

tlsTls (boolean)

Connect with TLS

Default value: false

tls_verifyTls Verify (boolean)

Verify the server certificate when tls is on

Default value: true

itemItem (string)requireddeprecated

]

next_cursor object

Cursor for next page

anyOf

• string
• null

string

has_moreHas More (boolean)

Whether more pages exist

Default value: false

ListResponse[ReplicationResponse]

{
  "items": [
    {
      "id": "string",
      "name": "string",
      "alias": "string",
      "category": "string",
      "type": "cdc",
      "collection_id": "string",
      "folder_id": "string",
      "tags": [
        "string"
      ],
      "description": "string",
      "markings": [
        "string"
      ],
      "created_at": 0,
      "updated_at": 0,
      "owners": [
        {
          "id": "string",
          "type": "user",
          "display_name": "string",
          "avatar_url": "string",
          "avatar_config": {},
          "email": "user@example.com"
        }
      ],
      "my_share_scope": "owner",
      "source": {
        "connector_id": "string",
        "slot": "string",
        "publication": "datacdc",
        "create_slot": true,
        "schema": "string",
        "table": "string",
        "tls": false,
        "tls_verify": true,
        "fetch_timeout": "1s",
        "max_changes": 256,
        "commit_interval": "5s"
      },
      "target": {
        "connector_id": "string",
        "schema": "string",
        "tables": {},
        "columns": {},
        "key": [
          "string"
        ],
        "tls": false,
        "tls_verify": true
      }
    }
  ],
  "next_cursor": "string",
  "has_more": false
}