REredis
secure

Get Metadata

Changed on

Returns metadata for the specified schema and tables, for the specified source.

get/api/v1/pipelines/sources/{source_name}/metadata

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/pipelines/sources/{source_name}/metadata
  • Auth
    HTTP bearer

Path parameters

source_namestring required

Query parameters

schemastring nullable

Optional schema name

tablesstring nullable

Optional comma-separated list of table names to filter by

Response

Successful Response

tablesobject required

Example response

{
  "tables": {
    "table1": {
      "cdc_ready": true,
      "columns": {}
    }
  }
}

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

  • f0a3d26cc0c6Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id get_metadata_per_schema_api_v1_pipelines_sources__source_name__metadata_get removed and replaced with get_metadata_api_v1_pipelines_sources__source_name__metadata_get

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status