Legacy Data Integration API Reference (1.0.0) - ConnectionKeyFiles

Toggle Pane

• Connection Key Files
  • getGet Connection Key details
  • delDelete Connection Key Pair
  • postCreate Connection Key file

API docs by Redocly

Download OpenAPI Specification: Download

Find out more about Data Integration.

Connection Key Files

Uploading and Creating new files for connections, in cases of certificate files or encrypted files needed. For example, when connecting the Google Cloud Platform (GCP) resources (BigQuery and GCS), there's a need to provide a *.json file; In SSH Tunnel, a *.pem file is also needed in most cases.

Get Connection Key details

Returns the connection key pair details

• scope: connection:list

Authorizations:

BearerToken

query Parameters

id required

string Example: id=5faa7bd17bedeb66f4c287c7 connection key pair id

Responses

Response Schema: application/json

key_pair_id	string
key_file_name	string
key_name	string
public_key	string
is_key_file	boolean
connection_type	string
env_id	string (EnvIdSchema) The object's environment id.
account	string (AccountSchema) Data Integration account id.
user_created	string (UpdateBySchema) The user Id in Data Integration updated the entity

Data Integration Console (US)

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

Data Integration Console (EU)

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

Response samples

• 200
• 400

Content type

application/json

{

• "key_pair_id": "5fa7c995f5as82c6crfb9dd565",
• "key_file_name": "{key_file_path}/5f3934444c40e5336f77c34b/5f3934444c40e5336f77c34d/uficudkfcx2_mypem.pem",
• "key_name": "uficudkfcx2_mypem.pem",
• "public_key": "MFkwEwYHKoZIzj0CAQYI.....",
• "is_key_file": true,
• "connection_type": "redshift",
• "env_id": "56643e6770ec07e624d43574",
• "account": "56643e6770ec07e624d43351",
• "user_created": "58b820a0c762711d8c2f60c7"

}

Delete Connection Key Pair

Deletes the connection key pair

• scope: connection:edit

Authorizations:

BearerToken

query Parameters

id required

string Example: id=5faa7bd17bedeb66f4c287c7 connection key pair id

Responses

Response Schema: application/json

message

string

Data Integration Console (US)

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

Data Integration Console (EU)

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

Response samples

• 200
• 404
• 500

Content type

application/json

{

• "message": "Key Pair 5fa7c995f5as82c6crfb9dd565 deleted"

}

Create Connection Key file

Upload and creating new key file in the system. Key file is required for some connections keys, when the connection type property type value in file.

• scope: connection:edit

Authorizations:

BearerToken

path Parameters

connectionTypeId required

string Example: fb_ads,aws,klaviyo Connection type id.

Request Body schema: multipart/form-data

file required

string <binary>

Responses

Response Schema: application/json

key_file_name	string
is_key_file	boolean

Data Integration Console (US)

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

Data Integration Console (EU)

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

Response samples

• 200
• 402
• 403
• 404
• 500

Content type

application/json

{

• "key_file_name": "{key_file_path}/5f3934444c40e5336f77c34b/5f3934444c40e5336f77c34d/uficudkfcx2_mypem.pem",
• "is_key_file": true

}