Sources

Get Source by ID

Returns a source object if a valid ID is provided.

get/data_sources/{source_id}

Request

Path parameters

source_idinteger required

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

Query parameters

expand1

Add this parameter to a resource fetch request to receive details about related resources in the response.

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
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.