Destinations (Data Sinks)

Create a Sink

Creates a Nexla data_sink with the specified configuration in your Nexla account.

Note: name ,data_set_id, sink_type, sink_config and data_credentials_id are required.

post/data_sinks

Request

Request body

namestring required
descriptionstring
data_credentials_idinteger required

Credential ID: Nexla data credential that contains all authentication information for this destination.

data_set_idinteger

Nexset ID: Set the Nexset ID whose output records will be written out to this destination.

sink_typestring required

Connector Type: Connector codename.

Response

Success

idinteger
access_rolesstring[]

This property reflects all the permissions the user/team/organization has to this resource.

  1. collaborator: The user/team/organization can view the resource but not make any modifications to it.
  2. operator: The user/team/organization can view the resource and can activate/pause it, but not make any other modifications to it.
  3. administrator: The user/team/organization has complete administrative rights to this resource.
  4. owner: This user created the resource and so has complete administrative rights to it.
namestring
descriptionunknown
statusstring
data_set_idinteger
data_map_idunknown
data_source_idunknown
sink_formatunknown
sink_configobject

The destination configuration properties that were set as sink_config in the payload-to-destination create/update API calls.

sink_scheduleunknown
in_memoryboolean
managedboolean
sink_typestring
connector_typestring
copied_from_idunknown
updated_atstring date-time
created_atstring date-time
flow_typestring

Changes

No recorded changes to this operation across all 1 revision of this API.