Destinations (Data Sinks)

Copy a Sink

Use this endpoint to create a copy of an existing data sink.

post/data_sinks/{sink_id}/copy

Request

Path parameters

sink_idinteger required

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

Request body

reuse_data_credentialsboolean

Set this to true if you do want to reuse the credentials of this sink instead of creating a clone of the credentials also.

copy_access_controlsboolean

Set this to true if you want the new sink to be accessible by all users who have access to the this sink.

owner_idinteger

The default API behavior is to create the new sink in the account of the authenticated user making this call. Set this property if you want a different user to be the owner of the new sink.

org_idinteger

The default API behavior is to create the new sink in the org that the authenticated user making this call belongs to. Set this property if you want the sink to be created in a different org.

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.