REredis
v2
pipelines

Get Pipeline Source Schemas

Changed on

Lists source schemas/databases, tables, and columns for a pipeline source.

get/api/v2/pipelines/{name}/source-schemas/{source_name}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v2/pipelines/{name}/source-schemas/{source_name}
  • Auth
    HTTP bearer

Path parameters

namestring required

Pipeline name

source_namestring required

Pipeline source name

Query parameters

schemasstring nullable

Comma-separated list of schema/database names to filter on

tablesstring nullable

Comma-separated list of table names to filter on

details'schemas' | 'tables' | 'columns'

Detail level for source metadata responses.

The level of detail to return: schemas, tables, or columns

Response

Successful Response

schemasobject

Example response

{
  "schemas": {
    "inventory": {
      "tables": {
        "addresses": {
          "cdc_ready": true,
          "columns": {
            "zip": {
              "primary_key": false,
              "size": 255,
              "type": "varchar",
              "unique_constraint": false
            }
          }
        }
      }
    }
  }
}

Changes

  • 38675c1371b2Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • d5de67e6bd60Revision changes
    • info

      endpoint added