NEnexla
Destinations (Data Sinks)

Get Sink by ID

Returns a data_sink object if a valid ID is provided.

get/data_sinks/{sink_id}

Request

Path parameters

sink_idinteger required

The unique ID of the sink that needs to be fetched.

Headers

Accept'application/vnd.nexla.api.v1+json' | 'application/json'

Setting to application/vnd.nexla.api.v1+json is recommended.

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.