Skip to content

Latest commit

 

History

History
428 lines (281 loc) · 9.77 KB

ConfigApi.md

File metadata and controls

428 lines (281 loc) · 9.77 KB
Raw

LookerApi30Reference.ConfigApi

All URIs are relative to https://madisonreed.looker.com:19999/api/3.0

Method HTTP request Description
allLegacyFeatures GET /legacy_features Get All Legacy Features
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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.ConfigApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.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

allTimezones

[Timezone] allTimezones

Get All Timezones

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

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.ConfigApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.ConfigApi()

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.ConfigApi()

var legacyFeatureId = 789; // {Integer} id of legacy feature


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

Parameters

Name Type Description Notes
legacyFeatureId Integer 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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.ConfigApi()

var body = new LookerApi30Reference.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);
  }
};
api.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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.ConfigApi()

var legacyFeatureId = 789; // {Integer} id of legacy feature

var body = new LookerApi30Reference.LegacyFeature(); // {LegacyFeature} Legacy Feature


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

Parameters

Name Type Description Notes
legacyFeatureId Integer 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

Whitelabel updateWhitelabelConfiguration(body)

Update Whitelabel configuration

Update the whitelabel configuration

Example

var LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.ConfigApi()

var body = new LookerApi30Reference.Whitelabel(); // {Whitelabel} Whitelabel configuration


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

Parameters

Name Type Description Notes
body Whitelabel Whitelabel configuration

Return type

Whitelabel

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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.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);
  }
};
api.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

Whitelabel 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 LookerApi30Reference = require('looker-api-3');

var apiInstance = new LookerApi30Reference.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);
  }
};
api.whitelabelConfiguration(opts, callback);

Parameters

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

Return type

Whitelabel

Authorization

No authorization required

HTTP request headers

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