Legacy Data Integration API Reference (1.0.0) - GetRiver

Toggle Pane

• Get River
  • getGet Rivers List
  • getGet River

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration.

Get River

Get River (or Rivers) and its properties.

Get Rivers List

List all rivers under the acoount-environment the token refers to

• scope: river:list

Authorizations:

BearerToken

query Parameters

group

string An optional parameter that will filter rivers by group name

Responses

Response Schema: application/json

cross_id	string (CrossIdSchema) Cross ID is a referenced ID which crosses between environment and accounts. In this case, the id can be stay the same, but reference between environments and accounts in rivers/connections/logic rivers, etc...
river_id	string (RiverIdSchema) The river cross id which the sub river is refered to. Every sub river can be reference only one river id.
	object (River Definition Schema) A schema for the river's definition.

Data Integration Console (US)

https://console.rivery.io/api/rivers

Data Integration Console (EU)

https://eu-west-1.console.rivery.io/api/rivers

Request samples

• cURL
• Python

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

Response samples

• 200

Content type

application/json

{

• "cross_id": "5faa7bd17bedeb66f4c287c7",
• "river_id": "5faa76e31e78e0001d61d7cf",
• "river_definitions": {

  • "river_insert_date": "string",
  • "river_modified_date": "string",
  • "river_time_created": "string",
  • "updated_by_name": "string",
  • "river_type_title": "string",
  • "river_name": "string",
  • "is_master_river": null,
  • "subrivers_enabled": null,
  • "source": { },
  • "target": { },
  • "is_scheduled": null,
  • "group_id": "string"

  }

}

Get River

Get a River by the River ID

• scope: river:list

Authorizations:

BearerToken

Responses

Response Schema: application/json

cross_id	string (CrossIdSchema) Cross ID is a referenced ID which crosses between environment and accounts. In this case, the id can be stay the same, but reference between environments and accounts in rivers/connections/logic rivers, etc...
river_id	string (RiverIdSchema) The river cross id which the sub river is refered to. Every sub river can be reference only one river id.
	object (River Definition Schema) A schema for the river's definition.

Data Integration Console (US)

https://console.rivery.io/api/rivers/<river_id>

Data Integration Console (EU)

https://eu-west-1.console.rivery.io/api/rivers/<river_id>

Request samples

• cURL
• Python

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

Response samples

• 200

Content type

application/json

{

• "cross_id": "5faa7bd17bedeb66f4c287c7",
• "river_id": "5faa76e31e78e0001d61d7cf",
• "river_definitions": {

  • "river_insert_date": "string",
  • "river_modified_date": "string",
  • "river_time_created": "string",
  • "updated_by_name": "string",
  • "river_type_title": "string",
  • "river_name": "string",
  • "is_master_river": null,
  • "subrivers_enabled": null,
  • "source": { },
  • "target": { },
  • "is_scheduled": null,
  • "group_id": "string"

  }

}