Boomi Data Integration API Reference (1.0.0) - Rivers

Toggle Pane

• Rivers
  • getList River Versions
  • getGet River Version
  • delDelete River
  • getGet River
  • getList Rivers
  • getGet Cdc Config
  • delDelete Cdc Config
  • postSet Cdc Config
  • getRivers Search
  • postCancel River Run
  • postRun River
  • postRun Sub River
  • putUpdate River Variable
  • getGet River Variables

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration

Rivers

Management of rivers

List River Versions

Authorization scope: river:list

This endpoint returns all river versions for a given river_cross_id.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

query Parameters

items_per_page	integer (Items Per Page) [ 1 .. 500 ] Default: 20 The number of items per page in the paginated list.
page	integer (Page) >= 1 Default: 1 The current page number in the paginated list.

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
account_id required	string (Account Id) The account id
environment_id required	string (Environment Id) The environment id
required	object (RiverVersionsStats) River versions stats fields.
required	Array of objects (Items)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/versions

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/versions

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "account_id": "string",
• "environment_id": "string",
• "statistics": {

  • "bookmarked_versions": 3,
  • "bookmarks_allowed": 30,
  • "total_versions": 3,
  • "snapshot_versions": 2,
  • "versions_allowed": 70

  },
• "items": [

  • {

    • "account_id": "55fr7d4270fdca16cac18261",
    • "user_info": {

      • "user_name": "createdby_username",
      • "user_email": "createdby@rivery.io"

      },
    • "environment_id": "55fr7d4270fdca16cac18261",
    • "insert_date": "2022-08-02T13:38:44.054000",
    • "version_id": "55fr7d4270fdca16cac18261",
    • "previous_version": "55fr7d4270fdca16cac18261",
    • "created_by": "55fr7d4270fdca16cac18261",
    • "river_id": "55fr7d4270fdca16cac18261",
    • "restored_by": "55fr7d4270fdca16cac18261",
    • "restore_date": "2022-08-02T13:38:44.054000",
    • "name": "river_version_name",
    • "bookmarked": false

    }

  ]

}

Get River Version

Authorization scope: river:list

This endpoint returns a given version for a version id and river_cross_id.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
version_id required	string (Version Id)

Responses

Response Schema: application/json

account_id required	string (Account Id) The account id of the river version
environment_id required	string (Environment Id) The environment id of the river version
insert_date required	string <date-time> (Insert Date) The insert date time of the river version in UTC timezone
version_id required	string (Version Id) The version id of the river version
created_by required	string (Created By) The creator id of the river version
river_id required	string (River Id) The river id of the river version
required	LegacyRiverResponse (object) or RiverModel (object) (River) The definition of the river version
	UserInfo (object) or null Contains user name and user email information
	Previous Version (string) or Previous Version (null) (Previous Version) The previous version id of the river version
	Restored By (string) or Restored By (null) (Restored By) The restore id of the river version
	Restore Date (string) or Restore Date (null) (Restore Date) The restore date time of the river version in UTC timezone
	Name (string) or Name (null) (Name) Name of river version
bookmarked	boolean (Bookmarked) Default: false Flag indicating whether the river version is bookmarked or not

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/versions/{version_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/versions/{version_id}

Response samples

• 200
• 422

Content type

application/json

{

• "account_id": "55fr7d4270fdca16cac18261",
• "user_info": {

  • "user_name": "createdby_username",
  • "user_email": "createdby@rivery.io"

  },
• "environment_id": "55fr7d4270fdca16cac18261",
• "insert_date": "2022-08-02T13:38:44.054000",
• "version_id": "55fr7d4270fdca16cac18261",
• "previous_version": "55fr7d4270fdca16cac18261",
• "created_by": "55fr7d4270fdca16cac18261",
• "river_id": "55fr7d4270fdca16cac18261",
• "restored_by": "55fr7d4270fdca16cac18261",
• "restore_date": "2022-08-02T13:38:44.054000",
• "name": "river_version_name",
• "bookmarked": false,
• "river": {

  • "river definition": "some definition"

  }

}

Delete River

Authorization scope: river:write

This endpoint deletes a river

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Responses

Response Schema: application/json

any

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}

Response samples

• 200
• 422

Content type

application/json

null

Get River

Authorization scope: river:list

This endpoint gets a river.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Responses

Response Schema: application/json

cross_id required	string (Cross Id) The river cross id.
account_id required	string (Account Id) The account id.
type required	string (RiverTypeEnum) Enum: "source_to_target" "actions" "logic" "connector_executor" The type of the river.
name required	string (Name) The name of the river.
environment_id required	string (Environment Id) The environment cross id.
environment_name required	string (Environment Name) The environment name.
group_id required	string (Group Id) The group id.
group_name required	string (Group Name) The group name.
required	object (RiverMetadataExtended) The river metadata.
required	any (Properties) The river properties, will change according to the river type.
kind	string (RiverKindEnum) Default: "main_river" Enum: "sub_river" "main_river" The kind of the river.
	RiverSettings (object) or null River settings.
	Array of Schedulers (objects) or Schedulers (null) (Schedulers) Default: [] River schedulers.

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}

Response samples

• 200
• 422

Content type

application/json

{

• "cross_id": "62e7f4352c13160013dc39be",
• "account_id": "62e7f4352c13160013dc39be",
• "kind": "main_river",
• "type": "source_to_target",
• "name": "my_river",
• "environment_id": "62e7f4352c13160013dc39be",
• "environment_name": "my_environment",
• "group_id": "62e7f4352c13160013dc39be",
• "group_name": "my_group",
• "metadata": {

  • "description": "River 1 description",
  • "river_status": "active",
  • "current_version_id": "5f4d3b3d9f9c8b0001f6b0e6",
  • "created_by": "SomeUser",
  • "last_updated_by": "SomeUser",
  • "created_at": "2020-09-01T00:00:00Z",
  • "last_updated_at": "2020-09-01T12:00:00.000Z",
  • "is_deleted": false

  },
• "properties": {

  • "properties_type": "source_to_target",
  • "source": {

    • "name": "mysql",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "run_type": "predefined_report",
    • "cdc_settings": {

      • "default_tables_migration_option": "SKIP_INITIAL_MIGRATION",
      • "include_snapshot_tables": true,
      • "datasource_id": "mysql"

      },
    • "additional_settings": {

      • "extract_method": "all"

      }

    },
  • "target": {

    • "name": "snowflake",
    • "connection_id": "5f4d3b3d9f9c8b0001f6b0e6",
    • "connection_name": "Connection 1",
    • "table_name": "Table 1",
    • "target_prefix": "start_at_",
    • "is_ordered_merge_key": true,
    • "order_expression": "id desc,createDate asc",
    • "loading_method": "merge",
    • "merge_method": "merge",
    • "file_zone_settings": {

      • "path": "my_path",
      • "bucket_name": "my_bucket",
      • "partitioned_kind": "by_day",
      • "fz_loading_mode": "auto-period"

      },
    • "file_path_destination": "path/to/file",
    • "additional_settings": {

      • "key": "value"

      },
    • "database_name": "Database 1",
    • "schema_name": "Schema 1"

    },
  • "schemas": [ ]

  },
• "settings": {

  • "run_timeout_seconds": 43200,
  • "notification": {

    • "warning": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "failure": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      },
    • "run_threshold": {

      • "email": "test@test.com",
      • "is_enabled": true,
      • "execution_time_limit_seconds": 43200

      }

    }

  },
• "schedulers": [ ]

}

List Rivers

Authorization scope: river:list

This endpoint gets a summary of all the rivers in an environment

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

query Parameters

page	integer (Page) >= 1 Default: 1 The current page number in the paginated list.
items_per_page	integer (Items Per Page) [ 1 .. 500 ] Default: 20 The number of items per page in the paginated list.
	Group Name (string) or Group Name (null) (Group Name) The river group name
	Array of Group Id (strings) or Group Id (null) (Group Id) Examples: group_id=5f5b17b0a10e07a4ff4c33 The river group id
	Name (string) or Name (null) (Name) The river name
	RiverScheduleStatusEnum (string) or Schedule (null) (Schedule) The river schedule status
river_status	Array of strings (River Status) Default: "" Items Enum: "active" "disabled" Examples: river_status=active The river status
	RiverInterfaceEnum (string) or Interface Type (null) (Interface Type) The rivers interface type
include_deleted	boolean (Include Deleted) Default: false
sort_by	string (Sort By) Default: "last_updated_at" Enum: "last_updated_at" "source_name" "river_name" "group_name" "group_id" The river sort by filter
sort_order	string (Sort Order) Default: "desc" Enum: "desc" "asc" The river sort order filter
	(Array of River Type (RiverTypeInternalEnum (string) or RiverTypeEnum (string))) or River Type (null) (River Type) The river type

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
account_id required	string (Account Id) The account id
environment_id required	string (Environment Id) The environment id
required	Array of objects (Items)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "account_id": "string",
• "environment_id": "string",
• "items": [

  • {

    • "name": "river_name",
    • "river_status": "active",
    • "group_name": "river_group_1",
    • "group_id": "62e7f4352c13160013dc39be",
    • "river_schedulers": [

      • "0 * * * *",
      • "0 0 1 * *"

      ],
    • "datasource_id": "5f7d4270fdca16cac18261",
    • "last_user_name_modified": "user_name",
    • "river_cross_id": "5f7d4270fdca16cac18261",
    • "last_updated_at": "2021-01-01T00:00:00.000Z",
    • "description": "river_description",
    • "is_api_v2": true,
    • "river_type": "source_to_target",
    • "created_at": "2021-01-01T00:00:00.000Z"

    }

  ]

}

Get Cdc Config

Authorization scope: river:list

This endpoint gets the cdc config: *** Gets cdc offset by provided datasource type to see the last position of the cdc** *** For SQL Server LSN offsets, if a dictionary of LSNs is provided, returns the minimum LSN value**

---

Raises: HTTPException: 400 if no offsets found INTERNAL_SERVICE_ERROR_EXCEPTION: For all other errors (including invalid LSN format, Pydantic validation errors, etc.). Error details will be logged.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Responses

Response Schema: application/json

required	any (Config)
resume_token required string (Resume Token) The resume token offset Last Updated (string) or Last Updated (null) (Last Updated) Default: "2026-01-07T09:47:12.443267Z" datasource_type any (Datasource Type) Default: "mongodb" mongodbmssqlmysqloraclepostgresmongodb Value: "mongodb"

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cdc_config

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cdc_config

Response samples

• 200
• 422

Content type

application/json

{

• "config": {

  • "last_updated": "2026-01-07T09:47:12.443267Z",
  • "datasource_type": "mysql",
  • "binlog_file": "mysql-bin-changelog.000931",
  • "binlog_position": "515820321",
  • "gtid": "51d431b9-585e-11ed-9222-022d1416c792:1-34,7e0646d8-b3e4-11eb-a15e-0a47d4c912dc:1-21343,8937b67f-3ab2-11ea-9bc9-0ad74248f0fe:1-5182243242,c23585e8-579a-11ed-83e3-0a47d4c912dc:1-12"

  }

}

Delete Cdc Config

Authorization scope: river:write

This endpoint delete the cdc config:

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Responses

Response Schema: application/json

any

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cdc_config

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cdc_config

Response samples

• 200
• 422

Content type

application/json

null

Set Cdc Config

Authorization scope: river:write

This endpoint set the cdc config:

---

*** Set the cdc offset that next run of the river can continue from specific position**

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Request Body schema: application/json

required

required	any (Config)
resume_token required string (Resume Token) The resume token offset Last Updated (string) or Last Updated (null) (Last Updated) Default: "2026-01-07T09:47:12.443267Z" datasource_type any (Datasource Type) Default: "mongodb" mongodbmssqlmysqloraclepostgresmongodb Value: "mongodb"

Responses

Response Schema: application/json

any

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cdc_config

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cdc_config

Request samples

• Payload

Content type

application/json

{

• "config": {

  • "last_updated": "2026-01-07T09:47:12.443267Z",
  • "datasource_type": "mysql",
  • "binlog_file": "mysql-bin-changelog.000931",
  • "binlog_position": "515820321",
  • "gtid": "51d431b9-585e-11ed-9222-022d1416c792:1-34,7e0646d8-b3e4-11eb-a15e-0a47d4c912dc:1-21343,8937b67f-3ab2-11ea-9bc9-0ad74248f0fe:1-5182243242,c23585e8-579a-11ed-83e3-0a47d4c912dc:1-12"

  }

}

Response samples

• 200
• 422

Content type

application/json

null

Rivers Search

Authorization scope: river:list

This endpoint searches for rivers for a specific account_id and environment_id, pagination is supported

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)

query Parameters

page	integer (Page) >= 1 Default: 1 The current page number in the paginated list.
items_per_page	integer (Items Per Page) [ 1 .. 500 ] Default: 20 The number of items per page in the paginated list.
	Array of Group Id (strings) or Group Id (null) (Group Id) Examples: group_id=5f5b17b0a10e07a4ff4c33 The river group id
	RiverScheduleStatusEnum (string) or Schedule (null) (Schedule) The river schedule status
	RiverSearchStatusEnum (string) or River Status (null) (River Status) The river status
	RiverInterfaceEnum (string) or Interface Type (null) (Interface Type) Classic or API V2
sort_by	string (Sort By) Default: "river_date_updated" Enum: "river_date_updated" "group_name" "river_name" The river sort by filter
sort_order	string (Sort Order) Default: "desc" Enum: "desc" "asc" The river sort order filter
search_query	string (Search Query)
name	string (Name)
	(Array of River Type (RiverTypeInternalEnum (string) or RiverTypeEnum (string))) or River Type (null) (River Type) The river type

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
account_id required	string (Account Id) The account id
environment_id required	string (Environment Id) The environment id
required	Array of objects (Items) The list of rivers.
items_per_page required	integer (Items Per Page) The number of items per page.
request required	any (Request) the original search request
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers_search

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers_search

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "account_id": "string",
• "environment_id": "string",
• "items": [

  • {

    • "name": "river_name",
    • "river_status": "active",
    • "group_name": "river_group_1",
    • "group_id": "62e7f4352c13160013dc39be",
    • "river_schedulers": [

      • "0 * * * *",
      • "0 0 1 * *"

      ],
    • "datasource_id": "mysql",
    • "target_type": "snowflake",
    • "last_user_name_modified": "user_name",
    • "river_cross_id": "5f7d4270fdca16cac18261",
    • "last_updated_at": "2021-01-01T00:00:00.000Z",
    • "description": "CDC River MySql -> Snowflake to be used by the BI team",
    • "is_api_v2": true,
    • "river_type": "source_to_target",
    • "created_at": "2021-01-01T00:00:00.000Z",
    • "source_task_connection_name": "connection_name",
    • "match_reason": "river_name=river1",
    • "suspended": {

      • "notification_date": "2025-01-01T00:00:00",
      • "suspension_date": "2025-01-08T00:00:00"

      }

    }

  ],
• "items_per_page": 0,
• "request": null

}

Cancel River Run

Authorization scope: river:execute

This endpoint cancels a specific run if run_id is provided or multiple runs if run_group_id is provided.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

Request Body schema: application/json

required

	Run Id (string) or Run Id (null) (Run Id) The run_id to cancel.
	Run Group Id (string) or Run Group Id (null) (Run Group Id) The run_group_id to cancel. Use this field when you want to cancel multiple tables or sub rivers

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cancel_run

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/cancel_run

Request samples

• Payload

Content type

application/json

{

• "run_id": "string",
• "run_group_id": "string"

}

Response samples

• 202
• 422

Content type

application/json

{

• "details": "string"

}

Run River

Authorization scope: river:execute

This endpoint runs a river.

---

Throttling rules: *** River can be executed up to 2 times per minute** *** Each user can execute a river up to 15 times per minute**

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

query Parameters

run_sub_rivers

boolean (Run Sub Rivers) Default: false A flag that indicates whether to run all active sub rivers of the master river

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/run

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/run

Response samples

• 202
• 422

Content type

application/json

{

• "runs": [

  • {

    • "sub_river_id": "62e7f4352c13160013dc39be",
    • "run_id": "1f1468d097754cd8892468c2763ebfe8",
    • "status": "pending",
    • "message": "The river is already in progress."

    }

  ],
• "river_cross_id": "string",
• "run_group_id": "string"

}

Run Sub River

Authorization scope: river:execute

This endpoint runs a sub_river.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)
sub_river_id required	string (Sub River Id)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/sub_rivers/{sub_river_id}/run

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/sub_rivers/{sub_river_id}/run

Response samples

• 202
• 422

Content type

application/json

{

• "runs": [

  • {

    • "sub_river_id": "62e7f4352c13160013dc39be",
    • "run_id": "1f1468d097754cd8892468c2763ebfe8",
    • "status": "pending",
    • "message": "The river is already in progress."

    }

  ],
• "river_cross_id": "string",
• "run_group_id": "string"

}

Update River Variable

Authorization scope: river:write

This endpoint updates a variable for a river. Given a list of variables, it will replace all existing variables for the logic river with the provided list.

Authorizations:

HTTPBearer

path Parameters

river_cross_id required	string (River Cross Id)
account_id required	string (Account Id)
environment_id required	string (Environment Id)

query Parameters

items_per_page	integer (Items Per Page) [ 1 .. 500 ] Default: 20 The number of items per page in the paginated list.
page	integer (Page) >= 1 Default: 1 The current page number in the paginated list.

Request Body schema: application/json

required

required	Array of objects (Items)
Array name required string (Name) The name of the variable required object (RiverVariableSettings) settings class for variable Value (string) or Array of Value (any) or Value (object) or Value (null) (Value) value of a variable

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
account_id required	string (Account Id) The account id
environment_id required	string (Environment Id) The environment id
required	Array of objects (Items)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/variables

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/variables

Request samples

• Payload

Content type

application/json

{

• "items": [

  • {

    • "name": "credentials",
    • "settings": {

      • "clear_value_on_start": true,
      • "is_encrypted": false,
      • "is_multi_value": false

      },
    • "value": "1234"

    }

  ]

}

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "account_id": "string",
• "environment_id": "string",
• "items": [

  • {

    • "account": "55fr7d4270fdca16cac18261",
    • "env_id": "55fr7d4270fdca16cac18261",
    • "river_id": "55fr7d4270fdca16cac18261",
    • "name": "credentials",
    • "settings": {

      • "clear_value_on_start": true,
      • "is_encrypted": false,
      • "is_multi_value": false,
      • "is_private": false

      },
    • "value": "1234"

    }

  ]

}

Get River Variables

Authorization scope: river:list

Get all river variables

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
river_cross_id required	string (River Cross Id)

query Parameters

items_per_page	integer (Items Per Page) [ 1 .. 500 ] Default: 20 The number of items per page in the paginated list.
page	integer (Page) >= 1 Default: 1 The current page number in the paginated list.

Responses

Response Schema: application/json

current_page_size required	integer (Current Page Size) The current page size
account_id required	string (Account Id) The account id
environment_id required	string (Environment Id) The environment id
required	Array of objects (Items)
	Next Page (string) or Next Page (null) (Next Page) The next page URL
	Previous Page (string) or Previous Page (null) (Previous Page) The previous page URL
page	integer (Page) Default: 1 The page number
total_items	integer (Total Items) Default: 0 The total number of entities fetched

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/variables

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/rivers/{river_cross_id}/variables

Response samples

• 200
• 422

Content type

application/json

{

• "next_page": "string",
• "previous_page": "string",
• "page": 1,
• "current_page_size": 0,
• "total_items": 0,
• "account_id": "string",
• "environment_id": "string",
• "items": [

  • {

    • "account": "55fr7d4270fdca16cac18261",
    • "env_id": "55fr7d4270fdca16cac18261",
    • "river_id": "55fr7d4270fdca16cac18261",
    • "name": "credentials",
    • "settings": {

      • "clear_value_on_start": true,
      • "is_encrypted": false,
      • "is_multi_value": false,
      • "is_private": false

      },
    • "value": "1234"

    }

  ]

}