Sign in

ec90bd653983

latestOpenAPI 3.1.02026-08-1084330443.7 KB

Get Source Metadata

This endpoint gets all source metadata.

get/v1/river_source/metadata

Query parameters

source_name'mysql' | 'postgresql' | 'oracle' | 'mongodb' | 'mssql' | 'mariadb' | 'vertica' | 'elasticsearch' | 'netsuite_analytics' | 'shopify' | 'shopify_graphql' | 'facebook_ads' | 'tiktok' | 'blueprint' | 'bigquery' | 'snowflake' | 'redshift' | 'boomi_for_sap' | 'google_sheets' | 's3' | 'salesforce' | 'hubspot' | 'greenhouse' | 'coupa' | 'sapconcur' | 'successfactors' | 'datahub' | 'native_connector' required

The source type enum provide all the source type options. Values must match data_source_types.api_name in MongoDB.

The source name

Response

Successful Response

titlestring required

The datasource title.

descriptionstring required

The datasource description.

propertiesobject required

The datasource fields and metadata.

requiredstring[] nullable

A list of required datasource fields

Example response

{
  "title": "my title",
  "description": "report description",
  "required": [
    "id"
  ]
}