Type Alias DataSourcesAPI

type DataSourcesAPI = {
    clearCache: typeof dataSources.clearCache;
    filterDataSourcesEndpoints_FIX_THIS_QUIRKY_NAME: typeof filterDataSourcesEndpoints_FIX_THIS_QUIRKY_NAME;
    generateQriDataSources: typeof generateQriDataSources;
    getDataSourceApiSpecs: typeof dataSources.getDataSourceApiSpecs;
    getDataSourceGateways: typeof dataSources.getDataSourceGateways;
    getDataSources: typeof dataSources.getDataSources;
    getDataSourcesEndpoints_FIX_THIS_QUIRKY_NAME: typeof getDataSourcesEndpoints_FIX_THIS_QUIRKY_NAME;
    getDataSourceSettings: typeof dataSources.getDataSourceSettings;
    putDataSourceSettings_FIX_THIS_QUIRKY_NAME: typeof putDataSourceSettings_FIX_THIS_QUIRKY_NAME;
}
Index

Properties

clearCache filterDataSourcesEndpoints_FIX_THIS_QUIRKY_NAME generateQriDataSources getDataSourceApiSpecs getDataSourceGateways getDataSources getDataSourcesEndpoints_FIX_THIS_QUIRKY_NAME getDataSourceSettings putDataSourceSettings_FIX_THIS_QUIRKY_NAME

Properties

clearCache: typeof dataSources.clearCache

Clears the cache for data-sources api requests.

filterDataSourcesEndpoints_FIX_THIS_QUIRKY_NAME: typeof filterDataSourcesEndpoints_FIX_THIS_QUIRKY_NAME

Provisions a gRPC endpoint for loading data using the specified connection. The connection can be resolved by name, ID, connection string, or datasource ID. Returns the endpoint reference and resolved connection details required to initiate a data load session.

Param: body

an object with the body content

FilterDataSourcesEndpoints_FIX_THIS_QUIRKY_NAMEHttpError

generateQriDataSources: typeof generateQriDataSources

Generates Qlik Resource Identifiers (QRIs) for a batch of connections. Each connection can be identified by ID, name, or connection string. Partial failures are reported per entry in the response — a 207 Multi-Status response is always returned regardless of individual entry outcomes.

Param: body

an object with the body content

GenerateQriDataSourcesHttpError

getDataSourceApiSpecs: typeof dataSources.getDataSourceApiSpecs

Retrieves the connection property schema for the specified datasource, including the connector provider, version, and the full list of properties required to establish a connection. Use this operation to discover which fields must be supplied when creating or generating a connection string for this datasource.

getDataSourceApiSpecs(
  "rest"
)

The unique identifier of the datasource to retrieve the connection schema for.

GetDataSourceApiSpecsHttpError

getDataSourceGateways: typeof dataSources.getDataSourceGateways

Returns the list of gateway IDs available for the specified Direct Access Gateway datasource. Gateways enable on-premises datasources to be accessed from Qlik Cloud. Results are returned from a cache by default; set forceRefresh to true to retrieve the current list from the backend.

getDataSourceGateways(
  "DG_rest",
  {
    forceRefresh: true
  }
)

The unique identifier of the Direct Access Gateway datasource to list gateways for. Must be prefixed with DG_.

an object with query parameters

GetDataSourceGatewaysHttpError

getDataSources: typeof dataSources.getDataSources

Returns the list of datasources available on the connector node. Each entry includes the connector provider, capabilities, and optional UI metadata. Filter by dataSourceId to retrieve a specific datasource, or set includeDisabled to true to include datasources that have been disabled.

getDataSources(
  {
    dataSourceId: "rest",
    detail: true,
    includeDisabled: true,
    includeui: true
  }
)

an object with query parameters

GetDataSourcesHttpError

getDataSourcesEndpoints_FIX_THIS_QUIRKY_NAME: typeof getDataSourcesEndpoints_FIX_THIS_QUIRKY_NAME

Returns the list of endpoint references currently active on the connector node. Each entry identifies the datasource and gRPC URL for an active endpoint session. Use this operation to audit active endpoint allocations or to locate the URL for an existing endpoint.

GetDataSourcesEndpoints_FIX_THIS_QUIRKY_NAMEHttpError

getDataSourceSettings: typeof dataSources.getDataSourceSettings

Retrieves the current configuration settings for the specified datasource. Settings control operational behaviour such as whether the datasource is enabled or disabled for tenant use.

getDataSourceSettings(
  "rest"
)

The unique identifier of the datasource to retrieve settings for.

GetDataSourceSettingsHttpError

putDataSourceSettings_FIX_THIS_QUIRKY_NAME: typeof putDataSourceSettings_FIX_THIS_QUIRKY_NAME

Updates the configuration settings for the specified datasource. Use this operation to enable or disable a datasource for the tenant. The full settings object must be supplied; partial updates are not supported.

The unique identifier of the datasource to update settings for.

Param: body

an object with the body content

PutDataSourceSettings_FIX_THIS_QUIRKY_NAMEHttpError

Settings

Member Visibility

On This Page

Properties