Boomi Data Integration API Reference (1.0.0) - Connections

Toggle Pane

• Connections
  • getGet Connections
  • postAdd Connection
  • putUpdate Connection
  • delDelete Connection
  • postAdd File
  • getGet Connections Types
  • getGet Connection Type
• MCP
  • getGet Connections
  • postAdd Connection
  • putUpdate Connection
  • delDelete Connection

API docs by Redocly

Download OpenAPI Specification: Download

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Find out more about Data Integration

Connections

Management of connection entities

Get Connections

Authorization scope: connection:list

Get all connection entities as a paginated list

---

📖 Instructions for usage

list_connections

List all connections in an environment (sweeps every page in one call).

Returns {items, total_items, page, has_next}. Each item includes connection_name,
connection_type, connection_type_id, and cross_id; use cross_id as connection_id
when creating data flows. If the upstream 500s on a specific page, that page is
skipped and its number is reported under "incomplete_pages" rather than failing
the whole listing.

Authorizations:

HTTPBearer

path Parameters

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.

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}/connections

EU

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

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_id": "string",
    • "environment_id": "string",
    • "cross_id": "5f887c764c40e5598f717676",
    • "_id": "5f887c764c40e5598f717676",
    • "connection_name": "test connection",
    • "connection_type": "Oracle",
    • "connection_type_id": "oracle",
    • "is_test_connection": false,
    • "connection_update_by": "5f887c764c40e5598f717676",
    • "connection_update_time": "2019-08-24T14:15:22Z"

    }

  ]

}

Add Connection

Authorization scope: connection:edit

Creates a new connection entity.

---

📖 Instructions for usage

create_connection

Create a new connection. body must match the CreateConnection API schema.

NOT ALL CONNECTION TYPES CAN BE CREATED HERE. Connections that authenticate
via OAuth (e.g. Google services, Salesforce, HubSpot, Facebook/Meta, LinkedIn,
and similar — anything that needs a browser sign-in / "Connect with..." flow)
CANNOT be created through this tool, because OAuth requires an interactive
browser consent step. For those, tell the user:
"This connection uses OAuth — please create it in the Boomi Data Integration
console, then I can use it here."

This tool works for connections that authenticate with credentials you can
supply directly (host/port/user/password/keys), e.g. databases like mysql,
postgresql, mssql, snowflake, bigquery, redshift, mongodb.

Authorizations:

HTTPBearer

path Parameters

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

Request Body schema: application/json

required

object (Connection To Create)

Responses

US

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

EU

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

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 201
• 422

Content type

application/json

{ }

Update Connection

Authorization scope: connection:edit

This endpoint updates a connection

---

📖 Instructions for usage

update_connection

Update an existing connection.

Authorizations:

HTTPBearer

path Parameters

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

Request Body schema: application/json

required

object (Connection To Update)

Responses

Response Schema: application/json

object (Response Update Connection)

US

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

EU

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

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 422

Content type

application/json

{ }

Delete Connection

Authorization scope: connection:delete

This endpoint deletes a connection

---

📖 Instructions for usage

delete_connection

Delete a connection.

The upstream DELETE returns an empty body on success; this returns
{"deleted": true, "connection_id": ...}.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
connection_cross_id required	string (Connection Cross Id)

Responses

Response Schema: application/json

any

US

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

EU

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

Response samples

• 200
• 422

Content type

application/json

null

Add File

Authorization scope: connection:edit

Uploads a connection file. e.g. a pem file.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
connection_type required	string (Connection Type)

Request Body schema: multipart/form-data

required

file required

string <binary> (File)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/environments/{environment_id}/connections/{connection_type}/files

EU

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

Response samples

• 201
• 422

Content type

application/json

{

• "file_path": "string"

}

Get Connections Types

Authorization scope: connection:list

Get all connection types entities as a paginated list

Authorizations:

HTTPBearer

query Parameters

items_per_page	integer (Items Per Page) [ 1 .. 1000 ] 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
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/connections_types

EU

https://api.eu-west-1.rivery.io/v1/connections_types

Response samples

• 200
• 422

Content type

application/json

{

• "current_page_size": 1,
• "items": [

  • {

    • "fields": {

      • "_id": "5643062270ec07e624d4320d",
      • "allowed_file_extensions": [ ],
      • "connection_type": "spotx",
      • "connection_type_name": "SpotX",
      • "has_key_file": false,
      • "is_test_connection": true,
      • "oauth2": false,
      • "properties": [

        • {

          • "id": "username",
          • "type": "string",
          • "ui_type": "text",
          • "display_name": "Username",
          • "row": 0

          },
        • {

          • "id": "password",
          • "type": "password",
          • "ui_type": "password",
          • "display_name": "Password",
          • "row": 1

          },
        • {

          • "id": "connection_name",
          • "type": "string"

          },
        • {

          • "id": "connection_desc",
          • "type": "string"

          }

        ]

      }

    }

  ],
• "next_page": "https://api.rivery.io/v1/connections_types?items_per_page=1&page=2",
• "page": 1,
• "total_items": 189

}

Get Connection Type

Authorization scope: connection:list

Get a specific connection type entity

Authorizations:

HTTPBearer

path Parameters

connection_type required

string (Connection Type)

Responses

Response Schema: application/json

connection_type required	string (Connection Type)
connection_type_name required	string (Connection Type Name)
properties required	Array of objects (Properties)

US

https://api.rivery.io/v1/connections_types/{connection_type}

EU

https://api.eu-west-1.rivery.io/v1/connections_types/{connection_type}

Response samples

• 200
• 422

Content type

application/json

{

• "connection_type": "string",
• "connection_type_name": "string",
• "properties": [

  • { }

  ]

}

MCP

Get Connections

Authorization scope: connection:list

Get all connection entities as a paginated list

---

📖 Instructions for usage

list_connections

List all connections in an environment (sweeps every page in one call).

Returns {items, total_items, page, has_next}. Each item includes connection_name,
connection_type, connection_type_id, and cross_id; use cross_id as connection_id
when creating data flows. If the upstream 500s on a specific page, that page is
skipped and its number is reported under "incomplete_pages" rather than failing
the whole listing.

Authorizations:

HTTPBearer

path Parameters

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.

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}/connections

EU

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

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_id": "string",
    • "environment_id": "string",
    • "cross_id": "5f887c764c40e5598f717676",
    • "_id": "5f887c764c40e5598f717676",
    • "connection_name": "test connection",
    • "connection_type": "Oracle",
    • "connection_type_id": "oracle",
    • "is_test_connection": false,
    • "connection_update_by": "5f887c764c40e5598f717676",
    • "connection_update_time": "2019-08-24T14:15:22Z"

    }

  ]

}

Add Connection

Authorization scope: connection:edit

Creates a new connection entity.

---

📖 Instructions for usage

create_connection

Create a new connection. body must match the CreateConnection API schema.

NOT ALL CONNECTION TYPES CAN BE CREATED HERE. Connections that authenticate
via OAuth (e.g. Google services, Salesforce, HubSpot, Facebook/Meta, LinkedIn,
and similar — anything that needs a browser sign-in / "Connect with..." flow)
CANNOT be created through this tool, because OAuth requires an interactive
browser consent step. For those, tell the user:
"This connection uses OAuth — please create it in the Boomi Data Integration
console, then I can use it here."

This tool works for connections that authenticate with credentials you can
supply directly (host/port/user/password/keys), e.g. databases like mysql,
postgresql, mssql, snowflake, bigquery, redshift, mongodb.

Authorizations:

HTTPBearer

path Parameters

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

Request Body schema: application/json

required

object (Connection To Create)

Responses

US

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

EU

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

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 201
• 422

Content type

application/json

{ }

Update Connection

Authorization scope: connection:edit

This endpoint updates a connection

---

📖 Instructions for usage

update_connection

Update an existing connection.

Authorizations:

HTTPBearer

path Parameters

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

Request Body schema: application/json

required

object (Connection To Update)

Responses

Response Schema: application/json

object (Response Update Connection)

US

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

EU

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

Request samples

• Payload

Content type

application/json

{ }

Response samples

• 200
• 422

Content type

application/json

{ }

Delete Connection

Authorization scope: connection:delete

This endpoint deletes a connection

---

📖 Instructions for usage

delete_connection

Delete a connection.

The upstream DELETE returns an empty body on success; this returns
{"deleted": true, "connection_id": ...}.

Authorizations:

HTTPBearer

path Parameters

account_id required	string (Account Id)
environment_id required	string (Environment Id)
connection_cross_id required	string (Connection Cross Id)

Responses

Response Schema: application/json

any

US

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

EU

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

Response samples

• 200
• 422

Content type

application/json

null