Waiting for engine...
Skip to main content

Legacy Data Integration API Reference (1.0.0) - DatasourceTypes

Toggle Pane

Download OpenAPI Specification: Download

Datasource Types

Get Datasource List

Get the list of data source types connectors in the platform.

  • scope: datasource:list
Authorizations:
BearerToken

Responses

Response Schema: application/json
Array
name
string
_id
string

datasource type id

segment
string
Enum: "connections" "source" "target"

The "segment" of the datasource. Can be set to target, connection, source, etc.

description
string
section_id
string
status
string
Enum: "enabled" "coming_soon" "beta" "alpha"

The data source status in the platform.

connection_type
string

The connection type that this datasource is connected with

doc_url
string

The connection of the datasource doc link

source_doc_url
string

The datasource "walkthrough" doc link.

Request samples

curl --location --request GET 'https://console.rivery.io/api/datasource_types' \
--header 'Authorization: Bearer <token>'

Response samples

Content type
application/json
[
  • {
    • "name": "facebook ads",
    • "_id": "fb_ads",
    • "segment": "connections",
    • "description": "Facebook Ads Graph API",
    • "section_id": "sec_marketing",
    • "status": "coming_soon",
    • "connection_type": "fb",
    • "source_doc_url": "https://help.boomi.com/..."
    }
]

Get the datasource list by segment

Get the datasource types list by segments (connection/target/source). Use this request in order to get the available sources, targets or connections in Data Integration.

  • scope: datasource:list
Authorizations:
BearerToken

Responses

Response Schema: application/json
Array
name
string
_id
string

datasource type id

segment
string
Enum: "connections" "source" "target"

The "segment" of the datasource. Can be set to target, connection, source, etc.

description
string
section_id
string
status
string
Enum: "enabled" "coming_soon" "beta" "alpha"

The data source status in the platform.

connection_type
string

The connection type that this datasource is connected with

doc_url
string

The connection of the datasource doc link

source_doc_url
string

The datasource "walkthrough" doc link.

Response samples

Content type
application/json
[
  • {
    • "name": "facebook ads",
    • "_id": "fb_ads",
    • "segment": "connections",
    • "description": "Facebook Ads Graph API",
    • "section_id": "sec_marketing",
    • "status": "coming_soon",
    • "connection_type": "fb",
    • "source_doc_url": "https://help.boomi.com/..."
    }
]