Skip to content

ConfigApi.md

Latest commit

 

History

History
executable file
·
459 lines (308 loc) · 10.7 KB

ConfigApi.md

File metadata and controls

executable file
·
459 lines (308 loc) · 10.7 KB

LookerApi31Reference.ConfigApi

All URIs are relative to /api/3.1

Method HTTP request Description
allLegacyFeatures GET /legacy_features Get All Legacy Features
allLocales GET /locales Get All Locales
allTimezones GET /timezones Get All Timezones
backupConfiguration GET /backup_configuration Get Backup Configuration
legacyFeature GET /legacy_features/{legacy_feature_id} Get Legacy Feature
updateBackupConfiguration PATCH /backup_configuration Update Backup Configuration
updateLegacyFeature PATCH /legacy_features/{legacy_feature_id} Update Legacy Feature
updateWhitelabelConfiguration PUT /whitelabel_configuration Update Whitelabel configuration
versions GET /versions Get ApiVersion
whitelabelConfiguration GET /whitelabel_configuration Get Whitelabel configuration

allLegacyFeatures

[LegacyFeature] allLegacyFeatures()

Get All Legacy Features

Get all legacy features.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.ConfigApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.allLegacyFeatures(callback);

Parameters

This endpoint does not need any parameter.

Return type

[LegacyFeature]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

allLocales

[Locale] allLocales()

Get All Locales

Get a list of locales that Looker supports.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.ConfigApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.allLocales(callback);

Parameters

This endpoint does not need any parameter.

Return type

[Locale]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

allTimezones

[Timezone] allTimezones()

Get All Timezones

Get a list of timezones that Looker supports (e.g. useful for scheduling tasks).

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.ConfigApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.allTimezones(callback);

Parameters

This endpoint does not need any parameter.

Return type

[Timezone]

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

backupConfiguration

BackupConfiguration backupConfiguration()

Get Backup Configuration

Get the current Looker internal database backup configuration.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.ConfigApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.backupConfiguration(callback);

Parameters

This endpoint does not need any parameter.

Return type

BackupConfiguration

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

legacyFeature

LegacyFeature legacyFeature(legacyFeatureId)

Get Legacy Feature

Get information about the legacy feature with a specific id.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.ConfigApi();

var legacyFeatureId = 789; // Number | id of legacy feature


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.legacyFeature(legacyFeatureId, callback);

Parameters

Name Type Description Notes
legacyFeatureId Number id of legacy feature

Return type

LegacyFeature

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateBackupConfiguration

BackupConfiguration updateBackupConfiguration(body)

Update Backup Configuration

Update the Looker internal database backup configuration.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.ConfigApi();

var body = new LookerApi31Reference.BackupConfiguration(); // BackupConfiguration | Options for Backup Configuration


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateBackupConfiguration(body, callback);

Parameters

Name Type Description Notes
body BackupConfiguration Options for Backup Configuration

Return type

BackupConfiguration

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateLegacyFeature

LegacyFeature updateLegacyFeature(legacyFeatureId, body)

Update Legacy Feature

Update information about the legacy feature with a specific id.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.ConfigApi();

var legacyFeatureId = 789; // Number | id of legacy feature

var body = new LookerApi31Reference.LegacyFeature(); // LegacyFeature | Legacy Feature


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateLegacyFeature(legacyFeatureId, body, callback);

Parameters

Name Type Description Notes
legacyFeatureId Number id of legacy feature
body LegacyFeature Legacy Feature

Return type

LegacyFeature

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateWhitelabelConfiguration

WhitelabelConfiguration updateWhitelabelConfiguration(body)

Update Whitelabel configuration

Update the whitelabel configuration

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.ConfigApi();

var body = new LookerApi31Reference.WhitelabelConfiguration(); // WhitelabelConfiguration | Whitelabel configuration


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateWhitelabelConfiguration(body, callback);

Parameters

Name Type Description Notes
body WhitelabelConfiguration Whitelabel configuration

Return type

WhitelabelConfiguration

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

versions

ApiVersion versions(opts)

Get ApiVersion

Get information about all API versions supported by this Looker instance.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.ConfigApi();

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.versions(opts, callback);

Parameters

Name Type Description Notes
fields String Requested fields. [optional]

Return type

ApiVersion

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

whitelabelConfiguration

WhitelabelConfiguration whitelabelConfiguration(opts)

Get Whitelabel configuration

This feature is enabled only by special license. ### Gets the whitelabel configuration, which includes hiding documentation links, custom favicon uploading, etc.

Example

var LookerApi31Reference = require('looker-node-api');

var apiInstance = new LookerApi31Reference.ConfigApi();

var opts = {
  'fields': "fields_example" // String | Requested fields.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.whitelabelConfiguration(opts, callback);

Parameters

Name Type Description Notes
fields String Requested fields. [optional]

Return type

WhitelabelConfiguration

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json