Legacy Data Integration API Reference (1.0.0) - ConnectionManagement

Toggle Pane

• Connection Management
  • getList All Connections
  • getFilter Connections By Connection Type
  • putCreate New Connection
  • getGet Specific Connection
  • patchUpdate Connection by ID
  • delDelete Connection By ID

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration.

Connection Management

Create new connections, update them and delete the connections you don't want anymore.

Find our more about setting new connection in Data Integration.

List All Connections

• scope: connection:list

Authorizations:

BearerToken

Responses

Response Schema: application/json

Array

cross_id	string The id shared between accounts and environments
_id	string A unique id for this connection
{{propertyId}}_exists	boolean An indication that the password key of some connection type key is included in the the connection.
is_{{propertyId}}_encrypted	boolean An indication that a password key of some connection type key is encrypted.
connection_name	string The connection name
connection_type	string The connection type.

Data Integration Console (US)

https://console.rivery.io/api/connections/list

Data Integration Console (EU)

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

Request samples

• cURL
• Python

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

Response samples

• 200
• 403

Content type

application/json

[

• {

  • "cross_id": "string",
  • "_id": "string",
  • "{{propertyId}}_exists": true,
  • "is_{{propertyId}}_encrypted": true,
  • "connection_name": "string",
  • "connection_type": "aws"

  }

]

Filter Connections By Connection Type

• scope: connection:list

Authorizations:

BearerToken

query Parameters

connection_type required

string Example: connection_type=fb Filter connections by connection types

Responses

Response Schema: application/json

cross_id	string The id shared between accounts and environments
_id	string A unique id for this connection
{{propertyId}}_exists	boolean An indication that the password key of some connection type key is included in the the connection.
is_{{propertyId}}_encrypted	boolean An indication that a password key of some connection type key is encrypted.
connection_name	string The connection name
connection_type	string The connection type.

Data Integration Console (US)

https://console.rivery.io/api/connections/{{connectionTypeId}}

Data Integration Console (EU)

https://eu-west-1.console.rivery.io/api/connections/{{connectionTypeId}}

Request samples

• cURL
• Python

curl
--location -g
--request GET  'https://console.rivery.io/api/connections/{{connectionTypeId}}?cross_id=' \
--header 'Authorization: Bearer <token>'

Response samples

• 200
• 403

Content type

application/json

{

• "cross_id": "string",
• "_id": "string",
• "{{propertyId}}_exists": true,
• "is_{{propertyId}}_encrypted": true,
• "connection_name": "string",
• "connection_type": "aws"

}

Create New Connection

• scope: connection:edit

Authorizations:

BearerToken

Request Body schema: application/json

Create New Connection using the connection name, connection type, and connection paramters as described in connection parameters API request.

connection_type required	string
connection_name required	string

Responses

Response Schema: application/json

cross_id	string The id shared between accounts and environments
_id	string A unique id for this connection
{{propertyId}}_exists	boolean An indication that the password key of some connection type key is included in the the connection.
is_{{propertyId}}_encrypted	boolean An indication that a password key of some connection type key is encrypted.
connection_name	string The connection name
connection_type	string The connection type.

Data Integration Console (US)

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

Data Integration Console (EU)

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

Request samples

• Payload
• cURL
• Python

Content type

application/json

Example

Key ValOAuth2Pem FileKey Val

{

• "connection_type": "aws",
• "connection_name": "My S3 Connection",
• "aws_access_key": "smd0mLSCJHodKndas",
• "aws_access_secrets": "Amndsjkjns0nmnre3.nkdskndYkHDS",
• "connection_method": "aws_keys"

}

Response samples

• 200
• 403

Content type

application/json

{

• "cross_id": "string",
• "_id": "string",
• "{{propertyId}}_exists": true,
• "is_{{propertyId}}_encrypted": true,
• "connection_name": "string",
• "connection_type": "aws"

}

Get Specific Connection

• scope: connection:list

Authorizations:

BearerToken

path Parameters

connectionId required

string Example: 5faa7bd17bedeb66f4c287c7 connection id

Responses

Response Schema: application/json

cross_id	string The id shared between accounts and environments
_id	string A unique id for this connection
{{propertyId}}_exists	boolean An indication that the password key of some connection type key is included in the the connection.
is_{{propertyId}}_encrypted	boolean An indication that a password key of some connection type key is encrypted.
connection_name	string The connection name
connection_type	string The connection type.

Data Integration Console (US)

https://console.rivery.io/api/connections/{{connectionId}}

Data Integration Console (EU)

https://eu-west-1.console.rivery.io/api/connections/{{connectionId}}

Request samples

• cURL
• Python

curl
--location -g
--request GET  'https://console.rivery.io/api/connections/{{connectionId}}' \
--header 'Authorization: Bearer <token>'

Response samples

• 200
• 403

Content type

application/json

{

• "cross_id": "string",
• "_id": "string",
• "{{propertyId}}_exists": true,
• "is_{{propertyId}}_encrypted": true,
• "connection_name": "string",
• "connection_type": "aws"

}

Update Connection by ID

• scope: connection:edit

Authorizations:

BearerToken

path Parameters

connectionId required

string Example: 5faa7bd17bedeb66f4c287c7 connection id

Request Body schema: application/json

Create New Connection using the connection name, connection type, and connection paramters as described in connection parameters API request.

connection_type required	string
connection_name required	string

Responses

Response Schema: application/json

status	boolean
code	integer
count	integer

Data Integration Console (US)

https://console.rivery.io/api/connections/{{connectionId}}

Data Integration Console (EU)

https://eu-west-1.console.rivery.io/api/connections/{{connectionId}}

Request samples

• Payload

Content type

application/json

Example

Key ValOAuth2Pem FileKey Val

{

• "connection_type": "aws",
• "connection_name": "My S3 Connection",
• "aws_access_key": "smd0mLSCJHodKndas",
• "aws_access_secrets": "Amndsjkjns0nmnre3.nkdskndYkHDS",
• "connection_method": "aws_keys"

}

Response samples

• 200
• 403
• 404

Content type

application/json

{

• "status": true,
• "code": 0,
• "count": 1

}

Delete Connection By ID

• scope: connection:delete

Authorizations:

BearerToken

path Parameters

connectionId required

string Example: 5faa7bd17bedeb66f4c287c7 connection id

Responses

Response Schema: application/json

status	boolean
code	integer
deleted_count	integer

Data Integration Console (US)

https://console.rivery.io/api/connections/{{connectionId}}

Data Integration Console (EU)

https://eu-west-1.console.rivery.io/api/connections/{{connectionId}}

Request samples

• cURL
• Python

curl
--location -g
--request DELETE  'https://console.rivery.io/api/connections/{{connectionId}}' \
--header 'Authorization: Bearer <token>'

Response samples

• 200
• 403
• 404
• 420

Content type

application/json

{

• "status": true,
• "code": 0,
• "deleted_count": 1

}