Sources

Update a Source

Updates a data source in the authenticated user's account.

Depending on the type of source you want to update (source_type), properties like source_config and data_credentials_id will require appropriate configuration.

Note: This method does not perform partial updating of source_config. The entire source_config object will be updated if this is added to the payload.

put/data_sources/{source_id}

Request

Path parameters

source_idinteger required

The unique ID of the source that needs to be updated.

Request body

namestring
descriptionstring
data_credentials_idinteger

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

Note that this is not applicable for file_upload, nexla_rest and email sources but is required for all other connectors.

stream_configobject

Field only used for ELT Vendor Endpoints

source_typestring

Connector Type: Connector codename.

code_container_idinteger

ID of code container to attach to this source.

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
ingest_methodstring
source_formatstring
source_configobject

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

poll_scheduleunknown
managedboolean
code_container_idunknown
source_typestring
connector_typestring
auto_generatedboolean
copied_from_idunknown
updated_atstring date-time
created_atstring date-time
flow_typestring
ingestion_modestring

Changes

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