LogicMonitor REST API

APITokens

addApiTokenByAdminId

Add API tokens for a user

Add new API tokens for a specific user


/setting/admins/{adminId}/apitokens

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/admins/{adminId}/apitokens?type="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.APITokensApi;

import java.io.File;
import java.util.*;

public class APITokensApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        APITokensApi apiInstance = new APITokensApi();
        Integer adminId = 56; // Integer | 
        APIToken body = ; // APIToken | 
        String type = type_example; // String | 
        try {
            APIToken result = apiInstance.addApiTokenByAdminId(adminId, body, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#addApiTokenByAdminId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.APITokensApi;

public class APITokensApiExample {

    public static void main(String[] args) {
        APITokensApi apiInstance = new APITokensApi();
        Integer adminId = 56; // Integer | 
        APIToken body = ; // APIToken | 
        String type = type_example; // String | 
        try {
            APIToken result = apiInstance.addApiTokenByAdminId(adminId, body, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#addApiTokenByAdminId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *adminId = 56; // 
APIToken *body = ; // 
String *type = type_example; //  (optional)

APITokensApi *apiInstance = [[APITokensApi alloc] init];

// Add API tokens for a user
[apiInstance addApiTokenByAdminIdWith
    adminId:adminId:body
    type:type
              completionHandler: ^(APIToken output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.APITokensApi()
var adminId = 56; // {{Integer}} 
var body = ; // {{APIToken}} 
var opts = { 
  'type': type_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addApiTokenByAdminId(adminIdbody, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addApiTokenByAdminIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new APITokensApi();
            var adminId = 56;  // Integer | 
            var body = new APIToken(); // APIToken | 
            var type = type_example;  // String |  (optional) 

            try
            {
                // Add API tokens for a user
                APIToken result = apiInstance.addApiTokenByAdminId(adminId, body, type);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling APITokensApi.addApiTokenByAdminId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAPITokensApi();
$adminId = 56; // Integer | 
$body = ; // APIToken | 
$type = type_example; // String | 

try {
    $result = $api_instance->addApiTokenByAdminId($adminId, $body, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APITokensApi->addApiTokenByAdminId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::APITokensApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::APITokensApi->new();
my $adminId = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::APIToken->new(); # APIToken | 
my $type = type_example; # String | 

eval { 
    my $result = $api_instance->addApiTokenByAdminId(adminId => $adminId, body => $body, type => $type);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling APITokensApi->addApiTokenByAdminId: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Add API tokens for a user api_response = api_instance.add_api_token_by_admin_id(adminId, body, type=type) print(api_response) except ApiException as e: print("Exception when calling APITokensApi->addApiTokenByAdminId: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddApiTokenByAdminIdParams()
// Add API tokens for a user
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddApiTokenByAdminId(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddApiTokenByAdminId: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
adminId*
Integer (int32)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
type
String

Responses

Status: 200 - Successfully added the API tokens for the user

Status: default - Error


deleteApiTokenById

Delete API token

Delete a specific API token by its ID


/setting/admins/{adminId}/apitokens/{apitokenId}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/admins/{adminId}/apitokens/{apitokenId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.APITokensApi;

import java.io.File;
import java.util.*;

public class APITokensApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        APITokensApi apiInstance = new APITokensApi();
        Integer adminId = 56; // Integer | 
        Integer apitokenId = 56; // Integer | 
        try {
            Object result = apiInstance.deleteApiTokenById(adminId, apitokenId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#deleteApiTokenById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.APITokensApi;

public class APITokensApiExample {

    public static void main(String[] args) {
        APITokensApi apiInstance = new APITokensApi();
        Integer adminId = 56; // Integer | 
        Integer apitokenId = 56; // Integer | 
        try {
            Object result = apiInstance.deleteApiTokenById(adminId, apitokenId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#deleteApiTokenById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *adminId = 56; // 
Integer *apitokenId = 56; // 

APITokensApi *apiInstance = [[APITokensApi alloc] init];

// Delete API token
[apiInstance deleteApiTokenByIdWith:adminId
    apitokenId:apitokenId
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.APITokensApi()
var adminId = 56; // {{Integer}} 
var apitokenId = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteApiTokenById(adminId, apitokenId, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteApiTokenByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new APITokensApi();
            var adminId = 56;  // Integer | 
            var apitokenId = 56;  // Integer | 

            try
            {
                // Delete API token
                Object result = apiInstance.deleteApiTokenById(adminId, apitokenId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling APITokensApi.deleteApiTokenById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAPITokensApi();
$adminId = 56; // Integer | 
$apitokenId = 56; // Integer | 

try {
    $result = $api_instance->deleteApiTokenById($adminId, $apitokenId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APITokensApi->deleteApiTokenById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::APITokensApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::APITokensApi->new();
my $adminId = 56; # Integer | 
my $apitokenId = 56; # Integer | 

eval { 
    my $result = $api_instance->deleteApiTokenById(adminId => $adminId, apitokenId => $apitokenId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling APITokensApi->deleteApiTokenById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Delete API token api_response = api_instance.delete_api_token_by_id(adminId, apitokenId) print(api_response) except ApiException as e: print("Exception when calling APITokensApi->deleteApiTokenById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteApiTokenByIdParams()
// Delete API token
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteApiTokenById(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteApiTokenById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
adminId*
Integer (int32)
Required
apitokenId*
Integer (int32)
Required

Responses

Status: 200 - Successfully deleted the API token

Status: default - Error


getApiTokenList

Get a list of API tokens across users

Retrieve a paginated list of API tokens for all users


/setting/admins/apitokens

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/admins/apitokens?type=&permission=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.APITokensApi;

import java.io.File;
import java.util.*;

public class APITokensApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        APITokensApi apiInstance = new APITokensApi();
        String type = type_example; // String | 
        String permission = permission_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            ApiTokenPaginationResponse result = apiInstance.getApiTokenList(type, permission, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#getApiTokenList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.APITokensApi;

public class APITokensApiExample {

    public static void main(String[] args) {
        APITokensApi apiInstance = new APITokensApi();
        String type = type_example; // String | 
        String permission = permission_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            ApiTokenPaginationResponse result = apiInstance.getApiTokenList(type, permission, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#getApiTokenList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *type = type_example; //  (optional)
String *permission = permission_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

APITokensApi *apiInstance = [[APITokensApi alloc] init];

// Get a list of API tokens across users
[apiInstance getApiTokenListWith:type
    permission:permission
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(ApiTokenPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.APITokensApi()
var opts = { 
  'type': type_example, // {{String}} 
  'permission': permission_example, // {{String}} 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApiTokenList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getApiTokenListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new APITokensApi();
            var type = type_example;  // String |  (optional) 
            var permission = permission_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // Get a list of API tokens across users
                ApiTokenPaginationResponse result = apiInstance.getApiTokenList(type, permission, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling APITokensApi.getApiTokenList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAPITokensApi();
$type = type_example; // String | 
$permission = permission_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getApiTokenList($type, $permission, $fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APITokensApi->getApiTokenList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::APITokensApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::APITokensApi->new();
my $type = type_example; # String | 
my $permission = permission_example; # String | 
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getApiTokenList(type => $type, permission => $permission, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling APITokensApi->getApiTokenList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get a list of API tokens across users api_response = api_instance.get_api_token_list(type=type, permission=permission, fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling APITokensApi->getApiTokenList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetApiTokenListParams()
// Get a list of API tokens across users
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetApiTokenList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetApiTokenList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
type
String
permission
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successfully retrieved the list of API tokens

Status: default - Error


getApiTokenListByAdminId

Get API tokens for a user

Retrieve a paginated list of API tokens for a specific user


/setting/admins/{adminId}/apitokens

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/admins/{adminId}/apitokens?type=&permission=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.APITokensApi;

import java.io.File;
import java.util.*;

public class APITokensApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        APITokensApi apiInstance = new APITokensApi();
        Integer adminId = 56; // Integer | 
        String type = type_example; // String | 
        String permission = permission_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            ApiTokenPaginationResponse result = apiInstance.getApiTokenListByAdminId(adminId, type, permission, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#getApiTokenListByAdminId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.APITokensApi;

public class APITokensApiExample {

    public static void main(String[] args) {
        APITokensApi apiInstance = new APITokensApi();
        Integer adminId = 56; // Integer | 
        String type = type_example; // String | 
        String permission = permission_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            ApiTokenPaginationResponse result = apiInstance.getApiTokenListByAdminId(adminId, type, permission, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#getApiTokenListByAdminId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *adminId = 56; // 
String *type = type_example; //  (optional)
String *permission = permission_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

APITokensApi *apiInstance = [[APITokensApi alloc] init];

// Get API tokens for a user
[apiInstance getApiTokenListByAdminIdWith:adminId
    type:type
    permission:permission
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(ApiTokenPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.APITokensApi()
var adminId = 56; // {{Integer}} 
var opts = { 
  'type': type_example, // {{String}} 
  'permission': permission_example, // {{String}} 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getApiTokenListByAdminId(adminId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getApiTokenListByAdminIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new APITokensApi();
            var adminId = 56;  // Integer | 
            var type = type_example;  // String |  (optional) 
            var permission = permission_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // Get API tokens for a user
                ApiTokenPaginationResponse result = apiInstance.getApiTokenListByAdminId(adminId, type, permission, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling APITokensApi.getApiTokenListByAdminId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAPITokensApi();
$adminId = 56; // Integer | 
$type = type_example; // String | 
$permission = permission_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getApiTokenListByAdminId($adminId, $type, $permission, $fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APITokensApi->getApiTokenListByAdminId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::APITokensApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::APITokensApi->new();
my $adminId = 56; # Integer | 
my $type = type_example; # String | 
my $permission = permission_example; # String | 
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getApiTokenListByAdminId(adminId => $adminId, type => $type, permission => $permission, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling APITokensApi->getApiTokenListByAdminId: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get API tokens for a user api_response = api_instance.get_api_token_list_by_admin_id(adminId, type=type, permission=permission, fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling APITokensApi->getApiTokenListByAdminId: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetApiTokenListByAdminIdParams()
// Get API tokens for a user
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetApiTokenListByAdminId(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetApiTokenListByAdminId: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
adminId*
Integer (int32)
Required
Query parameters
Name Description
type
String
permission
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successfully retrieved the API tokens for the user

Status: default - Error


patchApiTokenByAdminId

Update API tokens for a user

Update the API tokens for a specific user


/setting/admins/{adminId}/apitokens/{apitokenId}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/admins/{adminId}/apitokens/{apitokenId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.APITokensApi;

import java.io.File;
import java.util.*;

public class APITokensApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        APITokensApi apiInstance = new APITokensApi();
        Integer adminId = 56; // Integer | 
        Integer apitokenId = 56; // Integer | 
        APIToken body = ; // APIToken | 
        try {
            APIToken result = apiInstance.patchApiTokenByAdminId(adminId, apitokenId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#patchApiTokenByAdminId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.APITokensApi;

public class APITokensApiExample {

    public static void main(String[] args) {
        APITokensApi apiInstance = new APITokensApi();
        Integer adminId = 56; // Integer | 
        Integer apitokenId = 56; // Integer | 
        APIToken body = ; // APIToken | 
        try {
            APIToken result = apiInstance.patchApiTokenByAdminId(adminId, apitokenId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#patchApiTokenByAdminId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *adminId = 56; // 
Integer *apitokenId = 56; // 
APIToken *body = ; // 

APITokensApi *apiInstance = [[APITokensApi alloc] init];

// Update API tokens for a user
[apiInstance patchApiTokenByAdminIdWith
    adminId:adminId
    apitokenId:apitokenId:body
              completionHandler: ^(APIToken output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.APITokensApi()
var adminId = 56; // {{Integer}} 
var apitokenId = 56; // {{Integer}} 
var body = ; // {{APIToken}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchApiTokenByAdminId(adminIdapitokenIdbody, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchApiTokenByAdminIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new APITokensApi();
            var adminId = 56;  // Integer | 
            var apitokenId = 56;  // Integer | 
            var body = new APIToken(); // APIToken | 

            try
            {
                // Update API tokens for a user
                APIToken result = apiInstance.patchApiTokenByAdminId(adminId, apitokenId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling APITokensApi.patchApiTokenByAdminId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAPITokensApi();
$adminId = 56; // Integer | 
$apitokenId = 56; // Integer | 
$body = ; // APIToken | 

try {
    $result = $api_instance->patchApiTokenByAdminId($adminId, $apitokenId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APITokensApi->patchApiTokenByAdminId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::APITokensApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::APITokensApi->new();
my $adminId = 56; # Integer | 
my $apitokenId = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::APIToken->new(); # APIToken | 

eval { 
    my $result = $api_instance->patchApiTokenByAdminId(adminId => $adminId, apitokenId => $apitokenId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling APITokensApi->patchApiTokenByAdminId: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update API tokens for a user api_response = api_instance.patch_api_token_by_admin_id(adminId, apitokenId, body) print(api_response) except ApiException as e: print("Exception when calling APITokensApi->patchApiTokenByAdminId: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewPatchApiTokenByAdminIdParams()
// Update API tokens for a user
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.PatchApiTokenByAdminId(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchApiTokenByAdminId: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
adminId*
Integer (int32)
Required
apitokenId*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successfully updated the API tokens for the user

Status: default - Error


updateApiTokenByAdminId

Update API tokens for a user

Update the API tokens for a specific user


/setting/admins/{adminId}/apitokens/{apitokenId}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/admins/{adminId}/apitokens/{apitokenId}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.APITokensApi;

import java.io.File;
import java.util.*;

public class APITokensApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        APITokensApi apiInstance = new APITokensApi();
        Integer adminId = 56; // Integer | 
        Integer apitokenId = 56; // Integer | 
        APIToken body = ; // APIToken | 
        try {
            APIToken result = apiInstance.updateApiTokenByAdminId(adminId, apitokenId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#updateApiTokenByAdminId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.APITokensApi;

public class APITokensApiExample {

    public static void main(String[] args) {
        APITokensApi apiInstance = new APITokensApi();
        Integer adminId = 56; // Integer | 
        Integer apitokenId = 56; // Integer | 
        APIToken body = ; // APIToken | 
        try {
            APIToken result = apiInstance.updateApiTokenByAdminId(adminId, apitokenId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling APITokensApi#updateApiTokenByAdminId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *adminId = 56; // 
Integer *apitokenId = 56; // 
APIToken *body = ; // 

APITokensApi *apiInstance = [[APITokensApi alloc] init];

// Update API tokens for a user
[apiInstance updateApiTokenByAdminIdWith
    adminId:adminId
    apitokenId:apitokenId:body
              completionHandler: ^(APIToken output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.APITokensApi()
var adminId = 56; // {{Integer}} 
var apitokenId = 56; // {{Integer}} 
var body = ; // {{APIToken}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateApiTokenByAdminId(adminIdapitokenIdbody, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateApiTokenByAdminIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new APITokensApi();
            var adminId = 56;  // Integer | 
            var apitokenId = 56;  // Integer | 
            var body = new APIToken(); // APIToken | 

            try
            {
                // Update API tokens for a user
                APIToken result = apiInstance.updateApiTokenByAdminId(adminId, apitokenId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling APITokensApi.updateApiTokenByAdminId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAPITokensApi();
$adminId = 56; // Integer | 
$apitokenId = 56; // Integer | 
$body = ; // APIToken | 

try {
    $result = $api_instance->updateApiTokenByAdminId($adminId, $apitokenId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APITokensApi->updateApiTokenByAdminId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::APITokensApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::APITokensApi->new();
my $adminId = 56; # Integer | 
my $apitokenId = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::APIToken->new(); # APIToken | 

eval { 
    my $result = $api_instance->updateApiTokenByAdminId(adminId => $adminId, apitokenId => $apitokenId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling APITokensApi->updateApiTokenByAdminId: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update API tokens for a user api_response = api_instance.update_api_token_by_admin_id(adminId, apitokenId, body) print(api_response) except ApiException as e: print("Exception when calling APITokensApi->updateApiTokenByAdminId: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateApiTokenByAdminIdParams()
// Update API tokens for a user
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.UpdateApiTokenByAdminId(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateApiTokenByAdminId: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
adminId*
Integer (int32)
Required
apitokenId*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successfully updated the API tokens for the user

Status: default - Error


AccessGroup

addAccessGroup

Create a access group

Create a access group


/setting/accessgroup/add

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/accessgroup/add"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccessGroupApi;

import java.io.File;
import java.util.*;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AccessGroupApi apiInstance = new AccessGroupApi();
        AccessGroup body = ; // AccessGroup | 
        try {
            AccessGroup result = apiInstance.addAccessGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#addAccessGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccessGroupApi;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        AccessGroupApi apiInstance = new AccessGroupApi();
        AccessGroup body = ; // AccessGroup | 
        try {
            AccessGroup result = apiInstance.addAccessGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#addAccessGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
AccessGroup *body = ; //  (optional)

AccessGroupApi *apiInstance = [[AccessGroupApi alloc] init];

// Create a access group
[apiInstance addAccessGroupWith:body
              completionHandler: ^(AccessGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AccessGroupApi()
var opts = { 
  'body':  // {{AccessGroup}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAccessGroup(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addAccessGroupExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccessGroupApi();
            var body = new AccessGroup(); // AccessGroup |  (optional) 

            try
            {
                // Create a access group
                AccessGroup result = apiInstance.addAccessGroup(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccessGroupApi.addAccessGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccessGroupApi();
$body = ; // AccessGroup | 

try {
    $result = $api_instance->addAccessGroup($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessGroupApi->addAccessGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccessGroupApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccessGroupApi->new();
my $body = WWW::SwaggerClient::Object::AccessGroup->new(); # AccessGroup | 

eval { 
    my $result = $api_instance->addAccessGroup(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccessGroupApi->addAccessGroup: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Create a access group api_response = api_instance.add_access_group(body=body) print(api_response) except ApiException as e: print("Exception when calling AccessGroupApi->addAccessGroup: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddAccessGroupParams()
// Create a access group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddAccessGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddAccessGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Successful operation

Status: default - Error


deleteAccessGroup

Delete access group

Delete access group


/setting/accessgroup/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/accessgroup/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccessGroupApi;

import java.io.File;
import java.util.*;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AccessGroupApi apiInstance = new AccessGroupApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteAccessGroup(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#deleteAccessGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccessGroupApi;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        AccessGroupApi apiInstance = new AccessGroupApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteAccessGroup(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#deleteAccessGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 

AccessGroupApi *apiInstance = [[AccessGroupApi alloc] init];

// Delete access group
[apiInstance deleteAccessGroupWith:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AccessGroupApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAccessGroup(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteAccessGroupExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccessGroupApi();
            var id = 56;  // Integer | 

            try
            {
                // Delete access group
                Object result = apiInstance.deleteAccessGroup(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccessGroupApi.deleteAccessGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccessGroupApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->deleteAccessGroup($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessGroupApi->deleteAccessGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccessGroupApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccessGroupApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->deleteAccessGroup(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccessGroupApi->deleteAccessGroup: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Delete access group api_response = api_instance.delete_access_group(id) print(api_response) except ApiException as e: print("Exception when calling AccessGroupApi->deleteAccessGroup: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteAccessGroupParams()
// Delete access group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteAccessGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteAccessGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - Successful operation

Status: default - Error


getAccessGroupById

Get access group by id

Get access group by id


/setting/accessgroup/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/accessgroup/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccessGroupApi;

import java.io.File;
import java.util.*;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AccessGroupApi apiInstance = new AccessGroupApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            AccessGroup result = apiInstance.getAccessGroupById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#getAccessGroupById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccessGroupApi;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        AccessGroupApi apiInstance = new AccessGroupApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            AccessGroup result = apiInstance.getAccessGroupById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#getAccessGroupById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
String *fields = fields_example; //  (optional)

AccessGroupApi *apiInstance = [[AccessGroupApi alloc] init];

// Get access group by id
[apiInstance getAccessGroupByIdWith:id
    fields:fields
              completionHandler: ^(AccessGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AccessGroupApi()
var id = 56; // {{Integer}} 
var opts = { 
  'fields': fields_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccessGroupById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAccessGroupByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccessGroupApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // Get access group by id
                AccessGroup result = apiInstance.getAccessGroupById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccessGroupApi.getAccessGroupById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccessGroupApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->getAccessGroupById($id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessGroupApi->getAccessGroupById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccessGroupApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccessGroupApi->new();
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->getAccessGroupById(id => $id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccessGroupApi->getAccessGroupById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get access group by id api_response = api_instance.get_access_group_by_id(id, fields=fields) print(api_response) except ApiException as e: print("Exception when calling AccessGroupApi->getAccessGroupById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetAccessGroupByIdParams()
// Get access group by id
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetAccessGroupById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAccessGroupById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
fields
String

Responses

Status: 200 - Successful operation

Status: default - Error


getAccessGroupList

Get access group list

Get access group list


/setting/accessgroup

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/accessgroup?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccessGroupApi;

import java.io.File;
import java.util.*;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AccessGroupApi apiInstance = new AccessGroupApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AccessGroupPaginationResponse result = apiInstance.getAccessGroupList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#getAccessGroupList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccessGroupApi;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        AccessGroupApi apiInstance = new AccessGroupApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AccessGroupPaginationResponse result = apiInstance.getAccessGroupList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#getAccessGroupList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

AccessGroupApi *apiInstance = [[AccessGroupApi alloc] init];

// Get access group list
[apiInstance getAccessGroupListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(AccessGroupPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AccessGroupApi()
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAccessGroupList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAccessGroupListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccessGroupApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // Get access group list
                AccessGroupPaginationResponse result = apiInstance.getAccessGroupList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccessGroupApi.getAccessGroupList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccessGroupApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getAccessGroupList($fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessGroupApi->getAccessGroupList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccessGroupApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccessGroupApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getAccessGroupList(fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccessGroupApi->getAccessGroupList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get access group list api_response = api_instance.get_access_group_list(fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling AccessGroupApi->getAccessGroupList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetAccessGroupListParams()
// Get access group list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetAccessGroupList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAccessGroupList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successful operation

Status: default - Error


mapUnMapModuleToAccessGroup

Create a mapping of access group & module

Map a module to an access group


/setting/accessgroup/mapunmap/modules

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/accessgroup/mapunmap/modules"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccessGroupApi;

import java.io.File;
import java.util.*;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AccessGroupApi apiInstance = new AccessGroupApi();
        RestMapModuleV3 body = ; // RestMapModuleV3 | 
        try {
            RestMapModuleV3 result = apiInstance.mapUnMapModuleToAccessGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#mapUnMapModuleToAccessGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccessGroupApi;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        AccessGroupApi apiInstance = new AccessGroupApi();
        RestMapModuleV3 body = ; // RestMapModuleV3 | 
        try {
            RestMapModuleV3 result = apiInstance.mapUnMapModuleToAccessGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#mapUnMapModuleToAccessGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
RestMapModuleV3 *body = ; //  (optional)

AccessGroupApi *apiInstance = [[AccessGroupApi alloc] init];

// Create a mapping of access group & module
[apiInstance mapUnMapModuleToAccessGroupWith:body
              completionHandler: ^(RestMapModuleV3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AccessGroupApi()
var opts = { 
  'body':  // {{RestMapModuleV3}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.mapUnMapModuleToAccessGroup(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class mapUnMapModuleToAccessGroupExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccessGroupApi();
            var body = new RestMapModuleV3(); // RestMapModuleV3 |  (optional) 

            try
            {
                // Create a mapping of access group & module
                RestMapModuleV3 result = apiInstance.mapUnMapModuleToAccessGroup(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccessGroupApi.mapUnMapModuleToAccessGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccessGroupApi();
$body = ; // RestMapModuleV3 | 

try {
    $result = $api_instance->mapUnMapModuleToAccessGroup($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessGroupApi->mapUnMapModuleToAccessGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccessGroupApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccessGroupApi->new();
my $body = WWW::SwaggerClient::Object::RestMapModuleV3->new(); # RestMapModuleV3 | 

eval { 
    my $result = $api_instance->mapUnMapModuleToAccessGroup(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccessGroupApi->mapUnMapModuleToAccessGroup: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Create a mapping of access group & module api_response = api_instance.map_un_map_module_to_access_group(body=body) print(api_response) except ApiException as e: print("Exception when calling AccessGroupApi->mapUnMapModuleToAccessGroup: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewMapUnMapModuleToAccessGroupParams()
// Create a mapping of access group & module
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.MapUnMapModuleToAccessGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.MapUnMapModuleToAccessGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Successfully created the mapping

Status: default - Error


patchAccessGroup

Update access group

Update access group


/setting/accessgroup/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/accessgroup/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccessGroupApi;

import java.io.File;
import java.util.*;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AccessGroupApi apiInstance = new AccessGroupApi();
        Integer id = 56; // Integer | 
        AccessGroup body = ; // AccessGroup | 
        try {
            AccessGroup result = apiInstance.patchAccessGroup(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#patchAccessGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccessGroupApi;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        AccessGroupApi apiInstance = new AccessGroupApi();
        Integer id = 56; // Integer | 
        AccessGroup body = ; // AccessGroup | 
        try {
            AccessGroup result = apiInstance.patchAccessGroup(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#patchAccessGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
AccessGroup *body = ; // 

AccessGroupApi *apiInstance = [[AccessGroupApi alloc] init];

// Update access group
[apiInstance patchAccessGroupWith
    id:id:body
              completionHandler: ^(AccessGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AccessGroupApi()
var id = 56; // {{Integer}} 
var body = ; // {{AccessGroup}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchAccessGroup(idbody, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchAccessGroupExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccessGroupApi();
            var id = 56;  // Integer | 
            var body = new AccessGroup(); // AccessGroup | 

            try
            {
                // Update access group
                AccessGroup result = apiInstance.patchAccessGroup(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccessGroupApi.patchAccessGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccessGroupApi();
$id = 56; // Integer | 
$body = ; // AccessGroup | 

try {
    $result = $api_instance->patchAccessGroup($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessGroupApi->patchAccessGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccessGroupApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccessGroupApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::AccessGroup->new(); # AccessGroup | 

eval { 
    my $result = $api_instance->patchAccessGroup(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccessGroupApi->patchAccessGroup: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update access group api_response = api_instance.patch_access_group(id, body) print(api_response) except ApiException as e: print("Exception when calling AccessGroupApi->patchAccessGroup: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewPatchAccessGroupParams()
// Update access group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.PatchAccessGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchAccessGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


updateAccessGroup

Update access group

Update access group


/setting/accessgroup/{id}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/accessgroup/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AccessGroupApi;

import java.io.File;
import java.util.*;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AccessGroupApi apiInstance = new AccessGroupApi();
        Integer id = 56; // Integer | 
        AccessGroup body = ; // AccessGroup | 
        try {
            AccessGroup result = apiInstance.updateAccessGroup(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#updateAccessGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AccessGroupApi;

public class AccessGroupApiExample {

    public static void main(String[] args) {
        AccessGroupApi apiInstance = new AccessGroupApi();
        Integer id = 56; // Integer | 
        AccessGroup body = ; // AccessGroup | 
        try {
            AccessGroup result = apiInstance.updateAccessGroup(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AccessGroupApi#updateAccessGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
AccessGroup *body = ; // 

AccessGroupApi *apiInstance = [[AccessGroupApi alloc] init];

// Update access group
[apiInstance updateAccessGroupWith
    id:id:body
              completionHandler: ^(AccessGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AccessGroupApi()
var id = 56; // {{Integer}} 
var body = ; // {{AccessGroup}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAccessGroup(idbody, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateAccessGroupExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AccessGroupApi();
            var id = 56;  // Integer | 
            var body = new AccessGroup(); // AccessGroup | 

            try
            {
                // Update access group
                AccessGroup result = apiInstance.updateAccessGroup(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AccessGroupApi.updateAccessGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAccessGroupApi();
$id = 56; // Integer | 
$body = ; // AccessGroup | 

try {
    $result = $api_instance->updateAccessGroup($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccessGroupApi->updateAccessGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AccessGroupApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AccessGroupApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::AccessGroup->new(); # AccessGroup | 

eval { 
    my $result = $api_instance->updateAccessGroup(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AccessGroupApi->updateAccessGroup: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update access group api_response = api_instance.update_access_group(id, body) print(api_response) except ApiException as e: print("Exception when calling AccessGroupApi->updateAccessGroup: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateAccessGroupParams()
// Update access group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.UpdateAccessGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateAccessGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


AlertRules

addAlertRule

add alert rule

add alert rule


/setting/alert/rules

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/alert/rules"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertRulesApi;

import java.io.File;
import java.util.*;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AlertRulesApi apiInstance = new AlertRulesApi();
        AlertRule body = ; // AlertRule | 
        try {
            AlertRule result = apiInstance.addAlertRule(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#addAlertRule");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertRulesApi;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        AlertRulesApi apiInstance = new AlertRulesApi();
        AlertRule body = ; // AlertRule | 
        try {
            AlertRule result = apiInstance.addAlertRule(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#addAlertRule");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
AlertRule *body = ; // 

AlertRulesApi *apiInstance = [[AlertRulesApi alloc] init];

// add alert rule
[apiInstance addAlertRuleWith:body
              completionHandler: ^(AlertRule output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AlertRulesApi()
var body = ; // {{AlertRule}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAlertRule(body, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addAlertRuleExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AlertRulesApi();
            var body = new AlertRule(); // AlertRule | 

            try
            {
                // add alert rule
                AlertRule result = apiInstance.addAlertRule(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertRulesApi.addAlertRule: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertRulesApi();
$body = ; // AlertRule | 

try {
    $result = $api_instance->addAlertRule($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertRulesApi->addAlertRule: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertRulesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertRulesApi->new();
my $body = WWW::SwaggerClient::Object::AlertRule->new(); # AlertRule | 

eval { 
    my $result = $api_instance->addAlertRule(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertRulesApi->addAlertRule: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # add alert rule api_response = api_instance.add_alert_rule(body) print(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->addAlertRule: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddAlertRuleParams()
// add alert rule
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddAlertRule(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddAlertRule: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


deleteAlertRuleById

delete alert rule

delete alert rule


/setting/alert/rules/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/alert/rules/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertRulesApi;

import java.io.File;
import java.util.*;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AlertRulesApi apiInstance = new AlertRulesApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteAlertRuleById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#deleteAlertRuleById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertRulesApi;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        AlertRulesApi apiInstance = new AlertRulesApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteAlertRuleById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#deleteAlertRuleById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 

AlertRulesApi *apiInstance = [[AlertRulesApi alloc] init];

// delete alert rule
[apiInstance deleteAlertRuleByIdWith:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AlertRulesApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAlertRuleById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteAlertRuleByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AlertRulesApi();
            var id = 56;  // Integer | 

            try
            {
                // delete alert rule
                Object result = apiInstance.deleteAlertRuleById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertRulesApi.deleteAlertRuleById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertRulesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->deleteAlertRuleById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertRulesApi->deleteAlertRuleById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertRulesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertRulesApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->deleteAlertRuleById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertRulesApi->deleteAlertRuleById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # delete alert rule api_response = api_instance.delete_alert_rule_by_id(id) print(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->deleteAlertRuleById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteAlertRuleByIdParams()
// delete alert rule
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteAlertRuleById(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteAlertRuleById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - Successful operation

Status: default - Error


getAlertRuleById

get alert rule by id

get alert rule by id


/setting/alert/rules/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/alert/rules/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertRulesApi;

import java.io.File;
import java.util.*;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AlertRulesApi apiInstance = new AlertRulesApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            AlertRule result = apiInstance.getAlertRuleById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#getAlertRuleById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertRulesApi;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        AlertRulesApi apiInstance = new AlertRulesApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            AlertRule result = apiInstance.getAlertRuleById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#getAlertRuleById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
String *fields = fields_example; //  (optional)

AlertRulesApi *apiInstance = [[AlertRulesApi alloc] init];

// get alert rule by id
[apiInstance getAlertRuleByIdWith:id
    fields:fields
              completionHandler: ^(AlertRule output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AlertRulesApi()
var id = 56; // {{Integer}} 
var opts = { 
  'fields': fields_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertRuleById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAlertRuleByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AlertRulesApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get alert rule by id
                AlertRule result = apiInstance.getAlertRuleById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertRulesApi.getAlertRuleById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertRulesApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->getAlertRuleById($id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertRulesApi->getAlertRuleById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertRulesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertRulesApi->new();
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->getAlertRuleById(id => $id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertRulesApi->getAlertRuleById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get alert rule by id api_response = api_instance.get_alert_rule_by_id(id, fields=fields) print(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->getAlertRuleById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetAlertRuleByIdParams()
// get alert rule by id
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetAlertRuleById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAlertRuleById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
fields
String

Responses

Status: 200 - Successful operation

Status: default - Error


getAlertRuleList

get alert rule list

get alert rule list


/setting/alert/rules

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/alert/rules?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertRulesApi;

import java.io.File;
import java.util.*;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AlertRulesApi apiInstance = new AlertRulesApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertRulePaginationResponse result = apiInstance.getAlertRuleList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#getAlertRuleList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertRulesApi;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        AlertRulesApi apiInstance = new AlertRulesApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertRulePaginationResponse result = apiInstance.getAlertRuleList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#getAlertRuleList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

AlertRulesApi *apiInstance = [[AlertRulesApi alloc] init];

// get alert rule list
[apiInstance getAlertRuleListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(AlertRulePaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AlertRulesApi()
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertRuleList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAlertRuleListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AlertRulesApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get alert rule list
                AlertRulePaginationResponse result = apiInstance.getAlertRuleList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertRulesApi.getAlertRuleList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertRulesApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getAlertRuleList($fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertRulesApi->getAlertRuleList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertRulesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertRulesApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getAlertRuleList(fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertRulesApi->getAlertRuleList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get alert rule list api_response = api_instance.get_alert_rule_list(fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->getAlertRuleList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetAlertRuleListParams()
// get alert rule list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetAlertRuleList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAlertRuleList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successful operation

Status: default - Error


patchAlertRuleById

update alert rule

update alert rule


/setting/alert/rules/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/alert/rules/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertRulesApi;

import java.io.File;
import java.util.*;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AlertRulesApi apiInstance = new AlertRulesApi();
        Integer id = 56; // Integer | 
        AlertRule body = ; // AlertRule | 
        try {
            AlertRule result = apiInstance.patchAlertRuleById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#patchAlertRuleById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertRulesApi;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        AlertRulesApi apiInstance = new AlertRulesApi();
        Integer id = 56; // Integer | 
        AlertRule body = ; // AlertRule | 
        try {
            AlertRule result = apiInstance.patchAlertRuleById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#patchAlertRuleById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
AlertRule *body = ; // 

AlertRulesApi *apiInstance = [[AlertRulesApi alloc] init];

// update alert rule
[apiInstance patchAlertRuleByIdWith
    id:id:body
              completionHandler: ^(AlertRule output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AlertRulesApi()
var id = 56; // {{Integer}} 
var body = ; // {{AlertRule}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchAlertRuleById(idbody, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchAlertRuleByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AlertRulesApi();
            var id = 56;  // Integer | 
            var body = new AlertRule(); // AlertRule | 

            try
            {
                // update alert rule
                AlertRule result = apiInstance.patchAlertRuleById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertRulesApi.patchAlertRuleById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertRulesApi();
$id = 56; // Integer | 
$body = ; // AlertRule | 

try {
    $result = $api_instance->patchAlertRuleById($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertRulesApi->patchAlertRuleById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertRulesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertRulesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::AlertRule->new(); # AlertRule | 

eval { 
    my $result = $api_instance->patchAlertRuleById(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertRulesApi->patchAlertRuleById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # update alert rule api_response = api_instance.patch_alert_rule_by_id(id, body) print(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->patchAlertRuleById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewPatchAlertRuleByIdParams()
// update alert rule
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.PatchAlertRuleById(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchAlertRuleById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


updateAlertRuleById

update alert rule

update alert rule


/setting/alert/rules/{id}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/alert/rules/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertRulesApi;

import java.io.File;
import java.util.*;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AlertRulesApi apiInstance = new AlertRulesApi();
        Integer id = 56; // Integer | 
        AlertRule body = ; // AlertRule | 
        try {
            AlertRule result = apiInstance.updateAlertRuleById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#updateAlertRuleById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertRulesApi;

public class AlertRulesApiExample {

    public static void main(String[] args) {
        AlertRulesApi apiInstance = new AlertRulesApi();
        Integer id = 56; // Integer | 
        AlertRule body = ; // AlertRule | 
        try {
            AlertRule result = apiInstance.updateAlertRuleById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertRulesApi#updateAlertRuleById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
AlertRule *body = ; // 

AlertRulesApi *apiInstance = [[AlertRulesApi alloc] init];

// update alert rule
[apiInstance updateAlertRuleByIdWith
    id:id:body
              completionHandler: ^(AlertRule output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AlertRulesApi()
var id = 56; // {{Integer}} 
var body = ; // {{AlertRule}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAlertRuleById(idbody, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateAlertRuleByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AlertRulesApi();
            var id = 56;  // Integer | 
            var body = new AlertRule(); // AlertRule | 

            try
            {
                // update alert rule
                AlertRule result = apiInstance.updateAlertRuleById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertRulesApi.updateAlertRuleById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertRulesApi();
$id = 56; // Integer | 
$body = ; // AlertRule | 

try {
    $result = $api_instance->updateAlertRuleById($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertRulesApi->updateAlertRuleById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertRulesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertRulesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::AlertRule->new(); # AlertRule | 

eval { 
    my $result = $api_instance->updateAlertRuleById(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertRulesApi->updateAlertRuleById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # update alert rule api_response = api_instance.update_alert_rule_by_id(id, body) print(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->updateAlertRuleById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateAlertRuleByIdParams()
// update alert rule
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.UpdateAlertRuleById(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateAlertRuleById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


Alerts

ackAlertById

Acknowledge alert by ID

Acknowledge the alert with the given ID


/alert/alerts/{id}/ack

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/alert/alerts/{id}/ack"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        AlertAck body = ; // AlertAck | 
        String id = id_example; // String | 
        try {
            Object result = apiInstance.ackAlertById(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#ackAlertById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        AlertAck body = ; // AlertAck | 
        String id = id_example; // String | 
        try {
            Object result = apiInstance.ackAlertById(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#ackAlertById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
AlertAck *body = ; // 
String *id = id_example; // 

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// Acknowledge alert by ID
[apiInstance ackAlertByIdWith:body
    id:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AlertsApi()
var body = ; // {{AlertAck}} 
var id = id_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.ackAlertById(bodyid, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class ackAlertByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AlertsApi();
            var body = new AlertAck(); // AlertAck | 
            var id = id_example;  // String | 

            try
            {
                // Acknowledge alert by ID
                Object result = apiInstance.ackAlertById(body, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.ackAlertById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();
$body = ; // AlertAck | 
$id = id_example; // String | 

try {
    $result = $api_instance->ackAlertById($body, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->ackAlertById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $body = WWW::SwaggerClient::Object::AlertAck->new(); # AlertAck | 
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->ackAlertById(body => $body, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->ackAlertById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Acknowledge alert by ID api_response = api_instance.ack_alert_by_id(body, id) print(api_response) except ApiException as e: print("Exception when calling AlertsApi->ackAlertById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAckAlertByIdParams()
// Acknowledge alert by ID
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AckAlertById(params) if err != nil { fmt.Printf("Exception when calling client.LM.AckAlertById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successfully acknowledged the alert

Status: default - Error


addAlertNoteById

Add alert note

Add a note to the alert with the given ID


/alert/alerts/{id}/note

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/alert/alerts/{id}/note"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        AlertAck body = ; // AlertAck | 
        String id = id_example; // String | 
        try {
            Object result = apiInstance.addAlertNoteById(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#addAlertNoteById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        AlertAck body = ; // AlertAck | 
        String id = id_example; // String | 
        try {
            Object result = apiInstance.addAlertNoteById(body, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#addAlertNoteById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
AlertAck *body = ; // 
String *id = id_example; // 

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// Add alert note
[apiInstance addAlertNoteByIdWith:body
    id:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AlertsApi()
var body = ; // {{AlertAck}} 
var id = id_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAlertNoteById(bodyid, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addAlertNoteByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AlertsApi();
            var body = new AlertAck(); // AlertAck | 
            var id = id_example;  // String | 

            try
            {
                // Add alert note
                Object result = apiInstance.addAlertNoteById(body, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.addAlertNoteById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();
$body = ; // AlertAck | 
$id = id_example; // String | 

try {
    $result = $api_instance->addAlertNoteById($body, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->addAlertNoteById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $body = WWW::SwaggerClient::Object::AlertAck->new(); # AlertAck | 
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->addAlertNoteById(body => $body, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->addAlertNoteById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Add alert note api_response = api_instance.add_alert_note_by_id(body, id) print(api_response) except ApiException as e: print("Exception when calling AlertsApi->addAlertNoteById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddAlertNoteByIdParams()
// Add alert note
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddAlertNoteById(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddAlertNoteById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successfully added the alert note

Status: default - Error


escalatedAlertById

Escalate alert by ID

Escalate the alert with the given ID


/alert/alerts/{id}/escalate

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/alert/alerts/{id}/escalate"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        String id = id_example; // String | 
        try {
            Object result = apiInstance.escalatedAlertById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#escalatedAlertById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        String id = id_example; // String | 
        try {
            Object result = apiInstance.escalatedAlertById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#escalatedAlertById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *id = id_example; // 

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// Escalate alert by ID
[apiInstance escalatedAlertByIdWith:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AlertsApi()
var id = id_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.escalatedAlertById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class escalatedAlertByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AlertsApi();
            var id = id_example;  // String | 

            try
            {
                // Escalate alert by ID
                Object result = apiInstance.escalatedAlertById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.escalatedAlertById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();
$id = id_example; // String | 

try {
    $result = $api_instance->escalatedAlertById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->escalatedAlertById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->escalatedAlertById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->escalatedAlertById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Escalate alert by ID api_response = api_instance.escalated_alert_by_id(id) print(api_response) except ApiException as e: print("Exception when calling AlertsApi->escalatedAlertById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewEscalatedAlertByIdParams()
// Escalate alert by ID
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.EscalatedAlertById(params) if err != nil { fmt.Printf("Exception when calling client.LM.EscalatedAlertById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 200 - Successfully escalated the alert

Status: default - Error


getAlertById

get alert

get alert by id


/alert/alerts/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/alert/alerts/{id}?needMessage=&customColumns=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        String id = id_example; // String | 
        Boolean needMessage = true; // Boolean | 
        String customColumns = customColumns_example; // String | 
        String fields = fields_example; // String | 
        try {
            Alert result = apiInstance.getAlertById(id, needMessage, customColumns, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        String id = id_example; // String | 
        Boolean needMessage = true; // Boolean | 
        String customColumns = customColumns_example; // String | 
        String fields = fields_example; // String | 
        try {
            Alert result = apiInstance.getAlertById(id, needMessage, customColumns, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *id = id_example; // 
Boolean *needMessage = true; //  (optional)
String *customColumns = customColumns_example; //  (optional)
String *fields = fields_example; //  (optional)

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// get alert
[apiInstance getAlertByIdWith:id
    needMessage:needMessage
    customColumns:customColumns
    fields:fields
              completionHandler: ^(Alert output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AlertsApi()
var id = id_example; // {{String}} 
var opts = { 
  'needMessage': true, // {{Boolean}} 
  'customColumns': customColumns_example, // {{String}} 
  'fields': fields_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAlertByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AlertsApi();
            var id = id_example;  // String | 
            var needMessage = true;  // Boolean |  (optional) 
            var customColumns = customColumns_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get alert
                Alert result = apiInstance.getAlertById(id, needMessage, customColumns, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.getAlertById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();
$id = id_example; // String | 
$needMessage = true; // Boolean | 
$customColumns = customColumns_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->getAlertById($id, $needMessage, $customColumns, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->getAlertById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $id = id_example; # String | 
my $needMessage = true; # Boolean | 
my $customColumns = customColumns_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->getAlertById(id => $id, needMessage => $needMessage, customColumns => $customColumns, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->getAlertById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get alert api_response = api_instance.get_alert_by_id(id, needMessage=needMessage, customColumns=customColumns, fields=fields) print(api_response) except ApiException as e: print("Exception when calling AlertsApi->getAlertById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetAlertByIdParams()
// get alert
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetAlertById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAlertById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
String
Required
Query parameters
Name Description
needMessage
Boolean
customColumns
String
fields
String

Responses

Status: 200 - Get alert by id

Status: default - Error


getAlertList

Get alert list

Retrieve the list of alerts


/alert/alerts

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/alert/alerts?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AlertsApi;

import java.io.File;
import java.util.*;

public class AlertsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AlertsApi apiInstance = new AlertsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertListPaginationResponse result = apiInstance.getAlertList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AlertsApi;

public class AlertsApiExample {

    public static void main(String[] args) {
        AlertsApi apiInstance = new AlertsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertListPaginationResponse result = apiInstance.getAlertList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AlertsApi#getAlertList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

AlertsApi *apiInstance = [[AlertsApi alloc] init];

// Get alert list
[apiInstance getAlertListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(AlertListPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AlertsApi()
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAlertList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAlertListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AlertsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // Get alert list
                AlertListPaginationResponse result = apiInstance.getAlertList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AlertsApi.getAlertList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAlertsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getAlertList($fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AlertsApi->getAlertList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AlertsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AlertsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getAlertList(fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AlertsApi->getAlertList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get alert list api_response = api_instance.get_alert_list(fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling AlertsApi->getAlertList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetAlertListParams()
// Get alert list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetAlertList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAlertList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successfully retrieved alert list

Status: default - Error


ApiPerfStats

getExternalApiStats

get external api stats info

get external api stats info


/apiStats/externalApis

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/apiStats/externalApis"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ApiPerfStatsApi;

import java.io.File;
import java.util.*;

public class ApiPerfStatsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        ApiPerfStatsApi apiInstance = new ApiPerfStatsApi();
        try {
            ApiPerfMetrics result = apiInstance.getExternalApiStats();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPerfStatsApi#getExternalApiStats");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ApiPerfStatsApi;

public class ApiPerfStatsApiExample {

    public static void main(String[] args) {
        ApiPerfStatsApi apiInstance = new ApiPerfStatsApi();
        try {
            ApiPerfMetrics result = apiInstance.getExternalApiStats();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ApiPerfStatsApi#getExternalApiStats");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

ApiPerfStatsApi *apiInstance = [[ApiPerfStatsApi alloc] init];

// get external api stats info
[apiInstance getExternalApiStatsWithCompletionHandler: 
              ^(ApiPerfMetrics output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.ApiPerfStatsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getExternalApiStats(callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getExternalApiStatsExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ApiPerfStatsApi();

            try
            {
                // get external api stats info
                ApiPerfMetrics result = apiInstance.getExternalApiStats();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ApiPerfStatsApi.getExternalApiStats: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiApiPerfStatsApi();

try {
    $result = $api_instance->getExternalApiStats();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ApiPerfStatsApi->getExternalApiStats: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ApiPerfStatsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ApiPerfStatsApi->new();

eval { 
    my $result = $api_instance->getExternalApiStats();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ApiPerfStatsApi->getExternalApiStats: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))



try: 
    # get external api stats info

    api_response = api_instance.get_external_api_stats()
    print(api_response)
except ApiException as e:
    print("Exception when calling ApiPerfStatsApi->getExternalApiStats: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetExternalApiStatsParams()
// get external api stats info
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetExternalApiStats(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetExternalApiStats: %v", err.Error()) } fmt.Print(resp) }

Parameters

Responses

Status: 200 - Successful operation

Status: default - Error


AppliesToFunctions

addAppliesToFunction

Add applies to function

Create a new applies to function


/setting/functions

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/functions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AppliesToFunctionsApi;

import java.io.File;
import java.util.*;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        AppliesToFunction body = ; // AppliesToFunction | 
        try {
            AppliesToFunction result = apiInstance.addAppliesToFunction(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#addAppliesToFunction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AppliesToFunctionsApi;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        AppliesToFunction body = ; // AppliesToFunction | 
        try {
            AppliesToFunction result = apiInstance.addAppliesToFunction(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#addAppliesToFunction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
AppliesToFunction *body = ; //  (optional)

AppliesToFunctionsApi *apiInstance = [[AppliesToFunctionsApi alloc] init];

// Add applies to function
[apiInstance addAppliesToFunctionWith:body
              completionHandler: ^(AppliesToFunction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AppliesToFunctionsApi()
var opts = { 
  'body':  // {{AppliesToFunction}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addAppliesToFunction(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addAppliesToFunctionExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AppliesToFunctionsApi();
            var body = new AppliesToFunction(); // AppliesToFunction |  (optional) 

            try
            {
                // Add applies to function
                AppliesToFunction result = apiInstance.addAppliesToFunction(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AppliesToFunctionsApi.addAppliesToFunction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAppliesToFunctionsApi();
$body = ; // AppliesToFunction | 

try {
    $result = $api_instance->addAppliesToFunction($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppliesToFunctionsApi->addAppliesToFunction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AppliesToFunctionsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AppliesToFunctionsApi->new();
my $body = WWW::SwaggerClient::Object::AppliesToFunction->new(); # AppliesToFunction | 

eval { 
    my $result = $api_instance->addAppliesToFunction(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AppliesToFunctionsApi->addAppliesToFunction: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Add applies to function api_response = api_instance.add_applies_to_function(body=body) print(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->addAppliesToFunction: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddAppliesToFunctionParams()
// Add applies to function
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddAppliesToFunction(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddAppliesToFunction: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Successfully added the applies to function

Status: default - Error


deleteAppliesToFunctionById

Delete applies to function

Delete a specific applies to function by its ID


/setting/functions/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/functions/{id}?ignoreReference="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AppliesToFunctionsApi;

import java.io.File;
import java.util.*;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        Integer id = 56; // Integer | 
        Boolean ignoreReference = true; // Boolean | 
        try {
            Object result = apiInstance.deleteAppliesToFunctionById(id, ignoreReference);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#deleteAppliesToFunctionById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AppliesToFunctionsApi;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        Integer id = 56; // Integer | 
        Boolean ignoreReference = true; // Boolean | 
        try {
            Object result = apiInstance.deleteAppliesToFunctionById(id, ignoreReference);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#deleteAppliesToFunctionById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
Boolean *ignoreReference = true; //  (optional)

AppliesToFunctionsApi *apiInstance = [[AppliesToFunctionsApi alloc] init];

// Delete applies to function
[apiInstance deleteAppliesToFunctionByIdWith:id
    ignoreReference:ignoreReference
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AppliesToFunctionsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'ignoreReference': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteAppliesToFunctionById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteAppliesToFunctionByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AppliesToFunctionsApi();
            var id = 56;  // Integer | 
            var ignoreReference = true;  // Boolean |  (optional) 

            try
            {
                // Delete applies to function
                Object result = apiInstance.deleteAppliesToFunctionById(id, ignoreReference);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AppliesToFunctionsApi.deleteAppliesToFunctionById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAppliesToFunctionsApi();
$id = 56; // Integer | 
$ignoreReference = true; // Boolean | 

try {
    $result = $api_instance->deleteAppliesToFunctionById($id, $ignoreReference);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppliesToFunctionsApi->deleteAppliesToFunctionById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AppliesToFunctionsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AppliesToFunctionsApi->new();
my $id = 56; # Integer | 
my $ignoreReference = true; # Boolean | 

eval { 
    my $result = $api_instance->deleteAppliesToFunctionById(id => $id, ignoreReference => $ignoreReference);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AppliesToFunctionsApi->deleteAppliesToFunctionById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Delete applies to function api_response = api_instance.delete_applies_to_function_by_id(id, ignoreReference=ignoreReference) print(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->deleteAppliesToFunctionById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteAppliesToFunctionByIdParams()
// Delete applies to function
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteAppliesToFunctionById(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteAppliesToFunctionById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
ignoreReference
Boolean

Responses

Status: 200 - Successfully deleted the applies to function

Status: default - Error


getAppliesToFunctionById

Get applies to function by ID

Retrieve a specific applies to function using its ID


/setting/functions/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/functions/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AppliesToFunctionsApi;

import java.io.File;
import java.util.*;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        Integer id = 56; // Integer | 
        try {
            AppliesToFunction result = apiInstance.getAppliesToFunctionById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#getAppliesToFunctionById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AppliesToFunctionsApi;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        Integer id = 56; // Integer | 
        try {
            AppliesToFunction result = apiInstance.getAppliesToFunctionById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#getAppliesToFunctionById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 

AppliesToFunctionsApi *apiInstance = [[AppliesToFunctionsApi alloc] init];

// Get applies to function by ID
[apiInstance getAppliesToFunctionByIdWith:id
              completionHandler: ^(AppliesToFunction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AppliesToFunctionsApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAppliesToFunctionById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAppliesToFunctionByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AppliesToFunctionsApi();
            var id = 56;  // Integer | 

            try
            {
                // Get applies to function by ID
                AppliesToFunction result = apiInstance.getAppliesToFunctionById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AppliesToFunctionsApi.getAppliesToFunctionById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAppliesToFunctionsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->getAppliesToFunctionById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppliesToFunctionsApi->getAppliesToFunctionById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AppliesToFunctionsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AppliesToFunctionsApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->getAppliesToFunctionById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AppliesToFunctionsApi->getAppliesToFunctionById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get applies to function by ID api_response = api_instance.get_applies_to_function_by_id(id) print(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->getAppliesToFunctionById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetAppliesToFunctionByIdParams()
// Get applies to function by ID
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetAppliesToFunctionById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAppliesToFunctionById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - Successfully retrieved the applies to function

Status: default - Error


getAppliesToFunctionList

Get applies to function list

Retrieve a paginated list of functions that apply


/setting/functions

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/functions?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AppliesToFunctionsApi;

import java.io.File;
import java.util.*;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            RestAppliesToFunctionPaginationResponse result = apiInstance.getAppliesToFunctionList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#getAppliesToFunctionList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AppliesToFunctionsApi;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            RestAppliesToFunctionPaginationResponse result = apiInstance.getAppliesToFunctionList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#getAppliesToFunctionList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

AppliesToFunctionsApi *apiInstance = [[AppliesToFunctionsApi alloc] init];

// Get applies to function list
[apiInstance getAppliesToFunctionListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(RestAppliesToFunctionPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AppliesToFunctionsApi()
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAppliesToFunctionList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAppliesToFunctionListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AppliesToFunctionsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // Get applies to function list
                RestAppliesToFunctionPaginationResponse result = apiInstance.getAppliesToFunctionList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AppliesToFunctionsApi.getAppliesToFunctionList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAppliesToFunctionsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getAppliesToFunctionList($fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppliesToFunctionsApi->getAppliesToFunctionList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AppliesToFunctionsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AppliesToFunctionsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getAppliesToFunctionList(fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AppliesToFunctionsApi->getAppliesToFunctionList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get applies to function list api_response = api_instance.get_applies_to_function_list(fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->getAppliesToFunctionList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetAppliesToFunctionListParams()
// Get applies to function list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetAppliesToFunctionList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAppliesToFunctionList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successfully retrieved the list of applies to functions

Status: default - Error


importAppliesToFunctionJson

Import AppliesTo function via json

Import a AppliesTo function using json data


/setting/functions/importjson

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"/santaba/rest/setting/functions/importjson?handleConflict=&fieldsToPreserve="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AppliesToFunctionsApi;

import java.io.File;
import java.util.*;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        FormDataContentDisposition file = ; // FormDataContentDisposition | 
        String handleConflict = handleConflict_example; // String | 
        array[String] fieldsToPreserve = ; // array[String] | 
        try {
            AppliesToFunction result = apiInstance.importAppliesToFunctionJson(file, handleConflict, fieldsToPreserve);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#importAppliesToFunctionJson");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AppliesToFunctionsApi;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        FormDataContentDisposition file = ; // FormDataContentDisposition | 
        String handleConflict = handleConflict_example; // String | 
        array[String] fieldsToPreserve = ; // array[String] | 
        try {
            AppliesToFunction result = apiInstance.importAppliesToFunctionJson(file, handleConflict, fieldsToPreserve);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#importAppliesToFunctionJson");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
FormDataContentDisposition *file = ; //  (optional)
String *handleConflict = handleConflict_example; //  (optional)
array[String] *fieldsToPreserve = ; //  (optional)

AppliesToFunctionsApi *apiInstance = [[AppliesToFunctionsApi alloc] init];

// Import AppliesTo function via json
[apiInstance importAppliesToFunctionJsonWith:file
    handleConflict:handleConflict
    fieldsToPreserve:fieldsToPreserve
              completionHandler: ^(AppliesToFunction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AppliesToFunctionsApi()
var opts = { 
  'file':  // {{FormDataContentDisposition}} 
  'handleConflict': handleConflict_example // {{String}} 
  'fieldsToPreserve':  // {{array[String]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importAppliesToFunctionJson(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class importAppliesToFunctionJsonExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AppliesToFunctionsApi();
            var file = new FormDataContentDisposition(); // FormDataContentDisposition |  (optional) 
            var handleConflict = handleConflict_example;  // String |  (optional) 
            var fieldsToPreserve = new array[String](); // array[String] |  (optional) 

            try
            {
                // Import AppliesTo function via json
                AppliesToFunction result = apiInstance.importAppliesToFunctionJson(file, handleConflict, fieldsToPreserve);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AppliesToFunctionsApi.importAppliesToFunctionJson: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAppliesToFunctionsApi();
$file = ; // FormDataContentDisposition | 
$handleConflict = handleConflict_example; // String | 
$fieldsToPreserve = ; // array[String] | 

try {
    $result = $api_instance->importAppliesToFunctionJson($file, $handleConflict, $fieldsToPreserve);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppliesToFunctionsApi->importAppliesToFunctionJson: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AppliesToFunctionsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AppliesToFunctionsApi->new();
my $file = ; # FormDataContentDisposition | 
my $handleConflict = handleConflict_example; # String | 
my $fieldsToPreserve = []; # array[String] | 

eval { 
    my $result = $api_instance->importAppliesToFunctionJson(file => $file, handleConflict => $handleConflict, fieldsToPreserve => $fieldsToPreserve);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AppliesToFunctionsApi->importAppliesToFunctionJson: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Import AppliesTo function via json api_response = api_instance.import_applies_to_function_json(file=file, handleConflict=handleConflict, fieldsToPreserve=fieldsToPreserve) print(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->importAppliesToFunctionJson: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewImportAppliesToFunctionJsonParams()
// Import AppliesTo function via json
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.ImportAppliesToFunctionJson(params) if err != nil { fmt.Printf("Exception when calling client.LM.ImportAppliesToFunctionJson: %v", err.Error()) } fmt.Print(resp) }

Parameters

Form parameters
Name Description
file
FormDataContentDisposition
Query parameters
Name Description
handleConflict
String
fieldsToPreserve
array[String]

Responses

Status: 200 - Successfully imported the AppliesTo function via Json

Status: default - Error


patchAppliesToFunction

Update applies to function

Update an existing applies to function


/setting/functions/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/functions/{id}?reason=&ignoreReference="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AppliesToFunctionsApi;

import java.io.File;
import java.util.*;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        Integer id = 56; // Integer | 
        AppliesToFunction body = ; // AppliesToFunction | 
        String reason = reason_example; // String | 
        Boolean ignoreReference = true; // Boolean | 
        try {
            AppliesToFunction result = apiInstance.patchAppliesToFunction(id, body, reason, ignoreReference);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#patchAppliesToFunction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AppliesToFunctionsApi;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        Integer id = 56; // Integer | 
        AppliesToFunction body = ; // AppliesToFunction | 
        String reason = reason_example; // String | 
        Boolean ignoreReference = true; // Boolean | 
        try {
            AppliesToFunction result = apiInstance.patchAppliesToFunction(id, body, reason, ignoreReference);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#patchAppliesToFunction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
AppliesToFunction *body = ; //  (optional)
String *reason = reason_example; //  (optional)
Boolean *ignoreReference = true; //  (optional)

AppliesToFunctionsApi *apiInstance = [[AppliesToFunctionsApi alloc] init];

// Update applies to function
[apiInstance patchAppliesToFunctionWith:id
    body:body
    reason:reason
    ignoreReference:ignoreReference
              completionHandler: ^(AppliesToFunction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AppliesToFunctionsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'body':  // {{AppliesToFunction}} 
  'reason': reason_example // {{String}} 
  'ignoreReference': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchAppliesToFunction(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchAppliesToFunctionExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AppliesToFunctionsApi();
            var id = 56;  // Integer | 
            var body = new AppliesToFunction(); // AppliesToFunction |  (optional) 
            var reason = reason_example;  // String |  (optional) 
            var ignoreReference = true;  // Boolean |  (optional) 

            try
            {
                // Update applies to function
                AppliesToFunction result = apiInstance.patchAppliesToFunction(id, body, reason, ignoreReference);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AppliesToFunctionsApi.patchAppliesToFunction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAppliesToFunctionsApi();
$id = 56; // Integer | 
$body = ; // AppliesToFunction | 
$reason = reason_example; // String | 
$ignoreReference = true; // Boolean | 

try {
    $result = $api_instance->patchAppliesToFunction($id, $body, $reason, $ignoreReference);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppliesToFunctionsApi->patchAppliesToFunction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AppliesToFunctionsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AppliesToFunctionsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::AppliesToFunction->new(); # AppliesToFunction | 
my $reason = reason_example; # String | 
my $ignoreReference = true; # Boolean | 

eval { 
    my $result = $api_instance->patchAppliesToFunction(id => $id, body => $body, reason => $reason, ignoreReference => $ignoreReference);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AppliesToFunctionsApi->patchAppliesToFunction: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update applies to function api_response = api_instance.patch_applies_to_function(id, body=body, reason=reason, ignoreReference=ignoreReference) print(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->patchAppliesToFunction: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewPatchAppliesToFunctionParams()
// Update applies to function
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.PatchAppliesToFunction(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchAppliesToFunction: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body
Query parameters
Name Description
reason
String
ignoreReference
Boolean

Responses

Status: 200 - Successfully updated the applies to function

Status: default - Error


updateAppliesToFunction

Update applies to function

Update an existing applies to function


/setting/functions/{id}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/functions/{id}?reason=&ignoreReference="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AppliesToFunctionsApi;

import java.io.File;
import java.util.*;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        Integer id = 56; // Integer | 
        AppliesToFunction body = ; // AppliesToFunction | 
        String reason = reason_example; // String | 
        Boolean ignoreReference = true; // Boolean | 
        try {
            AppliesToFunction result = apiInstance.updateAppliesToFunction(id, body, reason, ignoreReference);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#updateAppliesToFunction");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AppliesToFunctionsApi;

public class AppliesToFunctionsApiExample {

    public static void main(String[] args) {
        AppliesToFunctionsApi apiInstance = new AppliesToFunctionsApi();
        Integer id = 56; // Integer | 
        AppliesToFunction body = ; // AppliesToFunction | 
        String reason = reason_example; // String | 
        Boolean ignoreReference = true; // Boolean | 
        try {
            AppliesToFunction result = apiInstance.updateAppliesToFunction(id, body, reason, ignoreReference);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AppliesToFunctionsApi#updateAppliesToFunction");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
AppliesToFunction *body = ; //  (optional)
String *reason = reason_example; //  (optional)
Boolean *ignoreReference = true; //  (optional)

AppliesToFunctionsApi *apiInstance = [[AppliesToFunctionsApi alloc] init];

// Update applies to function
[apiInstance updateAppliesToFunctionWith:id
    body:body
    reason:reason
    ignoreReference:ignoreReference
              completionHandler: ^(AppliesToFunction output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AppliesToFunctionsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'body':  // {{AppliesToFunction}} 
  'reason': reason_example // {{String}} 
  'ignoreReference': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateAppliesToFunction(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateAppliesToFunctionExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AppliesToFunctionsApi();
            var id = 56;  // Integer | 
            var body = new AppliesToFunction(); // AppliesToFunction |  (optional) 
            var reason = reason_example;  // String |  (optional) 
            var ignoreReference = true;  // Boolean |  (optional) 

            try
            {
                // Update applies to function
                AppliesToFunction result = apiInstance.updateAppliesToFunction(id, body, reason, ignoreReference);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AppliesToFunctionsApi.updateAppliesToFunction: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAppliesToFunctionsApi();
$id = 56; // Integer | 
$body = ; // AppliesToFunction | 
$reason = reason_example; // String | 
$ignoreReference = true; // Boolean | 

try {
    $result = $api_instance->updateAppliesToFunction($id, $body, $reason, $ignoreReference);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AppliesToFunctionsApi->updateAppliesToFunction: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AppliesToFunctionsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AppliesToFunctionsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::AppliesToFunction->new(); # AppliesToFunction | 
my $reason = reason_example; # String | 
my $ignoreReference = true; # Boolean | 

eval { 
    my $result = $api_instance->updateAppliesToFunction(id => $id, body => $body, reason => $reason, ignoreReference => $ignoreReference);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AppliesToFunctionsApi->updateAppliesToFunction: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update applies to function api_response = api_instance.update_applies_to_function(id, body=body, reason=reason, ignoreReference=ignoreReference) print(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->updateAppliesToFunction: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateAppliesToFunctionParams()
// Update applies to function
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.UpdateAppliesToFunction(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateAppliesToFunction: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body
Query parameters
Name Description
reason
String
ignoreReference
Boolean

Responses

Status: 200 - Successfully updated the applies to function

Status: default - Error


AuditLogs

getAuditLogById

Get audit log by id

Retrieve a specific audit log by its ID


/setting/accesslogs/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/accesslogs/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuditLogsApi;

import java.io.File;
import java.util.*;

public class AuditLogsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AuditLogsApi apiInstance = new AuditLogsApi();
        String id = id_example; // String | 
        try {
            AuditLog result = apiInstance.getAuditLogById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditLogsApi#getAuditLogById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuditLogsApi;

public class AuditLogsApiExample {

    public static void main(String[] args) {
        AuditLogsApi apiInstance = new AuditLogsApi();
        String id = id_example; // String | 
        try {
            AuditLog result = apiInstance.getAuditLogById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditLogsApi#getAuditLogById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *id = id_example; // 

AuditLogsApi *apiInstance = [[AuditLogsApi alloc] init];

// Get audit log by id
[apiInstance getAuditLogByIdWith:id
              completionHandler: ^(AuditLog output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AuditLogsApi()
var id = id_example; // {{String}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuditLogById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAuditLogByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AuditLogsApi();
            var id = id_example;  // String | 

            try
            {
                // Get audit log by id
                AuditLog result = apiInstance.getAuditLogById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuditLogsApi.getAuditLogById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAuditLogsApi();
$id = id_example; // String | 

try {
    $result = $api_instance->getAuditLogById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditLogsApi->getAuditLogById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuditLogsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuditLogsApi->new();
my $id = id_example; # String | 

eval { 
    my $result = $api_instance->getAuditLogById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuditLogsApi->getAuditLogById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get audit log by id api_response = api_instance.get_audit_log_by_id(id) print(api_response) except ApiException as e: print("Exception when calling AuditLogsApi->getAuditLogById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetAuditLogByIdParams()
// Get audit log by id
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetAuditLogById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAuditLogById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 200 - Successfully retrieved the audit log by id

Status: default - Error


getAuditLogList

Get audit logs

Retrieve a paginated list of audit logs


/setting/accesslogs

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/accesslogs?format=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.AuditLogsApi;

import java.io.File;
import java.util.*;

public class AuditLogsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        AuditLogsApi apiInstance = new AuditLogsApi();
        String format = format_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AccessLogPaginationResponse result = apiInstance.getAuditLogList(format, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditLogsApi#getAuditLogList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.AuditLogsApi;

public class AuditLogsApiExample {

    public static void main(String[] args) {
        AuditLogsApi apiInstance = new AuditLogsApi();
        String format = format_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AccessLogPaginationResponse result = apiInstance.getAuditLogList(format, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AuditLogsApi#getAuditLogList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *format = format_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

AuditLogsApi *apiInstance = [[AuditLogsApi alloc] init];

// Get audit logs
[apiInstance getAuditLogListWith:format
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(AccessLogPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.AuditLogsApi()
var opts = { 
  'format': format_example, // {{String}} 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAuditLogList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAuditLogListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new AuditLogsApi();
            var format = format_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // Get audit logs
                AccessLogPaginationResponse result = apiInstance.getAuditLogList(format, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling AuditLogsApi.getAuditLogList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiAuditLogsApi();
$format = format_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getAuditLogList($format, $fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AuditLogsApi->getAuditLogList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::AuditLogsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::AuditLogsApi->new();
my $format = format_example; # String | 
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getAuditLogList(format => $format, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling AuditLogsApi->getAuditLogList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get audit logs api_response = api_instance.get_audit_log_list(format=format, fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling AuditLogsApi->getAuditLogList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetAuditLogListParams()
// Get audit logs
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetAuditLogList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAuditLogList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
format
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successfully retrieved the audit logs

Status: default - Error


BetaAPIs

addDiagnosticSource

Add diagnostics source

Adds a new diagnostics source


/setting/diagnosticsources

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/diagnosticsources"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        DiagnosticsSource body = ; // DiagnosticsSource | 
        try {
            DiagnosticsSource result = apiInstance.addDiagnosticSource(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#addDiagnosticSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        DiagnosticsSource body = ; // DiagnosticsSource | 
        try {
            DiagnosticsSource result = apiInstance.addDiagnosticSource(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#addDiagnosticSource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
DiagnosticsSource *body = ; //  (optional)

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Add diagnostics source
[apiInstance addDiagnosticSourceWith:body
              completionHandler: ^(DiagnosticsSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var opts = { 
  'body':  // {{DiagnosticsSource}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDiagnosticSource(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addDiagnosticSourceExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var body = new DiagnosticsSource(); // DiagnosticsSource |  (optional) 

            try
            {
                // Add diagnostics source
                DiagnosticsSource result = apiInstance.addDiagnosticSource(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.addDiagnosticSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$body = ; // DiagnosticsSource | 

try {
    $result = $api_instance->addDiagnosticSource($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->addDiagnosticSource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $body = WWW::SwaggerClient::Object::DiagnosticsSource->new(); # DiagnosticsSource | 

eval { 
    my $result = $api_instance->addDiagnosticSource(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->addDiagnosticSource: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Add diagnostics source api_response = api_instance.add_diagnostic_source(body=body) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->addDiagnosticSource: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddDiagnosticSourceParams()
// Add diagnostics source
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddDiagnosticSource(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDiagnosticSource: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Successfully added new diagnostics source

Status: default - Error


addRemediationSource

Add remediation source

Adds a new remediation source


/setting/remediationsources

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/remediationsources"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        RemediationSource body = ; // RemediationSource | 
        try {
            RemediationSource result = apiInstance.addRemediationSource(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#addRemediationSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        RemediationSource body = ; // RemediationSource | 
        try {
            RemediationSource result = apiInstance.addRemediationSource(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#addRemediationSource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
RemediationSource *body = ; //  (optional)

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Add remediation source
[apiInstance addRemediationSourceWith:body
              completionHandler: ^(RemediationSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var opts = { 
  'body':  // {{RemediationSource}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addRemediationSource(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addRemediationSourceExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var body = new RemediationSource(); // RemediationSource |  (optional) 

            try
            {
                // Add remediation source
                RemediationSource result = apiInstance.addRemediationSource(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.addRemediationSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$body = ; // RemediationSource | 

try {
    $result = $api_instance->addRemediationSource($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->addRemediationSource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $body = WWW::SwaggerClient::Object::RemediationSource->new(); # RemediationSource | 

eval { 
    my $result = $api_instance->addRemediationSource(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->addRemediationSource: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Add remediation source api_response = api_instance.add_remediation_source(body=body) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->addRemediationSource: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddRemediationSourceParams()
// Add remediation source
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddRemediationSource(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddRemediationSource: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Successfully added new remediation source

Status: default - Error


deleteDiagnosticSourceById

Delete a diagnostic source module

Deletes a diagnostic source module by its ID


/setting/diagnosticsources/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/diagnosticsources/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteDiagnosticSourceById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#deleteDiagnosticSourceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteDiagnosticSourceById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#deleteDiagnosticSourceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Delete a diagnostic source module
[apiInstance deleteDiagnosticSourceByIdWith:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDiagnosticSourceById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteDiagnosticSourceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var id = 56;  // Integer | 

            try
            {
                // Delete a diagnostic source module
                Object result = apiInstance.deleteDiagnosticSourceById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.deleteDiagnosticSourceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->deleteDiagnosticSourceById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->deleteDiagnosticSourceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->deleteDiagnosticSourceById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->deleteDiagnosticSourceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Delete a diagnostic source module api_response = api_instance.delete_diagnostic_source_by_id(id) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->deleteDiagnosticSourceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDiagnosticSourceByIdParams()
// Delete a diagnostic source module
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteDiagnosticSourceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteDiagnosticSourceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - Successfully deleted diagnostic source module

Status: default - Error


deleteRemediationSourceById

Delete a remediation source module

Deletes a remediation source module by its ID


/setting/remediationsources/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/remediationsources/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteRemediationSourceById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#deleteRemediationSourceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteRemediationSourceById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#deleteRemediationSourceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Delete a remediation source module
[apiInstance deleteRemediationSourceByIdWith:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteRemediationSourceById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteRemediationSourceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var id = 56;  // Integer | 

            try
            {
                // Delete a remediation source module
                Object result = apiInstance.deleteRemediationSourceById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.deleteRemediationSourceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->deleteRemediationSourceById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->deleteRemediationSourceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->deleteRemediationSourceById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->deleteRemediationSourceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Delete a remediation source module api_response = api_instance.delete_remediation_source_by_id(id) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->deleteRemediationSourceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteRemediationSourceByIdParams()
// Delete a remediation source module
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteRemediationSourceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteRemediationSourceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - Successfully deleted remediation source module

Status: default - Error


executeDiagnosticsManually

Trigger a diagnostic module for host.

Trigger a diagnostic module for host.


/setting/diagnosticsources/executemanually

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/diagnosticsources/executemanually"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        DiagnosticsSourceExecution body = ; // DiagnosticsSourceExecution | 
        try {
            DiagnosticsSourceExecution result = apiInstance.executeDiagnosticsManually(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#executeDiagnosticsManually");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        DiagnosticsSourceExecution body = ; // DiagnosticsSourceExecution | 
        try {
            DiagnosticsSourceExecution result = apiInstance.executeDiagnosticsManually(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#executeDiagnosticsManually");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
DiagnosticsSourceExecution *body = ; //  (optional)

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Trigger a diagnostic module for host.
[apiInstance executeDiagnosticsManuallyWith:body
              completionHandler: ^(DiagnosticsSourceExecution output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var opts = { 
  'body':  // {{DiagnosticsSourceExecution}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.executeDiagnosticsManually(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class executeDiagnosticsManuallyExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var body = new DiagnosticsSourceExecution(); // DiagnosticsSourceExecution |  (optional) 

            try
            {
                // Trigger a diagnostic module for host.
                DiagnosticsSourceExecution result = apiInstance.executeDiagnosticsManually(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.executeDiagnosticsManually: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$body = ; // DiagnosticsSourceExecution | 

try {
    $result = $api_instance->executeDiagnosticsManually($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->executeDiagnosticsManually: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $body = WWW::SwaggerClient::Object::DiagnosticsSourceExecution->new(); # DiagnosticsSourceExecution | 

eval { 
    my $result = $api_instance->executeDiagnosticsManually(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->executeDiagnosticsManually: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Trigger a diagnostic module for host. api_response = api_instance.execute_diagnostics_manually(body=body) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->executeDiagnosticsManually: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewExecuteDiagnosticsManuallyParams()
// Trigger a diagnostic module for host.
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.ExecuteDiagnosticsManually(params) if err != nil { fmt.Printf("Exception when calling client.LM.ExecuteDiagnosticsManually: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Trigger a diagnostic module for host

Status: default - Error


executeRemediationManually

Trigger a remediation module for host.

Trigger a remediation module for host.


/setting/remediationsources/executemanually

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/remediationsources/executemanually"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        RemediationSourceExecution body = ; // RemediationSourceExecution | 
        try {
            RemediationSourceExecution result = apiInstance.executeRemediationManually(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#executeRemediationManually");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        RemediationSourceExecution body = ; // RemediationSourceExecution | 
        try {
            RemediationSourceExecution result = apiInstance.executeRemediationManually(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#executeRemediationManually");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
RemediationSourceExecution *body = ; //  (optional)

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Trigger a remediation module for host.
[apiInstance executeRemediationManuallyWith:body
              completionHandler: ^(RemediationSourceExecution output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var opts = { 
  'body':  // {{RemediationSourceExecution}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.executeRemediationManually(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class executeRemediationManuallyExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var body = new RemediationSourceExecution(); // RemediationSourceExecution |  (optional) 

            try
            {
                // Trigger a remediation module for host.
                RemediationSourceExecution result = apiInstance.executeRemediationManually(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.executeRemediationManually: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$body = ; // RemediationSourceExecution | 

try {
    $result = $api_instance->executeRemediationManually($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->executeRemediationManually: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $body = WWW::SwaggerClient::Object::RemediationSourceExecution->new(); # RemediationSourceExecution | 

eval { 
    my $result = $api_instance->executeRemediationManually(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->executeRemediationManually: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Trigger a remediation module for host. api_response = api_instance.execute_remediation_manually(body=body) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->executeRemediationManually: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewExecuteRemediationManuallyParams()
// Trigger a remediation module for host.
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.ExecuteRemediationManually(params) if err != nil { fmt.Printf("Exception when calling client.LM.ExecuteRemediationManually: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Trigger a remediation module for host

Status: default - Error


getDiagnosticSourcesById

Get diagnostics sources by ID

Retrieves a diagnostics source by its ID


/setting/diagnosticsources/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/diagnosticsources/{id}?format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        String format = format_example; // String | 
        try {
            DiagnosticsSource result = apiInstance.getDiagnosticSourcesById(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#getDiagnosticSourcesById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        String format = format_example; // String | 
        try {
            DiagnosticsSource result = apiInstance.getDiagnosticSourcesById(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#getDiagnosticSourcesById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
String *format = format_example; //  (optional)

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Get diagnostics sources by ID
[apiInstance getDiagnosticSourcesByIdWith:id
    format:format
              completionHandler: ^(DiagnosticsSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'format': format_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDiagnosticSourcesById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDiagnosticSourcesByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var id = 56;  // Integer | 
            var format = format_example;  // String |  (optional) 

            try
            {
                // Get diagnostics sources by ID
                DiagnosticsSource result = apiInstance.getDiagnosticSourcesById(id, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.getDiagnosticSourcesById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$id = 56; // Integer | 
$format = format_example; // String | 

try {
    $result = $api_instance->getDiagnosticSourcesById($id, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->getDiagnosticSourcesById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $id = 56; # Integer | 
my $format = format_example; # String | 

eval { 
    my $result = $api_instance->getDiagnosticSourcesById(id => $id, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->getDiagnosticSourcesById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get diagnostics sources by ID api_response = api_instance.get_diagnostic_sources_by_id(id, format=format) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->getDiagnosticSourcesById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDiagnosticSourcesByIdParams()
// Get diagnostics sources by ID
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDiagnosticSourcesById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDiagnosticSourcesById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
format
String

Responses

Status: 200 - Successfully retrieved diagnostics source by ID

Status: default - Error


getDiagnosticSourcesList

Get diagnostics sources list

Retrieves a list of diagnostics sources


/setting/diagnosticsources

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/diagnosticsources"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        try {
            DiagnosticsourcePaginationResponse result = apiInstance.getDiagnosticSourcesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#getDiagnosticSourcesList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        try {
            DiagnosticsourcePaginationResponse result = apiInstance.getDiagnosticSourcesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#getDiagnosticSourcesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Get diagnostics sources list
[apiInstance getDiagnosticSourcesListWithCompletionHandler: 
              ^(DiagnosticsourcePaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDiagnosticSourcesList(callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDiagnosticSourcesListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();

            try
            {
                // Get diagnostics sources list
                DiagnosticsourcePaginationResponse result = apiInstance.getDiagnosticSourcesList();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.getDiagnosticSourcesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();

try {
    $result = $api_instance->getDiagnosticSourcesList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->getDiagnosticSourcesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();

eval { 
    my $result = $api_instance->getDiagnosticSourcesList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->getDiagnosticSourcesList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))



try: 
    # Get diagnostics sources list

    api_response = api_instance.get_diagnostic_sources_list()
    print(api_response)
except ApiException as e:
    print("Exception when calling BetaAPIsApi->getDiagnosticSourcesList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDiagnosticSourcesListParams()
// Get diagnostics sources list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDiagnosticSourcesList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDiagnosticSourcesList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Responses

Status: 200 - Successfully retrieved diagnostics sources list

Status: default - Error


getRemediationSourcesById

Get remediation sources by ID

Retrieves a remediation source by its ID


/setting/remediationsources/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/remediationsources/{id}?format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        String format = format_example; // String | 
        try {
            RemediationSource result = apiInstance.getRemediationSourcesById(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#getRemediationSourcesById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        String format = format_example; // String | 
        try {
            RemediationSource result = apiInstance.getRemediationSourcesById(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#getRemediationSourcesById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
String *format = format_example; //  (optional)

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Get remediation sources by ID
[apiInstance getRemediationSourcesByIdWith:id
    format:format
              completionHandler: ^(RemediationSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'format': format_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRemediationSourcesById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getRemediationSourcesByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var id = 56;  // Integer | 
            var format = format_example;  // String |  (optional) 

            try
            {
                // Get remediation sources by ID
                RemediationSource result = apiInstance.getRemediationSourcesById(id, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.getRemediationSourcesById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$id = 56; // Integer | 
$format = format_example; // String | 

try {
    $result = $api_instance->getRemediationSourcesById($id, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->getRemediationSourcesById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $id = 56; # Integer | 
my $format = format_example; # String | 

eval { 
    my $result = $api_instance->getRemediationSourcesById(id => $id, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->getRemediationSourcesById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get remediation sources by ID api_response = api_instance.get_remediation_sources_by_id(id, format=format) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->getRemediationSourcesById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetRemediationSourcesByIdParams()
// Get remediation sources by ID
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetRemediationSourcesById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetRemediationSourcesById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
format
String

Responses

Status: 200 - Successfully retrieved remediation source by ID

Status: default - Error


getRemediationSourcesList

Get remediation sources list

Retrieves a list of remediation sources


/setting/remediationsources

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/remediationsources"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        try {
            RemediationSourcePaginationResponse result = apiInstance.getRemediationSourcesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#getRemediationSourcesList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        try {
            RemediationSourcePaginationResponse result = apiInstance.getRemediationSourcesList();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#getRemediationSourcesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Get remediation sources list
[apiInstance getRemediationSourcesListWithCompletionHandler: 
              ^(RemediationSourcePaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRemediationSourcesList(callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getRemediationSourcesListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();

            try
            {
                // Get remediation sources list
                RemediationSourcePaginationResponse result = apiInstance.getRemediationSourcesList();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.getRemediationSourcesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();

try {
    $result = $api_instance->getRemediationSourcesList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->getRemediationSourcesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();

eval { 
    my $result = $api_instance->getRemediationSourcesList();
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->getRemediationSourcesList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))



try: 
    # Get remediation sources list

    api_response = api_instance.get_remediation_sources_list()
    print(api_response)
except ApiException as e:
    print("Exception when calling BetaAPIsApi->getRemediationSourcesList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetRemediationSourcesListParams()
// Get remediation sources list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetRemediationSourcesList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetRemediationSourcesList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Responses

Status: 200 - Successfully retrieved remediation sources list

Status: default - Error


importDiagnosticSourceJson

Import DiagnosticSource via json

Import a DiagnosticSource using json data


/setting/diagnosticsources/importjson

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"/santaba/rest/setting/diagnosticsources/importjson?handleConflict=&fieldsToPreserve="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        FormDataContentDisposition file = ; // FormDataContentDisposition | 
        String handleConflict = handleConflict_example; // String | 
        array[String] fieldsToPreserve = ; // array[String] | 
        try {
            RestDiagnosticSourceV4 result = apiInstance.importDiagnosticSourceJson(file, handleConflict, fieldsToPreserve);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#importDiagnosticSourceJson");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        FormDataContentDisposition file = ; // FormDataContentDisposition | 
        String handleConflict = handleConflict_example; // String | 
        array[String] fieldsToPreserve = ; // array[String] | 
        try {
            RestDiagnosticSourceV4 result = apiInstance.importDiagnosticSourceJson(file, handleConflict, fieldsToPreserve);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#importDiagnosticSourceJson");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
FormDataContentDisposition *file = ; //  (optional)
String *handleConflict = handleConflict_example; //  (optional)
array[String] *fieldsToPreserve = ; //  (optional)

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Import DiagnosticSource via json
[apiInstance importDiagnosticSourceJsonWith:file
    handleConflict:handleConflict
    fieldsToPreserve:fieldsToPreserve
              completionHandler: ^(RestDiagnosticSourceV4 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var opts = { 
  'file':  // {{FormDataContentDisposition}} 
  'handleConflict': handleConflict_example // {{String}} 
  'fieldsToPreserve':  // {{array[String]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importDiagnosticSourceJson(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class importDiagnosticSourceJsonExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var file = new FormDataContentDisposition(); // FormDataContentDisposition |  (optional) 
            var handleConflict = handleConflict_example;  // String |  (optional) 
            var fieldsToPreserve = new array[String](); // array[String] |  (optional) 

            try
            {
                // Import DiagnosticSource via json
                RestDiagnosticSourceV4 result = apiInstance.importDiagnosticSourceJson(file, handleConflict, fieldsToPreserve);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.importDiagnosticSourceJson: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$file = ; // FormDataContentDisposition | 
$handleConflict = handleConflict_example; // String | 
$fieldsToPreserve = ; // array[String] | 

try {
    $result = $api_instance->importDiagnosticSourceJson($file, $handleConflict, $fieldsToPreserve);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->importDiagnosticSourceJson: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $file = ; # FormDataContentDisposition | 
my $handleConflict = handleConflict_example; # String | 
my $fieldsToPreserve = []; # array[String] | 

eval { 
    my $result = $api_instance->importDiagnosticSourceJson(file => $file, handleConflict => $handleConflict, fieldsToPreserve => $fieldsToPreserve);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->importDiagnosticSourceJson: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Import DiagnosticSource via json api_response = api_instance.import_diagnostic_source_json(file=file, handleConflict=handleConflict, fieldsToPreserve=fieldsToPreserve) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->importDiagnosticSourceJson: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewImportDiagnosticSourceJsonParams()
// Import DiagnosticSource via json
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.ImportDiagnosticSourceJson(params) if err != nil { fmt.Printf("Exception when calling client.LM.ImportDiagnosticSourceJson: %v", err.Error()) } fmt.Print(resp) }

Parameters

Form parameters
Name Description
file
FormDataContentDisposition
Query parameters
Name Description
handleConflict
String
fieldsToPreserve
array[String]

Responses

Status: 200 - Successfully imported the DiagnosticSource via Json

Status: default - Error


patchDiagnosticSourceById

Update a diagnostics source

Updates a diagnostics source by its ID


/setting/diagnosticsources/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/diagnosticsources/{id}?reason="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        DiagnosticsSource body = ; // DiagnosticsSource | 
        String reason = reason_example; // String | 
        try {
            DiagnosticsSource result = apiInstance.patchDiagnosticSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#patchDiagnosticSourceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        DiagnosticsSource body = ; // DiagnosticsSource | 
        String reason = reason_example; // String | 
        try {
            DiagnosticsSource result = apiInstance.patchDiagnosticSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#patchDiagnosticSourceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
DiagnosticsSource *body = ; //  (optional)
String *reason = reason_example; //  (optional)

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Update a diagnostics source
[apiInstance patchDiagnosticSourceByIdWith:id
    body:body
    reason:reason
              completionHandler: ^(DiagnosticsSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'body':  // {{DiagnosticsSource}} 
  'reason': reason_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchDiagnosticSourceById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchDiagnosticSourceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var id = 56;  // Integer | 
            var body = new DiagnosticsSource(); // DiagnosticsSource |  (optional) 
            var reason = reason_example;  // String |  (optional) 

            try
            {
                // Update a diagnostics source
                DiagnosticsSource result = apiInstance.patchDiagnosticSourceById(id, body, reason);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.patchDiagnosticSourceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$id = 56; // Integer | 
$body = ; // DiagnosticsSource | 
$reason = reason_example; // String | 

try {
    $result = $api_instance->patchDiagnosticSourceById($id, $body, $reason);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->patchDiagnosticSourceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DiagnosticsSource->new(); # DiagnosticsSource | 
my $reason = reason_example; # String | 

eval { 
    my $result = $api_instance->patchDiagnosticSourceById(id => $id, body => $body, reason => $reason);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->patchDiagnosticSourceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update a diagnostics source api_response = api_instance.patch_diagnostic_source_by_id(id, body=body, reason=reason) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->patchDiagnosticSourceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDiagnosticSourceByIdParams()
// Update a diagnostics source
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.PatchDiagnosticSourceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchDiagnosticSourceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body
Query parameters
Name Description
reason
String

Responses

Status: 200 - Successfully updated diagnostics source

Status: default - Error


patchRemediationSourceById

Update a remediation source

Updates a remediation source by its ID


/setting/remediationsources/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/remediationsources/{id}?reason="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        RemediationSource body = ; // RemediationSource | 
        String reason = reason_example; // String | 
        try {
            RemediationSource result = apiInstance.patchRemediationSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#patchRemediationSourceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        RemediationSource body = ; // RemediationSource | 
        String reason = reason_example; // String | 
        try {
            RemediationSource result = apiInstance.patchRemediationSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#patchRemediationSourceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
RemediationSource *body = ; //  (optional)
String *reason = reason_example; //  (optional)

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Update a remediation source
[apiInstance patchRemediationSourceByIdWith:id
    body:body
    reason:reason
              completionHandler: ^(RemediationSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'body':  // {{RemediationSource}} 
  'reason': reason_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchRemediationSourceById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchRemediationSourceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var id = 56;  // Integer | 
            var body = new RemediationSource(); // RemediationSource |  (optional) 
            var reason = reason_example;  // String |  (optional) 

            try
            {
                // Update a remediation source
                RemediationSource result = apiInstance.patchRemediationSourceById(id, body, reason);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.patchRemediationSourceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$id = 56; // Integer | 
$body = ; // RemediationSource | 
$reason = reason_example; // String | 

try {
    $result = $api_instance->patchRemediationSourceById($id, $body, $reason);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->patchRemediationSourceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::RemediationSource->new(); # RemediationSource | 
my $reason = reason_example; # String | 

eval { 
    my $result = $api_instance->patchRemediationSourceById(id => $id, body => $body, reason => $reason);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->patchRemediationSourceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update a remediation source api_response = api_instance.patch_remediation_source_by_id(id, body=body, reason=reason) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->patchRemediationSourceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewPatchRemediationSourceByIdParams()
// Update a remediation source
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.PatchRemediationSourceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchRemediationSourceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body
Query parameters
Name Description
reason
String

Responses

Status: 200 - Successfully updated remediation source

Status: default - Error


updateDiagnosticSourceById

Update a diagnostics source

Updates a diagnostics source by its ID


/setting/diagnosticsources/{id}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/diagnosticsources/{id}?reason="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        DiagnosticsSource body = ; // DiagnosticsSource | 
        String reason = reason_example; // String | 
        try {
            DiagnosticsSource result = apiInstance.updateDiagnosticSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#updateDiagnosticSourceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        DiagnosticsSource body = ; // DiagnosticsSource | 
        String reason = reason_example; // String | 
        try {
            DiagnosticsSource result = apiInstance.updateDiagnosticSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#updateDiagnosticSourceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
DiagnosticsSource *body = ; //  (optional)
String *reason = reason_example; //  (optional)

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Update a diagnostics source
[apiInstance updateDiagnosticSourceByIdWith:id
    body:body
    reason:reason
              completionHandler: ^(DiagnosticsSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'body':  // {{DiagnosticsSource}} 
  'reason': reason_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDiagnosticSourceById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateDiagnosticSourceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var id = 56;  // Integer | 
            var body = new DiagnosticsSource(); // DiagnosticsSource |  (optional) 
            var reason = reason_example;  // String |  (optional) 

            try
            {
                // Update a diagnostics source
                DiagnosticsSource result = apiInstance.updateDiagnosticSourceById(id, body, reason);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.updateDiagnosticSourceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$id = 56; // Integer | 
$body = ; // DiagnosticsSource | 
$reason = reason_example; // String | 

try {
    $result = $api_instance->updateDiagnosticSourceById($id, $body, $reason);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->updateDiagnosticSourceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DiagnosticsSource->new(); # DiagnosticsSource | 
my $reason = reason_example; # String | 

eval { 
    my $result = $api_instance->updateDiagnosticSourceById(id => $id, body => $body, reason => $reason);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->updateDiagnosticSourceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update a diagnostics source api_response = api_instance.update_diagnostic_source_by_id(id, body=body, reason=reason) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->updateDiagnosticSourceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDiagnosticSourceByIdParams()
// Update a diagnostics source
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.UpdateDiagnosticSourceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateDiagnosticSourceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body
Query parameters
Name Description
reason
String

Responses

Status: 200 - Successfully updated diagnostics source

Status: default - Error


updateRemediationSourceById

Update a remediation source

Updates a remediation source by its ID


/setting/remediationsources/{id}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/remediationsources/{id}?reason="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.BetaAPIsApi;

import java.io.File;
import java.util.*;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        RemediationSource body = ; // RemediationSource | 
        String reason = reason_example; // String | 
        try {
            RemediationSource result = apiInstance.updateRemediationSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#updateRemediationSourceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.BetaAPIsApi;

public class BetaAPIsApiExample {

    public static void main(String[] args) {
        BetaAPIsApi apiInstance = new BetaAPIsApi();
        Integer id = 56; // Integer | 
        RemediationSource body = ; // RemediationSource | 
        String reason = reason_example; // String | 
        try {
            RemediationSource result = apiInstance.updateRemediationSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling BetaAPIsApi#updateRemediationSourceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
RemediationSource *body = ; //  (optional)
String *reason = reason_example; //  (optional)

BetaAPIsApi *apiInstance = [[BetaAPIsApi alloc] init];

// Update a remediation source
[apiInstance updateRemediationSourceByIdWith:id
    body:body
    reason:reason
              completionHandler: ^(RemediationSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.BetaAPIsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'body':  // {{RemediationSource}} 
  'reason': reason_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateRemediationSourceById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateRemediationSourceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new BetaAPIsApi();
            var id = 56;  // Integer | 
            var body = new RemediationSource(); // RemediationSource |  (optional) 
            var reason = reason_example;  // String |  (optional) 

            try
            {
                // Update a remediation source
                RemediationSource result = apiInstance.updateRemediationSourceById(id, body, reason);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling BetaAPIsApi.updateRemediationSourceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiBetaAPIsApi();
$id = 56; // Integer | 
$body = ; // RemediationSource | 
$reason = reason_example; // String | 

try {
    $result = $api_instance->updateRemediationSourceById($id, $body, $reason);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BetaAPIsApi->updateRemediationSourceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::BetaAPIsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::BetaAPIsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::RemediationSource->new(); # RemediationSource | 
my $reason = reason_example; # String | 

eval { 
    my $result = $api_instance->updateRemediationSourceById(id => $id, body => $body, reason => $reason);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling BetaAPIsApi->updateRemediationSourceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update a remediation source api_response = api_instance.update_remediation_source_by_id(id, body=body, reason=reason) print(api_response) except ApiException as e: print("Exception when calling BetaAPIsApi->updateRemediationSourceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateRemediationSourceByIdParams()
// Update a remediation source
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.UpdateRemediationSourceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateRemediationSourceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body
Query parameters
Name Description
reason
String

Responses

Status: 200 - Successfully updated remediation source

Status: default - Error


CollectorGroups

addCollectorGroup

Add collector group

Create a new collector group


/setting/collector/groups

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/collector/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorGroupsApi;

import java.io.File;
import java.util.*;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        CollectorGroup body = ; // CollectorGroup | 
        try {
            CollectorGroup result = apiInstance.addCollectorGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#addCollectorGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorGroupsApi;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        CollectorGroup body = ; // CollectorGroup | 
        try {
            CollectorGroup result = apiInstance.addCollectorGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#addCollectorGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
CollectorGroup *body = ; // 

CollectorGroupsApi *apiInstance = [[CollectorGroupsApi alloc] init];

// Add collector group
[apiInstance addCollectorGroupWith:body
              completionHandler: ^(CollectorGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorGroupsApi()
var body = ; // {{CollectorGroup}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCollectorGroup(body, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addCollectorGroupExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorGroupsApi();
            var body = new CollectorGroup(); // CollectorGroup | 

            try
            {
                // Add collector group
                CollectorGroup result = apiInstance.addCollectorGroup(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorGroupsApi.addCollectorGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorGroupsApi();
$body = ; // CollectorGroup | 

try {
    $result = $api_instance->addCollectorGroup($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorGroupsApi->addCollectorGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorGroupsApi->new();
my $body = WWW::SwaggerClient::Object::CollectorGroup->new(); # CollectorGroup | 

eval { 
    my $result = $api_instance->addCollectorGroup(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorGroupsApi->addCollectorGroup: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Add collector group api_response = api_instance.add_collector_group(body) print(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->addCollectorGroup: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddCollectorGroupParams()
// Add collector group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddCollectorGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddCollectorGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Successfully added the collector group

Status: default - Error


deleteCollectorGroupById

Delete collector group

Delete a specific collector group by its ID


/setting/collector/groups/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/collector/groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorGroupsApi;

import java.io.File;
import java.util.*;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteCollectorGroupById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#deleteCollectorGroupById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorGroupsApi;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteCollectorGroupById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#deleteCollectorGroupById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 

CollectorGroupsApi *apiInstance = [[CollectorGroupsApi alloc] init];

// Delete collector group
[apiInstance deleteCollectorGroupByIdWith:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorGroupsApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCollectorGroupById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteCollectorGroupByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorGroupsApi();
            var id = 56;  // Integer | 

            try
            {
                // Delete collector group
                Object result = apiInstance.deleteCollectorGroupById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorGroupsApi.deleteCollectorGroupById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorGroupsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->deleteCollectorGroupById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorGroupsApi->deleteCollectorGroupById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorGroupsApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->deleteCollectorGroupById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorGroupsApi->deleteCollectorGroupById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Delete collector group api_response = api_instance.delete_collector_group_by_id(id) print(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->deleteCollectorGroupById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteCollectorGroupByIdParams()
// Delete collector group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteCollectorGroupById(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteCollectorGroupById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - Successfully deleted the collector group

Status: default - Error


getCollectorGroupById

Get collector group

Retrieve details of a specific collector group by its ID


/setting/collector/groups/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/collector/groups/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorGroupsApi;

import java.io.File;
import java.util.*;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            CollectorGroup result = apiInstance.getCollectorGroupById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#getCollectorGroupById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorGroupsApi;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            CollectorGroup result = apiInstance.getCollectorGroupById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#getCollectorGroupById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
String *fields = fields_example; //  (optional)

CollectorGroupsApi *apiInstance = [[CollectorGroupsApi alloc] init];

// Get collector group
[apiInstance getCollectorGroupByIdWith:id
    fields:fields
              completionHandler: ^(CollectorGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorGroupsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'fields': fields_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCollectorGroupById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getCollectorGroupByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorGroupsApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // Get collector group
                CollectorGroup result = apiInstance.getCollectorGroupById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorGroupsApi.getCollectorGroupById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorGroupsApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->getCollectorGroupById($id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorGroupsApi->getCollectorGroupById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorGroupsApi->new();
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->getCollectorGroupById(id => $id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorGroupsApi->getCollectorGroupById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get collector group api_response = api_instance.get_collector_group_by_id(id, fields=fields) print(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->getCollectorGroupById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorGroupByIdParams()
// Get collector group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetCollectorGroupById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetCollectorGroupById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
fields
String

Responses

Status: 200 - Successfully retrieved the collector group

Status: default - Error


getCollectorGroupList

Get collector group list

Retrieve a paginated list of collector groups


/setting/collector/groups

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/collector/groups?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorGroupsApi;

import java.io.File;
import java.util.*;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            CollectorGroupPaginationResponse result = apiInstance.getCollectorGroupList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#getCollectorGroupList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorGroupsApi;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            CollectorGroupPaginationResponse result = apiInstance.getCollectorGroupList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#getCollectorGroupList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

CollectorGroupsApi *apiInstance = [[CollectorGroupsApi alloc] init];

// Get collector group list
[apiInstance getCollectorGroupListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(CollectorGroupPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorGroupsApi()
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCollectorGroupList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getCollectorGroupListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorGroupsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // Get collector group list
                CollectorGroupPaginationResponse result = apiInstance.getCollectorGroupList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorGroupsApi.getCollectorGroupList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorGroupsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getCollectorGroupList($fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorGroupsApi->getCollectorGroupList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorGroupsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getCollectorGroupList(fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorGroupsApi->getCollectorGroupList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get collector group list api_response = api_instance.get_collector_group_list(fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->getCollectorGroupList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorGroupListParams()
// Get collector group list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetCollectorGroupList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetCollectorGroupList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successfully retrieved the collector group list

Status: default - Error


patchCollectorGroupById

Update collector group

Update the details of a specific collector group by its ID


/setting/collector/groups/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/collector/groups/{id}?autoBalanceMonitoredDevices=&forceUpdateFailedOverDevices=&opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorGroupsApi;

import java.io.File;
import java.util.*;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        Integer id = 56; // Integer | 
        CollectorGroup body = ; // CollectorGroup | 
        Boolean autoBalanceMonitoredDevices = true; // Boolean | 
        Boolean forceUpdateFailedOverDevices = true; // Boolean | 
        String opType = opType_example; // String | 
        try {
            CollectorGroup result = apiInstance.patchCollectorGroupById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#patchCollectorGroupById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorGroupsApi;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        Integer id = 56; // Integer | 
        CollectorGroup body = ; // CollectorGroup | 
        Boolean autoBalanceMonitoredDevices = true; // Boolean | 
        Boolean forceUpdateFailedOverDevices = true; // Boolean | 
        String opType = opType_example; // String | 
        try {
            CollectorGroup result = apiInstance.patchCollectorGroupById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#patchCollectorGroupById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
CollectorGroup *body = ; // 
Boolean *autoBalanceMonitoredDevices = true; //  (optional)
Boolean *forceUpdateFailedOverDevices = true; //  (optional)
String *opType = opType_example; //  (optional)

CollectorGroupsApi *apiInstance = [[CollectorGroupsApi alloc] init];

// Update collector group
[apiInstance patchCollectorGroupByIdWith
    id:id:body
    autoBalanceMonitoredDevices:autoBalanceMonitoredDevices
    forceUpdateFailedOverDevices:forceUpdateFailedOverDevices
    opType:opType
              completionHandler: ^(CollectorGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorGroupsApi()
var id = 56; // {{Integer}} 
var body = ; // {{CollectorGroup}} 
var opts = { 
  'autoBalanceMonitoredDevices': true // {{Boolean}} 
  'forceUpdateFailedOverDevices': true // {{Boolean}} 
  'opType': opType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchCollectorGroupById(idbody, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchCollectorGroupByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorGroupsApi();
            var id = 56;  // Integer | 
            var body = new CollectorGroup(); // CollectorGroup | 
            var autoBalanceMonitoredDevices = true;  // Boolean |  (optional) 
            var forceUpdateFailedOverDevices = true;  // Boolean |  (optional) 
            var opType = opType_example;  // String |  (optional) 

            try
            {
                // Update collector group
                CollectorGroup result = apiInstance.patchCollectorGroupById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorGroupsApi.patchCollectorGroupById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorGroupsApi();
$id = 56; // Integer | 
$body = ; // CollectorGroup | 
$autoBalanceMonitoredDevices = true; // Boolean | 
$forceUpdateFailedOverDevices = true; // Boolean | 
$opType = opType_example; // String | 

try {
    $result = $api_instance->patchCollectorGroupById($id, $body, $autoBalanceMonitoredDevices, $forceUpdateFailedOverDevices, $opType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorGroupsApi->patchCollectorGroupById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::CollectorGroup->new(); # CollectorGroup | 
my $autoBalanceMonitoredDevices = true; # Boolean | 
my $forceUpdateFailedOverDevices = true; # Boolean | 
my $opType = opType_example; # String | 

eval { 
    my $result = $api_instance->patchCollectorGroupById(id => $id, body => $body, autoBalanceMonitoredDevices => $autoBalanceMonitoredDevices, forceUpdateFailedOverDevices => $forceUpdateFailedOverDevices, opType => $opType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorGroupsApi->patchCollectorGroupById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update collector group api_response = api_instance.patch_collector_group_by_id(id, body, autoBalanceMonitoredDevices=autoBalanceMonitoredDevices, forceUpdateFailedOverDevices=forceUpdateFailedOverDevices, opType=opType) print(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->patchCollectorGroupById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewPatchCollectorGroupByIdParams()
// Update collector group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.PatchCollectorGroupById(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchCollectorGroupById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
autoBalanceMonitoredDevices
Boolean
forceUpdateFailedOverDevices
Boolean
opType
String

Responses

Status: 200 - Successfully updated the collector group

Status: default - Error


updateCollectorGroupById

Update collector group

Update the details of a specific collector group by its ID


/setting/collector/groups/{id}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/collector/groups/{id}?autoBalanceMonitoredDevices=&forceUpdateFailedOverDevices=&opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorGroupsApi;

import java.io.File;
import java.util.*;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        Integer id = 56; // Integer | 
        CollectorGroup body = ; // CollectorGroup | 
        Boolean autoBalanceMonitoredDevices = true; // Boolean | 
        Boolean forceUpdateFailedOverDevices = true; // Boolean | 
        String opType = opType_example; // String | 
        try {
            CollectorGroup result = apiInstance.updateCollectorGroupById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#updateCollectorGroupById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorGroupsApi;

public class CollectorGroupsApiExample {

    public static void main(String[] args) {
        CollectorGroupsApi apiInstance = new CollectorGroupsApi();
        Integer id = 56; // Integer | 
        CollectorGroup body = ; // CollectorGroup | 
        Boolean autoBalanceMonitoredDevices = true; // Boolean | 
        Boolean forceUpdateFailedOverDevices = true; // Boolean | 
        String opType = opType_example; // String | 
        try {
            CollectorGroup result = apiInstance.updateCollectorGroupById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorGroupsApi#updateCollectorGroupById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
CollectorGroup *body = ; // 
Boolean *autoBalanceMonitoredDevices = true; //  (optional)
Boolean *forceUpdateFailedOverDevices = true; //  (optional)
String *opType = opType_example; //  (optional)

CollectorGroupsApi *apiInstance = [[CollectorGroupsApi alloc] init];

// Update collector group
[apiInstance updateCollectorGroupByIdWith
    id:id:body
    autoBalanceMonitoredDevices:autoBalanceMonitoredDevices
    forceUpdateFailedOverDevices:forceUpdateFailedOverDevices
    opType:opType
              completionHandler: ^(CollectorGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorGroupsApi()
var id = 56; // {{Integer}} 
var body = ; // {{CollectorGroup}} 
var opts = { 
  'autoBalanceMonitoredDevices': true // {{Boolean}} 
  'forceUpdateFailedOverDevices': true // {{Boolean}} 
  'opType': opType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCollectorGroupById(idbody, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateCollectorGroupByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorGroupsApi();
            var id = 56;  // Integer | 
            var body = new CollectorGroup(); // CollectorGroup | 
            var autoBalanceMonitoredDevices = true;  // Boolean |  (optional) 
            var forceUpdateFailedOverDevices = true;  // Boolean |  (optional) 
            var opType = opType_example;  // String |  (optional) 

            try
            {
                // Update collector group
                CollectorGroup result = apiInstance.updateCollectorGroupById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorGroupsApi.updateCollectorGroupById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorGroupsApi();
$id = 56; // Integer | 
$body = ; // CollectorGroup | 
$autoBalanceMonitoredDevices = true; // Boolean | 
$forceUpdateFailedOverDevices = true; // Boolean | 
$opType = opType_example; // String | 

try {
    $result = $api_instance->updateCollectorGroupById($id, $body, $autoBalanceMonitoredDevices, $forceUpdateFailedOverDevices, $opType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorGroupsApi->updateCollectorGroupById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::CollectorGroup->new(); # CollectorGroup | 
my $autoBalanceMonitoredDevices = true; # Boolean | 
my $forceUpdateFailedOverDevices = true; # Boolean | 
my $opType = opType_example; # String | 

eval { 
    my $result = $api_instance->updateCollectorGroupById(id => $id, body => $body, autoBalanceMonitoredDevices => $autoBalanceMonitoredDevices, forceUpdateFailedOverDevices => $forceUpdateFailedOverDevices, opType => $opType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorGroupsApi->updateCollectorGroupById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update collector group api_response = api_instance.update_collector_group_by_id(id, body, autoBalanceMonitoredDevices=autoBalanceMonitoredDevices, forceUpdateFailedOverDevices=forceUpdateFailedOverDevices, opType=opType) print(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->updateCollectorGroupById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateCollectorGroupByIdParams()
// Update collector group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.UpdateCollectorGroupById(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateCollectorGroupById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
autoBalanceMonitoredDevices
Boolean
forceUpdateFailedOverDevices
Boolean
opType
String

Responses

Status: 200 - Successfully updated the collector group

Status: default - Error


CollectorVersions

getCollectorVersionList

get collector version list

get collector version list


/setting/collector/collectors/versions

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/collector/collectors/versions?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorVersionsApi;

import java.io.File;
import java.util.*;

public class CollectorVersionsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorVersionsApi apiInstance = new CollectorVersionsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            CollectorVersionPaginationResponse result = apiInstance.getCollectorVersionList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorVersionsApi#getCollectorVersionList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorVersionsApi;

public class CollectorVersionsApiExample {

    public static void main(String[] args) {
        CollectorVersionsApi apiInstance = new CollectorVersionsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            CollectorVersionPaginationResponse result = apiInstance.getCollectorVersionList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorVersionsApi#getCollectorVersionList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

CollectorVersionsApi *apiInstance = [[CollectorVersionsApi alloc] init];

// get collector version list
[apiInstance getCollectorVersionListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(CollectorVersionPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorVersionsApi()
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCollectorVersionList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getCollectorVersionListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorVersionsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get collector version list
                CollectorVersionPaginationResponse result = apiInstance.getCollectorVersionList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorVersionsApi.getCollectorVersionList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorVersionsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getCollectorVersionList($fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorVersionsApi->getCollectorVersionList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorVersionsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorVersionsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getCollectorVersionList(fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorVersionsApi->getCollectorVersionList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get collector version list api_response = api_instance.get_collector_version_list(fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling CollectorVersionsApi->getCollectorVersionList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorVersionListParams()
// get collector version list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetCollectorVersionList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetCollectorVersionList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successful operation

Status: default - Error


Collectors

ackCollectorDownAlertById

ack collector down alert

ack collector down alert


/setting/collector/collectors/{id}/ackdown

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/collector/collectors/{id}/ackdown"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorsApi;

import java.io.File;
import java.util.*;

public class CollectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorsApi apiInstance = new CollectorsApi();
        Integer id = 56; // Integer | 
        AckCollectorDown body = ; // AckCollectorDown | 
        try {
            Object result = apiInstance.ackCollectorDownAlertById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#ackCollectorDownAlertById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorsApi;

public class CollectorsApiExample {

    public static void main(String[] args) {
        CollectorsApi apiInstance = new CollectorsApi();
        Integer id = 56; // Integer | 
        AckCollectorDown body = ; // AckCollectorDown | 
        try {
            Object result = apiInstance.ackCollectorDownAlertById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#ackCollectorDownAlertById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
AckCollectorDown *body = ; // 

CollectorsApi *apiInstance = [[CollectorsApi alloc] init];

// ack collector down alert
[apiInstance ackCollectorDownAlertByIdWith
    id:id:body
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorsApi()
var id = 56; // {{Integer}} 
var body = ; // {{AckCollectorDown}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.ackCollectorDownAlertById(idbody, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class ackCollectorDownAlertByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorsApi();
            var id = 56;  // Integer | 
            var body = new AckCollectorDown(); // AckCollectorDown | 

            try
            {
                // ack collector down alert
                Object result = apiInstance.ackCollectorDownAlertById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorsApi.ackCollectorDownAlertById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorsApi();
$id = 56; // Integer | 
$body = ; // AckCollectorDown | 

try {
    $result = $api_instance->ackCollectorDownAlertById($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorsApi->ackCollectorDownAlertById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::AckCollectorDown->new(); # AckCollectorDown | 

eval { 
    my $result = $api_instance->ackCollectorDownAlertById(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorsApi->ackCollectorDownAlertById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # ack collector down alert api_response = api_instance.ack_collector_down_alert_by_id(id, body) print(api_response) except ApiException as e: print("Exception when calling CollectorsApi->ackCollectorDownAlertById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAckCollectorDownAlertByIdParams()
// ack collector down alert
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AckCollectorDownAlertById(params) if err != nil { fmt.Printf("Exception when calling client.LM.AckCollectorDownAlertById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


addCollector

add collector

add collector


/setting/collector/collectors

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/collector/collectors"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorsApi;

import java.io.File;
import java.util.*;

public class CollectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorsApi apiInstance = new CollectorsApi();
        Collector body = ; // Collector | 
        try {
            Collector result = apiInstance.addCollector(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#addCollector");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorsApi;

public class CollectorsApiExample {

    public static void main(String[] args) {
        CollectorsApi apiInstance = new CollectorsApi();
        Collector body = ; // Collector | 
        try {
            Collector result = apiInstance.addCollector(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#addCollector");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Collector *body = ; // 

CollectorsApi *apiInstance = [[CollectorsApi alloc] init];

// add collector
[apiInstance addCollectorWith:body
              completionHandler: ^(Collector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorsApi()
var body = ; // {{Collector}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addCollector(body, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addCollectorExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorsApi();
            var body = new Collector(); // Collector | 

            try
            {
                // add collector
                Collector result = apiInstance.addCollector(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorsApi.addCollector: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorsApi();
$body = ; // Collector | 

try {
    $result = $api_instance->addCollector($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorsApi->addCollector: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorsApi->new();
my $body = WWW::SwaggerClient::Object::Collector->new(); # Collector | 

eval { 
    my $result = $api_instance->addCollector(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorsApi->addCollector: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # add collector api_response = api_instance.add_collector(body) print(api_response) except ApiException as e: print("Exception when calling CollectorsApi->addCollector: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddCollectorParams()
// add collector
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddCollector(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddCollector: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


deleteCollectorById

delete collector

delete collector


/setting/collector/collectors/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/collector/collectors/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorsApi;

import java.io.File;
import java.util.*;

public class CollectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorsApi apiInstance = new CollectorsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteCollectorById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#deleteCollectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorsApi;

public class CollectorsApiExample {

    public static void main(String[] args) {
        CollectorsApi apiInstance = new CollectorsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteCollectorById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#deleteCollectorById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 

CollectorsApi *apiInstance = [[CollectorsApi alloc] init];

// delete collector
[apiInstance deleteCollectorByIdWith:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorsApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteCollectorById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteCollectorByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorsApi();
            var id = 56;  // Integer | 

            try
            {
                // delete collector
                Object result = apiInstance.deleteCollectorById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorsApi.deleteCollectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->deleteCollectorById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorsApi->deleteCollectorById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorsApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->deleteCollectorById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorsApi->deleteCollectorById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # delete collector api_response = api_instance.delete_collector_by_id(id) print(api_response) except ApiException as e: print("Exception when calling CollectorsApi->deleteCollectorById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteCollectorByIdParams()
// delete collector
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteCollectorById(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteCollectorById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - Successful operation

Status: default - Error


getCollectorById

get collector

get collector


/setting/collector/collectors/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/collector/collectors/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorsApi;

import java.io.File;
import java.util.*;

public class CollectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorsApi apiInstance = new CollectorsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            Collector result = apiInstance.getCollectorById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#getCollectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorsApi;

public class CollectorsApiExample {

    public static void main(String[] args) {
        CollectorsApi apiInstance = new CollectorsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            Collector result = apiInstance.getCollectorById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#getCollectorById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
String *fields = fields_example; //  (optional)

CollectorsApi *apiInstance = [[CollectorsApi alloc] init];

// get collector
[apiInstance getCollectorByIdWith:id
    fields:fields
              completionHandler: ^(Collector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'fields': fields_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCollectorById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getCollectorByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorsApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get collector
                Collector result = apiInstance.getCollectorById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorsApi.getCollectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorsApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->getCollectorById($id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorsApi->getCollectorById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorsApi->new();
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->getCollectorById(id => $id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorsApi->getCollectorById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get collector api_response = api_instance.get_collector_by_id(id, fields=fields) print(api_response) except ApiException as e: print("Exception when calling CollectorsApi->getCollectorById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorByIdParams()
// get collector
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetCollectorById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetCollectorById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
fields
String

Responses

Status: 200 - Successful operation

Status: default - Error


getCollectorInstaller

get collector installer

get collector installer


/setting/collector/collectors/{collectorId}/installers/{osAndArch}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/collector/collectors/{collectorId}/installers/{osAndArch}?collectorVersion=&token=&monitorOthers=&collectorSize=&useEA="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorsApi;

import java.io.File;
import java.util.*;

public class CollectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorsApi apiInstance = new CollectorsApi();
        Integer collectorId = 56; // Integer | 
        String osAndArch = osAndArch_example; // String | 
        Integer collectorVersion = 56; // Integer | The version of the installer you'd like to download. This defaults to the latest GD Collector, unless useEA is true
        String token = token_example; // String | 
        Boolean monitorOthers = true; // Boolean | 
        String collectorSize = collectorSize_example; // String | The size of the Collector you'd like to install. Options are nano, small (requires 2GB memory), medium (requires 4GB memory), large (requires 8GB memory), extra large (requires 16GB memory), double extra large (requires 32GB memory). Requires collector version 22.180 or higher. Defaults to small
        Boolean useEA = true; // Boolean | If true, the latest EA Collector version will be used. Defaults to false
        try {
            byte[] result = apiInstance.getCollectorInstaller(collectorId, osAndArch, collectorVersion, token, monitorOthers, collectorSize, useEA);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#getCollectorInstaller");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorsApi;

public class CollectorsApiExample {

    public static void main(String[] args) {
        CollectorsApi apiInstance = new CollectorsApi();
        Integer collectorId = 56; // Integer | 
        String osAndArch = osAndArch_example; // String | 
        Integer collectorVersion = 56; // Integer | The version of the installer you'd like to download. This defaults to the latest GD Collector, unless useEA is true
        String token = token_example; // String | 
        Boolean monitorOthers = true; // Boolean | 
        String collectorSize = collectorSize_example; // String | The size of the Collector you'd like to install. Options are nano, small (requires 2GB memory), medium (requires 4GB memory), large (requires 8GB memory), extra large (requires 16GB memory), double extra large (requires 32GB memory). Requires collector version 22.180 or higher. Defaults to small
        Boolean useEA = true; // Boolean | If true, the latest EA Collector version will be used. Defaults to false
        try {
            byte[] result = apiInstance.getCollectorInstaller(collectorId, osAndArch, collectorVersion, token, monitorOthers, collectorSize, useEA);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#getCollectorInstaller");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *collectorId = 56; // 
String *osAndArch = osAndArch_example; // 
Integer *collectorVersion = 56; // The version of the installer you'd like to download. This defaults to the latest GD Collector, unless useEA is true (optional)
String *token = token_example; //  (optional)
Boolean *monitorOthers = true; //  (optional)
String *collectorSize = collectorSize_example; // The size of the Collector you'd like to install. Options are nano, small (requires 2GB memory), medium (requires 4GB memory), large (requires 8GB memory), extra large (requires 16GB memory), double extra large (requires 32GB memory). Requires collector version 22.180 or higher. Defaults to small (optional)
Boolean *useEA = true; // If true, the latest EA Collector version will be used. Defaults to false (optional)

CollectorsApi *apiInstance = [[CollectorsApi alloc] init];

// get collector installer
[apiInstance getCollectorInstallerWith:collectorId
    osAndArch:osAndArch
    collectorVersion:collectorVersion
    token:token
    monitorOthers:monitorOthers
    collectorSize:collectorSize
    useEA:useEA
              completionHandler: ^(byte[] output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorsApi()
var collectorId = 56; // {{Integer}} 
var osAndArch = osAndArch_example; // {{String}} 
var opts = { 
  'collectorVersion': 56, // {{Integer}} The version of the installer you'd like to download. This defaults to the latest GD Collector, unless useEA is true
  'token': token_example, // {{String}} 
  'monitorOthers': true, // {{Boolean}} 
  'collectorSize': collectorSize_example, // {{String}} The size of the Collector you'd like to install. Options are nano, small (requires 2GB memory), medium (requires 4GB memory), large (requires 8GB memory), extra large (requires 16GB memory), double extra large (requires 32GB memory). Requires collector version 22.180 or higher. Defaults to small
  'useEA': true // {{Boolean}} If true, the latest EA Collector version will be used. Defaults to false
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCollectorInstaller(collectorId, osAndArch, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getCollectorInstallerExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorsApi();
            var collectorId = 56;  // Integer | 
            var osAndArch = osAndArch_example;  // String | 
            var collectorVersion = 56;  // Integer | The version of the installer you'd like to download. This defaults to the latest GD Collector, unless useEA is true (optional) 
            var token = token_example;  // String |  (optional) 
            var monitorOthers = true;  // Boolean |  (optional) 
            var collectorSize = collectorSize_example;  // String | The size of the Collector you'd like to install. Options are nano, small (requires 2GB memory), medium (requires 4GB memory), large (requires 8GB memory), extra large (requires 16GB memory), double extra large (requires 32GB memory). Requires collector version 22.180 or higher. Defaults to small (optional) 
            var useEA = true;  // Boolean | If true, the latest EA Collector version will be used. Defaults to false (optional) 

            try
            {
                // get collector installer
                byte[] result = apiInstance.getCollectorInstaller(collectorId, osAndArch, collectorVersion, token, monitorOthers, collectorSize, useEA);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorsApi.getCollectorInstaller: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorsApi();
$collectorId = 56; // Integer | 
$osAndArch = osAndArch_example; // String | 
$collectorVersion = 56; // Integer | The version of the installer you'd like to download. This defaults to the latest GD Collector, unless useEA is true
$token = token_example; // String | 
$monitorOthers = true; // Boolean | 
$collectorSize = collectorSize_example; // String | The size of the Collector you'd like to install. Options are nano, small (requires 2GB memory), medium (requires 4GB memory), large (requires 8GB memory), extra large (requires 16GB memory), double extra large (requires 32GB memory). Requires collector version 22.180 or higher. Defaults to small
$useEA = true; // Boolean | If true, the latest EA Collector version will be used. Defaults to false

try {
    $result = $api_instance->getCollectorInstaller($collectorId, $osAndArch, $collectorVersion, $token, $monitorOthers, $collectorSize, $useEA);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorsApi->getCollectorInstaller: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorsApi->new();
my $collectorId = 56; # Integer | 
my $osAndArch = osAndArch_example; # String | 
my $collectorVersion = 56; # Integer | The version of the installer you'd like to download. This defaults to the latest GD Collector, unless useEA is true
my $token = token_example; # String | 
my $monitorOthers = true; # Boolean | 
my $collectorSize = collectorSize_example; # String | The size of the Collector you'd like to install. Options are nano, small (requires 2GB memory), medium (requires 4GB memory), large (requires 8GB memory), extra large (requires 16GB memory), double extra large (requires 32GB memory). Requires collector version 22.180 or higher. Defaults to small
my $useEA = true; # Boolean | If true, the latest EA Collector version will be used. Defaults to false

eval { 
    my $result = $api_instance->getCollectorInstaller(collectorId => $collectorId, osAndArch => $osAndArch, collectorVersion => $collectorVersion, token => $token, monitorOthers => $monitorOthers, collectorSize => $collectorSize, useEA => $useEA);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorsApi->getCollectorInstaller: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get collector installer api_response = api_instance.get_collector_installer(collectorId, osAndArch, collectorVersion=collectorVersion, token=token, monitorOthers=monitorOthers, collectorSize=collectorSize, useEA=useEA) print(api_response) except ApiException as e: print("Exception when calling CollectorsApi->getCollectorInstaller: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorInstallerParams()
// get collector installer
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetCollectorInstaller(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetCollectorInstaller: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
collectorId*
Integer (int32)
Required
osAndArch*
String
Required
Query parameters
Name Description
collectorVersion
Integer (int32)
The version of the installer you'd like to download. This defaults to the latest GD Collector, unless useEA is true
token
String
monitorOthers
Boolean
collectorSize
String
The size of the Collector you'd like to install. Options are nano, small (requires 2GB memory), medium (requires 4GB memory), large (requires 8GB memory), extra large (requires 16GB memory), double extra large (requires 32GB memory). Requires collector version 22.180 or higher. Defaults to small
useEA
Boolean
If true, the latest EA Collector version will be used. Defaults to false

Responses

Status: 200 - Successful operation

Status: default - Error


getCollectorList

get collector list

get collector list


/setting/collector/collectors

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/collector/collectors?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorsApi;

import java.io.File;
import java.util.*;

public class CollectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorsApi apiInstance = new CollectorsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            CollectorPaginationResponse result = apiInstance.getCollectorList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#getCollectorList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorsApi;

public class CollectorsApiExample {

    public static void main(String[] args) {
        CollectorsApi apiInstance = new CollectorsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            CollectorPaginationResponse result = apiInstance.getCollectorList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#getCollectorList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

CollectorsApi *apiInstance = [[CollectorsApi alloc] init];

// get collector list
[apiInstance getCollectorListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(CollectorPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorsApi()
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCollectorList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getCollectorListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get collector list
                CollectorPaginationResponse result = apiInstance.getCollectorList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorsApi.getCollectorList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getCollectorList($fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorsApi->getCollectorList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getCollectorList(fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorsApi->getCollectorList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get collector list api_response = api_instance.get_collector_list(fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling CollectorsApi->getCollectorList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorListParams()
// get collector list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetCollectorList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetCollectorList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successful operation

Status: default - Error


patchCollectorById

update collector

update collector


/setting/collector/collectors/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/collector/collectors/{id}?autoBalanceMonitoredDevices=&forceUpdateFailedOverDevices=&opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorsApi;

import java.io.File;
import java.util.*;

public class CollectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorsApi apiInstance = new CollectorsApi();
        Integer id = 56; // Integer | 
        Collector body = ; // Collector | 
        Boolean autoBalanceMonitoredDevices = true; // Boolean | 
        Boolean forceUpdateFailedOverDevices = true; // Boolean | 
        String opType = opType_example; // String | 
        try {
            Collector result = apiInstance.patchCollectorById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#patchCollectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorsApi;

public class CollectorsApiExample {

    public static void main(String[] args) {
        CollectorsApi apiInstance = new CollectorsApi();
        Integer id = 56; // Integer | 
        Collector body = ; // Collector | 
        Boolean autoBalanceMonitoredDevices = true; // Boolean | 
        Boolean forceUpdateFailedOverDevices = true; // Boolean | 
        String opType = opType_example; // String | 
        try {
            Collector result = apiInstance.patchCollectorById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#patchCollectorById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
Collector *body = ; // 
Boolean *autoBalanceMonitoredDevices = true; //  (optional)
Boolean *forceUpdateFailedOverDevices = true; //  (optional)
String *opType = opType_example; //  (optional)

CollectorsApi *apiInstance = [[CollectorsApi alloc] init];

// update collector
[apiInstance patchCollectorByIdWith
    id:id:body
    autoBalanceMonitoredDevices:autoBalanceMonitoredDevices
    forceUpdateFailedOverDevices:forceUpdateFailedOverDevices
    opType:opType
              completionHandler: ^(Collector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorsApi()
var id = 56; // {{Integer}} 
var body = ; // {{Collector}} 
var opts = { 
  'autoBalanceMonitoredDevices': true // {{Boolean}} 
  'forceUpdateFailedOverDevices': true // {{Boolean}} 
  'opType': opType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchCollectorById(idbody, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchCollectorByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorsApi();
            var id = 56;  // Integer | 
            var body = new Collector(); // Collector | 
            var autoBalanceMonitoredDevices = true;  // Boolean |  (optional) 
            var forceUpdateFailedOverDevices = true;  // Boolean |  (optional) 
            var opType = opType_example;  // String |  (optional) 

            try
            {
                // update collector
                Collector result = apiInstance.patchCollectorById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorsApi.patchCollectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorsApi();
$id = 56; // Integer | 
$body = ; // Collector | 
$autoBalanceMonitoredDevices = true; // Boolean | 
$forceUpdateFailedOverDevices = true; // Boolean | 
$opType = opType_example; // String | 

try {
    $result = $api_instance->patchCollectorById($id, $body, $autoBalanceMonitoredDevices, $forceUpdateFailedOverDevices, $opType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorsApi->patchCollectorById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Collector->new(); # Collector | 
my $autoBalanceMonitoredDevices = true; # Boolean | 
my $forceUpdateFailedOverDevices = true; # Boolean | 
my $opType = opType_example; # String | 

eval { 
    my $result = $api_instance->patchCollectorById(id => $id, body => $body, autoBalanceMonitoredDevices => $autoBalanceMonitoredDevices, forceUpdateFailedOverDevices => $forceUpdateFailedOverDevices, opType => $opType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorsApi->patchCollectorById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # update collector api_response = api_instance.patch_collector_by_id(id, body, autoBalanceMonitoredDevices=autoBalanceMonitoredDevices, forceUpdateFailedOverDevices=forceUpdateFailedOverDevices, opType=opType) print(api_response) except ApiException as e: print("Exception when calling CollectorsApi->patchCollectorById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewPatchCollectorByIdParams()
// update collector
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.PatchCollectorById(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchCollectorById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
autoBalanceMonitoredDevices
Boolean
forceUpdateFailedOverDevices
Boolean
opType
String

Responses

Status: 200 - Successful operation

Status: default - Error


updateCollectorById

update collector

update collector


/setting/collector/collectors/{id}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/collector/collectors/{id}?autoBalanceMonitoredDevices=&forceUpdateFailedOverDevices=&opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CollectorsApi;

import java.io.File;
import java.util.*;

public class CollectorsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CollectorsApi apiInstance = new CollectorsApi();
        Integer id = 56; // Integer | 
        Collector body = ; // Collector | 
        Boolean autoBalanceMonitoredDevices = true; // Boolean | 
        Boolean forceUpdateFailedOverDevices = true; // Boolean | 
        String opType = opType_example; // String | 
        try {
            Collector result = apiInstance.updateCollectorById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#updateCollectorById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CollectorsApi;

public class CollectorsApiExample {

    public static void main(String[] args) {
        CollectorsApi apiInstance = new CollectorsApi();
        Integer id = 56; // Integer | 
        Collector body = ; // Collector | 
        Boolean autoBalanceMonitoredDevices = true; // Boolean | 
        Boolean forceUpdateFailedOverDevices = true; // Boolean | 
        String opType = opType_example; // String | 
        try {
            Collector result = apiInstance.updateCollectorById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#updateCollectorById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
Collector *body = ; // 
Boolean *autoBalanceMonitoredDevices = true; //  (optional)
Boolean *forceUpdateFailedOverDevices = true; //  (optional)
String *opType = opType_example; //  (optional)

CollectorsApi *apiInstance = [[CollectorsApi alloc] init];

// update collector
[apiInstance updateCollectorByIdWith
    id:id:body
    autoBalanceMonitoredDevices:autoBalanceMonitoredDevices
    forceUpdateFailedOverDevices:forceUpdateFailedOverDevices
    opType:opType
              completionHandler: ^(Collector output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CollectorsApi()
var id = 56; // {{Integer}} 
var body = ; // {{Collector}} 
var opts = { 
  'autoBalanceMonitoredDevices': true // {{Boolean}} 
  'forceUpdateFailedOverDevices': true // {{Boolean}} 
  'opType': opType_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateCollectorById(idbody, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateCollectorByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CollectorsApi();
            var id = 56;  // Integer | 
            var body = new Collector(); // Collector | 
            var autoBalanceMonitoredDevices = true;  // Boolean |  (optional) 
            var forceUpdateFailedOverDevices = true;  // Boolean |  (optional) 
            var opType = opType_example;  // String |  (optional) 

            try
            {
                // update collector
                Collector result = apiInstance.updateCollectorById(id, body, autoBalanceMonitoredDevices, forceUpdateFailedOverDevices, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorsApi.updateCollectorById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCollectorsApi();
$id = 56; // Integer | 
$body = ; // Collector | 
$autoBalanceMonitoredDevices = true; // Boolean | 
$forceUpdateFailedOverDevices = true; // Boolean | 
$opType = opType_example; // String | 

try {
    $result = $api_instance->updateCollectorById($id, $body, $autoBalanceMonitoredDevices, $forceUpdateFailedOverDevices, $opType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorsApi->updateCollectorById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CollectorsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CollectorsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Collector->new(); # Collector | 
my $autoBalanceMonitoredDevices = true; # Boolean | 
my $forceUpdateFailedOverDevices = true; # Boolean | 
my $opType = opType_example; # String | 

eval { 
    my $result = $api_instance->updateCollectorById(id => $id, body => $body, autoBalanceMonitoredDevices => $autoBalanceMonitoredDevices, forceUpdateFailedOverDevices => $forceUpdateFailedOverDevices, opType => $opType);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorsApi->updateCollectorById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # update collector api_response = api_instance.update_collector_by_id(id, body, autoBalanceMonitoredDevices=autoBalanceMonitoredDevices, forceUpdateFailedOverDevices=forceUpdateFailedOverDevices, opType=opType) print(api_response) except ApiException as e: print("Exception when calling CollectorsApi->updateCollectorById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateCollectorByIdParams()
// update collector
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.UpdateCollectorById(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateCollectorById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
autoBalanceMonitoredDevices
Boolean
forceUpdateFailedOverDevices
Boolean
opType
String

Responses

Status: 200 - Successful operation

Status: default - Error


ConfigSources

addConfigSource

Add a new config source

Create a new config source


/setting/configsources

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/configsources"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigSourcesApi;

import java.io.File;
import java.util.*;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        ConfigSource body = ; // ConfigSource | 
        try {
            ConfigSource result = apiInstance.addConfigSource(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#addConfigSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigSourcesApi;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        ConfigSource body = ; // ConfigSource | 
        try {
            ConfigSource result = apiInstance.addConfigSource(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#addConfigSource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
ConfigSource *body = ; //  (optional)

ConfigSourcesApi *apiInstance = [[ConfigSourcesApi alloc] init];

// Add a new config source
[apiInstance addConfigSourceWith:body
              completionHandler: ^(ConfigSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.ConfigSourcesApi()
var opts = { 
  'body':  // {{ConfigSource}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addConfigSource(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addConfigSourceExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigSourcesApi();
            var body = new ConfigSource(); // ConfigSource |  (optional) 

            try
            {
                // Add a new config source
                ConfigSource result = apiInstance.addConfigSource(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigSourcesApi.addConfigSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigSourcesApi();
$body = ; // ConfigSource | 

try {
    $result = $api_instance->addConfigSource($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigSourcesApi->addConfigSource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigSourcesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigSourcesApi->new();
my $body = WWW::SwaggerClient::Object::ConfigSource->new(); # ConfigSource | 

eval { 
    my $result = $api_instance->addConfigSource(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigSourcesApi->addConfigSource: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Add a new config source api_response = api_instance.add_config_source(body=body) print(api_response) except ApiException as e: print("Exception when calling ConfigSourcesApi->addConfigSource: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddConfigSourceParams()
// Add a new config source
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddConfigSource(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddConfigSource: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Successfully added the new config source

Status: default - Error


deleteConfigSourceById

Delete config source by ID

Delete a config source based on the provided ID


/setting/configsources/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/configsources/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigSourcesApi;

import java.io.File;
import java.util.*;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        Integer id = 56; // Integer | 
        try {
            ConfigSource result = apiInstance.deleteConfigSourceById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#deleteConfigSourceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigSourcesApi;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        Integer id = 56; // Integer | 
        try {
            ConfigSource result = apiInstance.deleteConfigSourceById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#deleteConfigSourceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 

ConfigSourcesApi *apiInstance = [[ConfigSourcesApi alloc] init];

// Delete config source by ID
[apiInstance deleteConfigSourceByIdWith:id
              completionHandler: ^(ConfigSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.ConfigSourcesApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteConfigSourceById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteConfigSourceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigSourcesApi();
            var id = 56;  // Integer | 

            try
            {
                // Delete config source by ID
                ConfigSource result = apiInstance.deleteConfigSourceById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigSourcesApi.deleteConfigSourceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigSourcesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->deleteConfigSourceById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigSourcesApi->deleteConfigSourceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigSourcesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigSourcesApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->deleteConfigSourceById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigSourcesApi->deleteConfigSourceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Delete config source by ID api_response = api_instance.delete_config_source_by_id(id) print(api_response) except ApiException as e: print("Exception when calling ConfigSourcesApi->deleteConfigSourceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteConfigSourceByIdParams()
// Delete config source by ID
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteConfigSourceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteConfigSourceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - Successfully deleted the config source

Status: default - Error


getConfigSourceById

Get config source by ID

Retrieve a config source by its ID


/setting/configsources/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/configsources/{id}?format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigSourcesApi;

import java.io.File;
import java.util.*;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        Integer id = 56; // Integer | 
        String format = format_example; // String | 
        try {
            ConfigSource result = apiInstance.getConfigSourceById(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#getConfigSourceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigSourcesApi;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        Integer id = 56; // Integer | 
        String format = format_example; // String | 
        try {
            ConfigSource result = apiInstance.getConfigSourceById(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#getConfigSourceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
String *format = format_example; //  (optional)

ConfigSourcesApi *apiInstance = [[ConfigSourcesApi alloc] init];

// Get config source by ID
[apiInstance getConfigSourceByIdWith:id
    format:format
              completionHandler: ^(ConfigSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.ConfigSourcesApi()
var id = 56; // {{Integer}} 
var opts = { 
  'format': format_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConfigSourceById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getConfigSourceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigSourcesApi();
            var id = 56;  // Integer | 
            var format = format_example;  // String |  (optional) 

            try
            {
                // Get config source by ID
                ConfigSource result = apiInstance.getConfigSourceById(id, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigSourcesApi.getConfigSourceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigSourcesApi();
$id = 56; // Integer | 
$format = format_example; // String | 

try {
    $result = $api_instance->getConfigSourceById($id, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigSourcesApi->getConfigSourceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigSourcesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigSourcesApi->new();
my $id = 56; # Integer | 
my $format = format_example; # String | 

eval { 
    my $result = $api_instance->getConfigSourceById(id => $id, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigSourcesApi->getConfigSourceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get config source by ID api_response = api_instance.get_config_source_by_id(id, format=format) print(api_response) except ApiException as e: print("Exception when calling ConfigSourcesApi->getConfigSourceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetConfigSourceByIdParams()
// Get config source by ID
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetConfigSourceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetConfigSourceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
format
String

Responses

Status: 200 - Successfully retrieved the config source by ID

Status: default - Error


getConfigSourceList

Get config source list

Retrieve a list of config sources


/setting/configsources

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/configsources?format=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigSourcesApi;

import java.io.File;
import java.util.*;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        String format = format_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            ConfigsourcePaginationResponse result = apiInstance.getConfigSourceList(format, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#getConfigSourceList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigSourcesApi;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        String format = format_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            ConfigsourcePaginationResponse result = apiInstance.getConfigSourceList(format, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#getConfigSourceList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *format = format_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

ConfigSourcesApi *apiInstance = [[ConfigSourcesApi alloc] init];

// Get config source list
[apiInstance getConfigSourceListWith:format
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(ConfigsourcePaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.ConfigSourcesApi()
var opts = { 
  'format': format_example, // {{String}} 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getConfigSourceList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getConfigSourceListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigSourcesApi();
            var format = format_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // Get config source list
                ConfigsourcePaginationResponse result = apiInstance.getConfigSourceList(format, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigSourcesApi.getConfigSourceList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigSourcesApi();
$format = format_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getConfigSourceList($format, $fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigSourcesApi->getConfigSourceList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigSourcesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigSourcesApi->new();
my $format = format_example; # String | 
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getConfigSourceList(format => $format, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigSourcesApi->getConfigSourceList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get config source list api_response = api_instance.get_config_source_list(format=format, fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling ConfigSourcesApi->getConfigSourceList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetConfigSourceListParams()
// Get config source list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetConfigSourceList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetConfigSourceList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
format
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successfully retrieved the config source list

Status: default - Error


getUpdateReasonListByConfigSourceId

Get update history for a configSource

Retrieve the list of update reasons/history for a specific configSource


/setting/configsources/{id}/updatereasons

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/setting/configsources/{id}/updatereasons"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigSourcesApi;

import java.io.File;
import java.util.*;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        Integer id = 56; // Integer | 
        try {
            ConfigSourceUpdateReasonsPaginationResponse result = apiInstance.getUpdateReasonListByConfigSourceId(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#getUpdateReasonListByConfigSourceId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigSourcesApi;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        Integer id = 56; // Integer | 
        try {
            ConfigSourceUpdateReasonsPaginationResponse result = apiInstance.getUpdateReasonListByConfigSourceId(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#getUpdateReasonListByConfigSourceId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 

ConfigSourcesApi *apiInstance = [[ConfigSourcesApi alloc] init];

// Get update history for a configSource
[apiInstance getUpdateReasonListByConfigSourceIdWith:id
              completionHandler: ^(ConfigSourceUpdateReasonsPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.ConfigSourcesApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUpdateReasonListByConfigSourceId(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getUpdateReasonListByConfigSourceIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigSourcesApi();
            var id = 56;  // Integer | 

            try
            {
                // Get update history for a configSource
                ConfigSourceUpdateReasonsPaginationResponse result = apiInstance.getUpdateReasonListByConfigSourceId(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigSourcesApi.getUpdateReasonListByConfigSourceId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigSourcesApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->getUpdateReasonListByConfigSourceId($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigSourcesApi->getUpdateReasonListByConfigSourceId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigSourcesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigSourcesApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->getUpdateReasonListByConfigSourceId(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigSourcesApi->getUpdateReasonListByConfigSourceId: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get update history for a configSource api_response = api_instance.get_update_reason_list_by_config_source_id(id) print(api_response) except ApiException as e: print("Exception when calling ConfigSourcesApi->getUpdateReasonListByConfigSourceId: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetUpdateReasonListByConfigSourceIdParams()
// Get update history for a configSource
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetUpdateReasonListByConfigSourceId(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetUpdateReasonListByConfigSourceId: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - Successfully retrieved update history for the configSource

Status: default - Error


importConfigSource

Import config source via XML

Import configuration source data from an XML file


/setting/configsources/importxml

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"/santaba/rest/setting/configsources/importxml"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigSourcesApi;

import java.io.File;
import java.util.*;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        FormDataContentDisposition file = ; // FormDataContentDisposition | 
        try {
            Object result = apiInstance.importConfigSource(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#importConfigSource");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigSourcesApi;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        FormDataContentDisposition file = ; // FormDataContentDisposition | 
        try {
            Object result = apiInstance.importConfigSource(file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#importConfigSource");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
FormDataContentDisposition *file = ; //  (optional)

ConfigSourcesApi *apiInstance = [[ConfigSourcesApi alloc] init];

// Import config source via XML
[apiInstance importConfigSourceWith:file
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.ConfigSourcesApi()
var opts = { 
  'file':  // {{FormDataContentDisposition}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importConfigSource(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class importConfigSourceExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigSourcesApi();
            var file = new FormDataContentDisposition(); // FormDataContentDisposition |  (optional) 

            try
            {
                // Import config source via XML
                Object result = apiInstance.importConfigSource(file);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigSourcesApi.importConfigSource: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigSourcesApi();
$file = ; // FormDataContentDisposition | 

try {
    $result = $api_instance->importConfigSource($file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigSourcesApi->importConfigSource: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigSourcesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigSourcesApi->new();
my $file = ; # FormDataContentDisposition | 

eval { 
    my $result = $api_instance->importConfigSource(file => $file);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigSourcesApi->importConfigSource: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Import config source via XML api_response = api_instance.import_config_source(file=file) print(api_response) except ApiException as e: print("Exception when calling ConfigSourcesApi->importConfigSource: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewImportConfigSourceParams()
// Import config source via XML
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.ImportConfigSource(params) if err != nil { fmt.Printf("Exception when calling client.LM.ImportConfigSource: %v", err.Error()) } fmt.Print(resp) }

Parameters

Form parameters
Name Description
file
FormDataContentDisposition

Responses

Status: 200 - Successfully imported the config source

Status: default - Error


importConfigSourceJson

Import ConfigSource via json

Import a ConfigSource using json data


/setting/configsources/importjson

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: multipart/form-data"\
"/santaba/rest/setting/configsources/importjson?handleConflict=&fieldsToPreserve="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigSourcesApi;

import java.io.File;
import java.util.*;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        FormDataContentDisposition file = ; // FormDataContentDisposition | 
        String handleConflict = handleConflict_example; // String | 
        array[String] fieldsToPreserve = ; // array[String] | 
        try {
            ConfigSource result = apiInstance.importConfigSourceJson(file, handleConflict, fieldsToPreserve);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#importConfigSourceJson");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigSourcesApi;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        FormDataContentDisposition file = ; // FormDataContentDisposition | 
        String handleConflict = handleConflict_example; // String | 
        array[String] fieldsToPreserve = ; // array[String] | 
        try {
            ConfigSource result = apiInstance.importConfigSourceJson(file, handleConflict, fieldsToPreserve);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#importConfigSourceJson");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
FormDataContentDisposition *file = ; //  (optional)
String *handleConflict = handleConflict_example; //  (optional)
array[String] *fieldsToPreserve = ; //  (optional)

ConfigSourcesApi *apiInstance = [[ConfigSourcesApi alloc] init];

// Import ConfigSource via json
[apiInstance importConfigSourceJsonWith:file
    handleConflict:handleConflict
    fieldsToPreserve:fieldsToPreserve
              completionHandler: ^(ConfigSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.ConfigSourcesApi()
var opts = { 
  'file':  // {{FormDataContentDisposition}} 
  'handleConflict': handleConflict_example // {{String}} 
  'fieldsToPreserve':  // {{array[String]}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.importConfigSourceJson(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class importConfigSourceJsonExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigSourcesApi();
            var file = new FormDataContentDisposition(); // FormDataContentDisposition |  (optional) 
            var handleConflict = handleConflict_example;  // String |  (optional) 
            var fieldsToPreserve = new array[String](); // array[String] |  (optional) 

            try
            {
                // Import ConfigSource via json
                ConfigSource result = apiInstance.importConfigSourceJson(file, handleConflict, fieldsToPreserve);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigSourcesApi.importConfigSourceJson: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigSourcesApi();
$file = ; // FormDataContentDisposition | 
$handleConflict = handleConflict_example; // String | 
$fieldsToPreserve = ; // array[String] | 

try {
    $result = $api_instance->importConfigSourceJson($file, $handleConflict, $fieldsToPreserve);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigSourcesApi->importConfigSourceJson: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigSourcesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigSourcesApi->new();
my $file = ; # FormDataContentDisposition | 
my $handleConflict = handleConflict_example; # String | 
my $fieldsToPreserve = []; # array[String] | 

eval { 
    my $result = $api_instance->importConfigSourceJson(file => $file, handleConflict => $handleConflict, fieldsToPreserve => $fieldsToPreserve);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigSourcesApi->importConfigSourceJson: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Import ConfigSource via json api_response = api_instance.import_config_source_json(file=file, handleConflict=handleConflict, fieldsToPreserve=fieldsToPreserve) print(api_response) except ApiException as e: print("Exception when calling ConfigSourcesApi->importConfigSourceJson: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewImportConfigSourceJsonParams()
// Import ConfigSource via json
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.ImportConfigSourceJson(params) if err != nil { fmt.Printf("Exception when calling client.LM.ImportConfigSourceJson: %v", err.Error()) } fmt.Print(resp) }

Parameters

Form parameters
Name Description
file
FormDataContentDisposition
Query parameters
Name Description
handleConflict
String
fieldsToPreserve
array[String]

Responses

Status: 200 - Successfully imported the ConfigSource via Json

Status: default - Error


patchConfigSourceById

Update config source by ID

Update the config source details based on the provided ID


/setting/configsources/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"/santaba/rest/setting/configsources/{id}?reason="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigSourcesApi;

import java.io.File;
import java.util.*;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        Integer id = 56; // Integer | 
        ConfigSource body = ; // ConfigSource | 
        String reason = reason_example; // String | 
        try {
            ConfigSource result = apiInstance.patchConfigSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#patchConfigSourceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigSourcesApi;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        Integer id = 56; // Integer | 
        ConfigSource body = ; // ConfigSource | 
        String reason = reason_example; // String | 
        try {
            ConfigSource result = apiInstance.patchConfigSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#patchConfigSourceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
ConfigSource *body = ; //  (optional)
String *reason = reason_example; //  (optional)

ConfigSourcesApi *apiInstance = [[ConfigSourcesApi alloc] init];

// Update config source by ID
[apiInstance patchConfigSourceByIdWith:id
    body:body
    reason:reason
              completionHandler: ^(ConfigSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.ConfigSourcesApi()
var id = 56; // {{Integer}} 
var opts = { 
  'body':  // {{ConfigSource}} 
  'reason': reason_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchConfigSourceById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchConfigSourceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigSourcesApi();
            var id = 56;  // Integer | 
            var body = new ConfigSource(); // ConfigSource |  (optional) 
            var reason = reason_example;  // String |  (optional) 

            try
            {
                // Update config source by ID
                ConfigSource result = apiInstance.patchConfigSourceById(id, body, reason);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigSourcesApi.patchConfigSourceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigSourcesApi();
$id = 56; // Integer | 
$body = ; // ConfigSource | 
$reason = reason_example; // String | 

try {
    $result = $api_instance->patchConfigSourceById($id, $body, $reason);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigSourcesApi->patchConfigSourceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigSourcesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigSourcesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::ConfigSource->new(); # ConfigSource | 
my $reason = reason_example; # String | 

eval { 
    my $result = $api_instance->patchConfigSourceById(id => $id, body => $body, reason => $reason);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigSourcesApi->patchConfigSourceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update config source by ID api_response = api_instance.patch_config_source_by_id(id, body=body, reason=reason) print(api_response) except ApiException as e: print("Exception when calling ConfigSourcesApi->patchConfigSourceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewPatchConfigSourceByIdParams()
// Update config source by ID
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.PatchConfigSourceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchConfigSourceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body
Query parameters
Name Description
reason
String

Responses

Status: 200 - Successfully updated the config source

Status: default - Error


updateConfigSourceById

Update config source by ID

Update the config source details based on the provided ID


/setting/configsources/{id}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: */*"\
"/santaba/rest/setting/configsources/{id}?reason="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ConfigSourcesApi;

import java.io.File;
import java.util.*;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        Integer id = 56; // Integer | 
        ConfigSource body = ; // ConfigSource | 
        String reason = reason_example; // String | 
        try {
            ConfigSource result = apiInstance.updateConfigSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#updateConfigSourceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ConfigSourcesApi;

public class ConfigSourcesApiExample {

    public static void main(String[] args) {
        ConfigSourcesApi apiInstance = new ConfigSourcesApi();
        Integer id = 56; // Integer | 
        ConfigSource body = ; // ConfigSource | 
        String reason = reason_example; // String | 
        try {
            ConfigSource result = apiInstance.updateConfigSourceById(id, body, reason);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#updateConfigSourceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
ConfigSource *body = ; //  (optional)
String *reason = reason_example; //  (optional)

ConfigSourcesApi *apiInstance = [[ConfigSourcesApi alloc] init];

// Update config source by ID
[apiInstance updateConfigSourceByIdWith:id
    body:body
    reason:reason
              completionHandler: ^(ConfigSource output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.ConfigSourcesApi()
var id = 56; // {{Integer}} 
var opts = { 
  'body':  // {{ConfigSource}} 
  'reason': reason_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateConfigSourceById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateConfigSourceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new ConfigSourcesApi();
            var id = 56;  // Integer | 
            var body = new ConfigSource(); // ConfigSource |  (optional) 
            var reason = reason_example;  // String |  (optional) 

            try
            {
                // Update config source by ID
                ConfigSource result = apiInstance.updateConfigSourceById(id, body, reason);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigSourcesApi.updateConfigSourceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiConfigSourcesApi();
$id = 56; // Integer | 
$body = ; // ConfigSource | 
$reason = reason_example; // String | 

try {
    $result = $api_instance->updateConfigSourceById($id, $body, $reason);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigSourcesApi->updateConfigSourceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ConfigSourcesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ConfigSourcesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::ConfigSource->new(); # ConfigSource | 
my $reason = reason_example; # String | 

eval { 
    my $result = $api_instance->updateConfigSourceById(id => $id, body => $body, reason => $reason);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ConfigSourcesApi->updateConfigSourceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Update config source by ID api_response = api_instance.update_config_source_by_id(id, body=body, reason=reason) print(api_response) except ApiException as e: print("Exception when calling ConfigSourcesApi->updateConfigSourceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateConfigSourceByIdParams()
// Update config source by ID
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.UpdateConfigSourceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateConfigSourceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body
Query parameters
Name Description
reason
String

Responses

Status: 200 - Successfully updated the config source

Status: default - Error


CostOptimizationRecommendations

getRecommendationById

Get recommendation by ID

Retrieves a recommendation by its ID


/cost-optimization/recommendations/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/cost-optimization/recommendations/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CostOptimizationRecommendationsApi;

import java.io.File;
import java.util.*;

public class CostOptimizationRecommendationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CostOptimizationRecommendationsApi apiInstance = new CostOptimizationRecommendationsApi();
        String id = id_example; // String | an alphanumeric identifier composed of the recommendation's database ID, the associated resource ID, and the recommendation type, delimited with hyphens, e.g. 123-456-EBS_UNATTACHED
        String fields = fields_example; // String | 
        try {
            RestCloudRecommendationV3 result = apiInstance.getRecommendationById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CostOptimizationRecommendationsApi#getRecommendationById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CostOptimizationRecommendationsApi;

public class CostOptimizationRecommendationsApiExample {

    public static void main(String[] args) {
        CostOptimizationRecommendationsApi apiInstance = new CostOptimizationRecommendationsApi();
        String id = id_example; // String | an alphanumeric identifier composed of the recommendation's database ID, the associated resource ID, and the recommendation type, delimited with hyphens, e.g. 123-456-EBS_UNATTACHED
        String fields = fields_example; // String | 
        try {
            RestCloudRecommendationV3 result = apiInstance.getRecommendationById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CostOptimizationRecommendationsApi#getRecommendationById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *id = id_example; // an alphanumeric identifier composed of the recommendation's database ID, the associated resource ID, and the recommendation type, delimited with hyphens, e.g. 123-456-EBS_UNATTACHED
String *fields = fields_example; //  (optional)

CostOptimizationRecommendationsApi *apiInstance = [[CostOptimizationRecommendationsApi alloc] init];

// Get recommendation by ID
[apiInstance getRecommendationByIdWith:id
    fields:fields
              completionHandler: ^(RestCloudRecommendationV3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CostOptimizationRecommendationsApi()
var id = id_example; // {{String}} an alphanumeric identifier composed of the recommendation's database ID, the associated resource ID, and the recommendation type, delimited with hyphens, e.g. 123-456-EBS_UNATTACHED
var opts = { 
  'fields': fields_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRecommendationById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getRecommendationByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CostOptimizationRecommendationsApi();
            var id = id_example;  // String | an alphanumeric identifier composed of the recommendation's database ID, the associated resource ID, and the recommendation type, delimited with hyphens, e.g. 123-456-EBS_UNATTACHED
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // Get recommendation by ID
                RestCloudRecommendationV3 result = apiInstance.getRecommendationById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CostOptimizationRecommendationsApi.getRecommendationById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCostOptimizationRecommendationsApi();
$id = id_example; // String | an alphanumeric identifier composed of the recommendation's database ID, the associated resource ID, and the recommendation type, delimited with hyphens, e.g. 123-456-EBS_UNATTACHED
$fields = fields_example; // String | 

try {
    $result = $api_instance->getRecommendationById($id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CostOptimizationRecommendationsApi->getRecommendationById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CostOptimizationRecommendationsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CostOptimizationRecommendationsApi->new();
my $id = id_example; # String | an alphanumeric identifier composed of the recommendation's database ID, the associated resource ID, and the recommendation type, delimited with hyphens, e.g. 123-456-EBS_UNATTACHED
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->getRecommendationById(id => $id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CostOptimizationRecommendationsApi->getRecommendationById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get recommendation by ID api_response = api_instance.get_recommendation_by_id(id, fields=fields) print(api_response) except ApiException as e: print("Exception when calling CostOptimizationRecommendationsApi->getRecommendationById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetRecommendationByIdParams()
// Get recommendation by ID
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetRecommendationById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetRecommendationById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
String
an alphanumeric identifier composed of the recommendation's database ID, the associated resource ID, and the recommendation type, delimited with hyphens, e.g. 123-456-EBS_UNATTACHED
Required
Query parameters
Name Description
fields
String

Responses

Status: 200 - Successful operation

Status: default - Error


getRecommendationCategoriesList

Get recommendation category list

Retrieves the list of recommendation categories


/cost-optimization/recommendations/categories

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/cost-optimization/recommendations/categories?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CostOptimizationRecommendationsApi;

import java.io.File;
import java.util.*;

public class CostOptimizationRecommendationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CostOptimizationRecommendationsApi apiInstance = new CostOptimizationRecommendationsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            RestCloudRecommendationCategoryV3 result = apiInstance.getRecommendationCategoriesList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CostOptimizationRecommendationsApi#getRecommendationCategoriesList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CostOptimizationRecommendationsApi;

public class CostOptimizationRecommendationsApiExample {

    public static void main(String[] args) {
        CostOptimizationRecommendationsApi apiInstance = new CostOptimizationRecommendationsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            RestCloudRecommendationCategoryV3 result = apiInstance.getRecommendationCategoriesList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CostOptimizationRecommendationsApi#getRecommendationCategoriesList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

CostOptimizationRecommendationsApi *apiInstance = [[CostOptimizationRecommendationsApi alloc] init];

// Get recommendation category list
[apiInstance getRecommendationCategoriesListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(RestCloudRecommendationCategoryV3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CostOptimizationRecommendationsApi()
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRecommendationCategoriesList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getRecommendationCategoriesListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CostOptimizationRecommendationsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // Get recommendation category list
                RestCloudRecommendationCategoryV3 result = apiInstance.getRecommendationCategoriesList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CostOptimizationRecommendationsApi.getRecommendationCategoriesList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCostOptimizationRecommendationsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getRecommendationCategoriesList($fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CostOptimizationRecommendationsApi->getRecommendationCategoriesList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CostOptimizationRecommendationsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CostOptimizationRecommendationsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getRecommendationCategoriesList(fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CostOptimizationRecommendationsApi->getRecommendationCategoriesList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get recommendation category list api_response = api_instance.get_recommendation_categories_list(fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling CostOptimizationRecommendationsApi->getRecommendationCategoriesList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetRecommendationCategoriesListParams()
// Get recommendation category list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetRecommendationCategoriesList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetRecommendationCategoriesList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successful operation

Status: default - Error


getRecommendationsList

Get recommendation list

Retrieves a list of recommendations


/cost-optimization/recommendations

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/cost-optimization/recommendations?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.CostOptimizationRecommendationsApi;

import java.io.File;
import java.util.*;

public class CostOptimizationRecommendationsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        CostOptimizationRecommendationsApi apiInstance = new CostOptimizationRecommendationsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | The number of recommendations to return. Max permitted value is 500
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | Filtering is available with the : (equals) operator for recommendationStatus and recommendationCategory. Only one value at a time is supported for recommendationCategory, but multiple recommendationStatuses may be filtered on with the | (OR) operator. Also, only the , (AND) relation is supported when combining multiple filters
        try {
            RestCloudRecommendationV3 result = apiInstance.getRecommendationsList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CostOptimizationRecommendationsApi#getRecommendationsList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.CostOptimizationRecommendationsApi;

public class CostOptimizationRecommendationsApiExample {

    public static void main(String[] args) {
        CostOptimizationRecommendationsApi apiInstance = new CostOptimizationRecommendationsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | The number of recommendations to return. Max permitted value is 500
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | Filtering is available with the : (equals) operator for recommendationStatus and recommendationCategory. Only one value at a time is supported for recommendationCategory, but multiple recommendationStatuses may be filtered on with the | (OR) operator. Also, only the , (AND) relation is supported when combining multiple filters
        try {
            RestCloudRecommendationV3 result = apiInstance.getRecommendationsList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CostOptimizationRecommendationsApi#getRecommendationsList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *fields = fields_example; //  (optional)
Integer *size = 56; // The number of recommendations to return. Max permitted value is 500 (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; // Filtering is available with the : (equals) operator for recommendationStatus and recommendationCategory. Only one value at a time is supported for recommendationCategory, but multiple recommendationStatuses may be filtered on with the | (OR) operator. Also, only the , (AND) relation is supported when combining multiple filters (optional)

CostOptimizationRecommendationsApi *apiInstance = [[CostOptimizationRecommendationsApi alloc] init];

// Get recommendation list
[apiInstance getRecommendationsListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(RestCloudRecommendationV3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.CostOptimizationRecommendationsApi()
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} The number of recommendations to return. Max permitted value is 500
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} Filtering is available with the : (equals) operator for recommendationStatus and recommendationCategory. Only one value at a time is supported for recommendationCategory, but multiple recommendationStatuses may be filtered on with the | (OR) operator. Also, only the , (AND) relation is supported when combining multiple filters
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getRecommendationsList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getRecommendationsListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new CostOptimizationRecommendationsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer | The number of recommendations to return. Max permitted value is 500 (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String | Filtering is available with the : (equals) operator for recommendationStatus and recommendationCategory. Only one value at a time is supported for recommendationCategory, but multiple recommendationStatuses may be filtered on with the | (OR) operator. Also, only the , (AND) relation is supported when combining multiple filters (optional) 

            try
            {
                // Get recommendation list
                RestCloudRecommendationV3 result = apiInstance.getRecommendationsList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CostOptimizationRecommendationsApi.getRecommendationsList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiCostOptimizationRecommendationsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | The number of recommendations to return. Max permitted value is 500
$offset = 56; // Integer | 
$filter = filter_example; // String | Filtering is available with the : (equals) operator for recommendationStatus and recommendationCategory. Only one value at a time is supported for recommendationCategory, but multiple recommendationStatuses may be filtered on with the | (OR) operator. Also, only the , (AND) relation is supported when combining multiple filters

try {
    $result = $api_instance->getRecommendationsList($fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CostOptimizationRecommendationsApi->getRecommendationsList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::CostOptimizationRecommendationsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::CostOptimizationRecommendationsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | The number of recommendations to return. Max permitted value is 500
my $offset = 56; # Integer | 
my $filter = filter_example; # String | Filtering is available with the : (equals) operator for recommendationStatus and recommendationCategory. Only one value at a time is supported for recommendationCategory, but multiple recommendationStatuses may be filtered on with the | (OR) operator. Also, only the , (AND) relation is supported when combining multiple filters

eval { 
    my $result = $api_instance->getRecommendationsList(fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CostOptimizationRecommendationsApi->getRecommendationsList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get recommendation list api_response = api_instance.get_recommendations_list(fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling CostOptimizationRecommendationsApi->getRecommendationsList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetRecommendationsListParams()
// Get recommendation list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetRecommendationsList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetRecommendationsList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
The number of recommendations to return. Max permitted value is 500
offset
Integer (int32)
filter
String
Filtering is available with the : (equals) operator for recommendationStatus and recommendationCategory. Only one value at a time is supported for recommendationCategory, but multiple recommendationStatuses may be filtered on with the | (OR) operator. Also, only the , (AND) relation is supported when combining multiple filters

Responses

Status: 200 - Successful operation

Status: default - Error


DNSMapping

addDNSMapping

Add DNS mapping

Add a new DNS mapping


/setting/dnsmappings

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/setting/dnsmappings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DNSMappingApi;

import java.io.File;
import java.util.*;

public class DNSMappingApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DNSMappingApi apiInstance = new DNSMappingApi();
        RestDNSMappingV3 body = ; // RestDNSMappingV3 | 
        try {
            RestDNSMappingV3 result = apiInstance.addDNSMapping(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DNSMappingApi#addDNSMapping");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DNSMappingApi;

public class DNSMappingApiExample {

    public static void main(String[] args) {
        DNSMappingApi apiInstance = new DNSMappingApi();
        RestDNSMappingV3 body = ; // RestDNSMappingV3 | 
        try {
            RestDNSMappingV3 result = apiInstance.addDNSMapping(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DNSMappingApi#addDNSMapping");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
RestDNSMappingV3 *body = ; //  (optional)

DNSMappingApi *apiInstance = [[DNSMappingApi alloc] init];

// Add DNS mapping
[apiInstance addDNSMappingWith:body
              completionHandler: ^(RestDNSMappingV3 output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DNSMappingApi()
var opts = { 
  'body':  // {{RestDNSMappingV3}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDNSMapping(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addDNSMappingExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DNSMappingApi();
            var body = new RestDNSMappingV3(); // RestDNSMappingV3 |  (optional) 

            try
            {
                // Add DNS mapping
                RestDNSMappingV3 result = apiInstance.addDNSMapping(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DNSMappingApi.addDNSMapping: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDNSMappingApi();
$body = ; // RestDNSMappingV3 | 

try {
    $result = $api_instance->addDNSMapping($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DNSMappingApi->addDNSMapping: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DNSMappingApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DNSMappingApi->new();
my $body = WWW::SwaggerClient::Object::RestDNSMappingV3->new(); # RestDNSMappingV3 | 

eval { 
    my $result = $api_instance->addDNSMapping(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DNSMappingApi->addDNSMapping: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Add DNS mapping api_response = api_instance.add_dns_mapping(body=body) print(api_response) except ApiException as e: print("Exception when calling DNSMappingApi->addDNSMapping: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddDNSMappingParams()
// Add DNS mapping
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddDNSMapping(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDNSMapping: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - Successfully added the DNS mapping

Status: default - Error


DashboardGroups

addDashboardGroup

add dashboard group

add dashboard group


/dashboard/groups

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/dashboard/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardGroupsApi;

import java.io.File;
import java.util.*;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        DashboardGroup body = ; // DashboardGroup | 
        try {
            DashboardGroup result = apiInstance.addDashboardGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#addDashboardGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardGroupsApi;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        DashboardGroup body = ; // DashboardGroup | 
        try {
            DashboardGroup result = apiInstance.addDashboardGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#addDashboardGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
DashboardGroup *body = ; // 

DashboardGroupsApi *apiInstance = [[DashboardGroupsApi alloc] init];

// add dashboard group
[apiInstance addDashboardGroupWith:body
              completionHandler: ^(DashboardGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardGroupsApi()
var body = ; // {{DashboardGroup}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDashboardGroup(body, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addDashboardGroupExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardGroupsApi();
            var body = new DashboardGroup(); // DashboardGroup | 

            try
            {
                // add dashboard group
                DashboardGroup result = apiInstance.addDashboardGroup(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardGroupsApi.addDashboardGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardGroupsApi();
$body = ; // DashboardGroup | 

try {
    $result = $api_instance->addDashboardGroup($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardGroupsApi->addDashboardGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardGroupsApi->new();
my $body = WWW::SwaggerClient::Object::DashboardGroup->new(); # DashboardGroup | 

eval { 
    my $result = $api_instance->addDashboardGroup(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardGroupsApi->addDashboardGroup: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # add dashboard group api_response = api_instance.add_dashboard_group(body) print(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->addDashboardGroup: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddDashboardGroupParams()
// add dashboard group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddDashboardGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDashboardGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


addDashboardGroupAsynchronously

add dashboard group asynchronously

add dashboard group asynchronously


/dashboard/groups/{id}/asyncclone

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/dashboard/groups/{id}/asyncclone?recursive="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardGroupsApi;

import java.io.File;
import java.util.*;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        Integer id = 56; // Integer | 
        DashboardGroup body = ; // DashboardGroup | 
        Boolean recursive = true; // Boolean | 
        try {
            RestDashboardGroupAsyncCloneResponse result = apiInstance.addDashboardGroupAsynchronously(id, body, recursive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#addDashboardGroupAsynchronously");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardGroupsApi;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        Integer id = 56; // Integer | 
        DashboardGroup body = ; // DashboardGroup | 
        Boolean recursive = true; // Boolean | 
        try {
            RestDashboardGroupAsyncCloneResponse result = apiInstance.addDashboardGroupAsynchronously(id, body, recursive);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#addDashboardGroupAsynchronously");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
DashboardGroup *body = ; //  (optional)
Boolean *recursive = true; //  (optional)

DashboardGroupsApi *apiInstance = [[DashboardGroupsApi alloc] init];

// add dashboard group asynchronously
[apiInstance addDashboardGroupAsynchronouslyWith:id
    body:body
    recursive:recursive
              completionHandler: ^(RestDashboardGroupAsyncCloneResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardGroupsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'body':  // {{DashboardGroup}} 
  'recursive': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDashboardGroupAsynchronously(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addDashboardGroupAsynchronouslyExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardGroupsApi();
            var id = 56;  // Integer | 
            var body = new DashboardGroup(); // DashboardGroup |  (optional) 
            var recursive = true;  // Boolean |  (optional) 

            try
            {
                // add dashboard group asynchronously
                RestDashboardGroupAsyncCloneResponse result = apiInstance.addDashboardGroupAsynchronously(id, body, recursive);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardGroupsApi.addDashboardGroupAsynchronously: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardGroupsApi();
$id = 56; // Integer | 
$body = ; // DashboardGroup | 
$recursive = true; // Boolean | 

try {
    $result = $api_instance->addDashboardGroupAsynchronously($id, $body, $recursive);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardGroupsApi->addDashboardGroupAsynchronously: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DashboardGroup->new(); # DashboardGroup | 
my $recursive = true; # Boolean | 

eval { 
    my $result = $api_instance->addDashboardGroupAsynchronously(id => $id, body => $body, recursive => $recursive);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardGroupsApi->addDashboardGroupAsynchronously: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # add dashboard group asynchronously api_response = api_instance.add_dashboard_group_asynchronously(id, body=body, recursive=recursive) print(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->addDashboardGroupAsynchronously: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddDashboardGroupAsynchronouslyParams()
// add dashboard group asynchronously
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddDashboardGroupAsynchronously(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDashboardGroupAsynchronously: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body
Query parameters
Name Description
recursive
Boolean

Responses

Status: 200 - Successful operation

Status: default - Error


deleteDashboardGroupById

delete dashboard group

delete dashboard group


/dashboard/groups/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/dashboard/groups/{id}?allowNonEmptyGroup="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardGroupsApi;

import java.io.File;
import java.util.*;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        Integer id = 56; // Integer | 
        Boolean allowNonEmptyGroup = true; // Boolean | 
        try {
            Object result = apiInstance.deleteDashboardGroupById(id, allowNonEmptyGroup);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#deleteDashboardGroupById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardGroupsApi;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        Integer id = 56; // Integer | 
        Boolean allowNonEmptyGroup = true; // Boolean | 
        try {
            Object result = apiInstance.deleteDashboardGroupById(id, allowNonEmptyGroup);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#deleteDashboardGroupById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
Boolean *allowNonEmptyGroup = true; //  (optional)

DashboardGroupsApi *apiInstance = [[DashboardGroupsApi alloc] init];

// delete dashboard group
[apiInstance deleteDashboardGroupByIdWith:id
    allowNonEmptyGroup:allowNonEmptyGroup
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardGroupsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'allowNonEmptyGroup': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDashboardGroupById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteDashboardGroupByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardGroupsApi();
            var id = 56;  // Integer | 
            var allowNonEmptyGroup = true;  // Boolean |  (optional) 

            try
            {
                // delete dashboard group
                Object result = apiInstance.deleteDashboardGroupById(id, allowNonEmptyGroup);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardGroupsApi.deleteDashboardGroupById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardGroupsApi();
$id = 56; // Integer | 
$allowNonEmptyGroup = true; // Boolean | 

try {
    $result = $api_instance->deleteDashboardGroupById($id, $allowNonEmptyGroup);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardGroupsApi->deleteDashboardGroupById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardGroupsApi->new();
my $id = 56; # Integer | 
my $allowNonEmptyGroup = true; # Boolean | 

eval { 
    my $result = $api_instance->deleteDashboardGroupById(id => $id, allowNonEmptyGroup => $allowNonEmptyGroup);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardGroupsApi->deleteDashboardGroupById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # delete dashboard group api_response = api_instance.delete_dashboard_group_by_id(id, allowNonEmptyGroup=allowNonEmptyGroup) print(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->deleteDashboardGroupById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDashboardGroupByIdParams()
// delete dashboard group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteDashboardGroupById(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteDashboardGroupById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
allowNonEmptyGroup
Boolean

Responses

Status: 200 - Successful operation

Status: default - Error


getDashboardGroupById

Get dashboard group by ID

Retrieves a dashboard group by its ID


/dashboard/groups/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/dashboard/groups/{id}?template=&format=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardGroupsApi;

import java.io.File;
import java.util.*;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        Integer id = 56; // Integer | 
        Boolean template = true; // Boolean | 
        String format = format_example; // String | 
        String fields = fields_example; // String | 
        try {
            DashboardGroup result = apiInstance.getDashboardGroupById(id, template, format, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#getDashboardGroupById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardGroupsApi;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        Integer id = 56; // Integer | 
        Boolean template = true; // Boolean | 
        String format = format_example; // String | 
        String fields = fields_example; // String | 
        try {
            DashboardGroup result = apiInstance.getDashboardGroupById(id, template, format, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#getDashboardGroupById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
Boolean *template = true; //  (optional)
String *format = format_example; //  (optional)
String *fields = fields_example; //  (optional)

DashboardGroupsApi *apiInstance = [[DashboardGroupsApi alloc] init];

// Get dashboard group by ID
[apiInstance getDashboardGroupByIdWith:id
    template:template
    format:format
    fields:fields
              completionHandler: ^(DashboardGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardGroupsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'template': true, // {{Boolean}} 
  'format': format_example, // {{String}} 
  'fields': fields_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashboardGroupById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDashboardGroupByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardGroupsApi();
            var id = 56;  // Integer | 
            var template = true;  // Boolean |  (optional) 
            var format = format_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // Get dashboard group by ID
                DashboardGroup result = apiInstance.getDashboardGroupById(id, template, format, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardGroupsApi.getDashboardGroupById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardGroupsApi();
$id = 56; // Integer | 
$template = true; // Boolean | 
$format = format_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->getDashboardGroupById($id, $template, $format, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardGroupsApi->getDashboardGroupById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardGroupsApi->new();
my $id = 56; # Integer | 
my $template = true; # Boolean | 
my $format = format_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->getDashboardGroupById(id => $id, template => $template, format => $format, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardGroupsApi->getDashboardGroupById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get dashboard group by ID api_response = api_instance.get_dashboard_group_by_id(id, template=template, format=format, fields=fields) print(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->getDashboardGroupById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDashboardGroupByIdParams()
// Get dashboard group by ID
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDashboardGroupById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDashboardGroupById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
template
Boolean
format
String
fields
String

Responses

Status: 200 - Successfully retrieved the dashboard group

Status: default - Error


getDashboardGroupList

get dashboard group list

get dashboard group list


/dashboard/groups

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/dashboard/groups?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardGroupsApi;

import java.io.File;
import java.util.*;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DashboardGroupPaginationResponse result = apiInstance.getDashboardGroupList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#getDashboardGroupList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardGroupsApi;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DashboardGroupPaginationResponse result = apiInstance.getDashboardGroupList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#getDashboardGroupList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

DashboardGroupsApi *apiInstance = [[DashboardGroupsApi alloc] init];

// get dashboard group list
[apiInstance getDashboardGroupListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DashboardGroupPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardGroupsApi()
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashboardGroupList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDashboardGroupListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardGroupsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get dashboard group list
                DashboardGroupPaginationResponse result = apiInstance.getDashboardGroupList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardGroupsApi.getDashboardGroupList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardGroupsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getDashboardGroupList($fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardGroupsApi->getDashboardGroupList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardGroupsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getDashboardGroupList(fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardGroupsApi->getDashboardGroupList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get dashboard group list api_response = api_instance.get_dashboard_group_list(fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->getDashboardGroupList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDashboardGroupListParams()
// get dashboard group list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDashboardGroupList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDashboardGroupList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successful operation

Status: default - Error


patchDashboardGroupById

update dashboard group

The template field works only for the POST API


/dashboard/groups/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/dashboard/groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardGroupsApi;

import java.io.File;
import java.util.*;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        Integer id = 56; // Integer | 
        DashboardGroup body = ; // DashboardGroup | 
        try {
            DashboardGroup result = apiInstance.patchDashboardGroupById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#patchDashboardGroupById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardGroupsApi;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        Integer id = 56; // Integer | 
        DashboardGroup body = ; // DashboardGroup | 
        try {
            DashboardGroup result = apiInstance.patchDashboardGroupById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#patchDashboardGroupById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
DashboardGroup *body = ; // 

DashboardGroupsApi *apiInstance = [[DashboardGroupsApi alloc] init];

// update dashboard group
[apiInstance patchDashboardGroupByIdWith
    id:id:body
              completionHandler: ^(DashboardGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardGroupsApi()
var id = 56; // {{Integer}} 
var body = ; // {{DashboardGroup}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchDashboardGroupById(idbody, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchDashboardGroupByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardGroupsApi();
            var id = 56;  // Integer | 
            var body = new DashboardGroup(); // DashboardGroup | 

            try
            {
                // update dashboard group
                DashboardGroup result = apiInstance.patchDashboardGroupById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardGroupsApi.patchDashboardGroupById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardGroupsApi();
$id = 56; // Integer | 
$body = ; // DashboardGroup | 

try {
    $result = $api_instance->patchDashboardGroupById($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardGroupsApi->patchDashboardGroupById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DashboardGroup->new(); # DashboardGroup | 

eval { 
    my $result = $api_instance->patchDashboardGroupById(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardGroupsApi->patchDashboardGroupById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # update dashboard group api_response = api_instance.patch_dashboard_group_by_id(id, body) print(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->patchDashboardGroupById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDashboardGroupByIdParams()
// update dashboard group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.PatchDashboardGroupById(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchDashboardGroupById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


updateDashboardGroupById

update dashboard group

The template field works only for the POST API


/dashboard/groups/{id}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/dashboard/groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardGroupsApi;

import java.io.File;
import java.util.*;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        Integer id = 56; // Integer | 
        DashboardGroup body = ; // DashboardGroup | 
        try {
            DashboardGroup result = apiInstance.updateDashboardGroupById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#updateDashboardGroupById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardGroupsApi;

public class DashboardGroupsApiExample {

    public static void main(String[] args) {
        DashboardGroupsApi apiInstance = new DashboardGroupsApi();
        Integer id = 56; // Integer | 
        DashboardGroup body = ; // DashboardGroup | 
        try {
            DashboardGroup result = apiInstance.updateDashboardGroupById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardGroupsApi#updateDashboardGroupById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
DashboardGroup *body = ; // 

DashboardGroupsApi *apiInstance = [[DashboardGroupsApi alloc] init];

// update dashboard group
[apiInstance updateDashboardGroupByIdWith
    id:id:body
              completionHandler: ^(DashboardGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardGroupsApi()
var id = 56; // {{Integer}} 
var body = ; // {{DashboardGroup}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDashboardGroupById(idbody, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateDashboardGroupByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardGroupsApi();
            var id = 56;  // Integer | 
            var body = new DashboardGroup(); // DashboardGroup | 

            try
            {
                // update dashboard group
                DashboardGroup result = apiInstance.updateDashboardGroupById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardGroupsApi.updateDashboardGroupById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardGroupsApi();
$id = 56; // Integer | 
$body = ; // DashboardGroup | 

try {
    $result = $api_instance->updateDashboardGroupById($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardGroupsApi->updateDashboardGroupById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardGroupsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DashboardGroup->new(); # DashboardGroup | 

eval { 
    my $result = $api_instance->updateDashboardGroupById(id => $id, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardGroupsApi->updateDashboardGroupById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # update dashboard group api_response = api_instance.update_dashboard_group_by_id(id, body) print(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->updateDashboardGroupById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDashboardGroupByIdParams()
// update dashboard group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.UpdateDashboardGroupById(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateDashboardGroupById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


Dashboards

addDashboard

add dashboard

add dashboard


/dashboard/dashboards

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/dashboard/dashboards"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardsApi;

import java.io.File;
import java.util.*;

public class DashboardsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardsApi apiInstance = new DashboardsApi();
        Dashboard body = ; // Dashboard | 
        try {
            Dashboard result = apiInstance.addDashboard(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#addDashboard");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardsApi;

public class DashboardsApiExample {

    public static void main(String[] args) {
        DashboardsApi apiInstance = new DashboardsApi();
        Dashboard body = ; // Dashboard | 
        try {
            Dashboard result = apiInstance.addDashboard(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#addDashboard");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Dashboard *body = ; // 

DashboardsApi *apiInstance = [[DashboardsApi alloc] init];

// add dashboard
[apiInstance addDashboardWith:body
              completionHandler: ^(Dashboard output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardsApi()
var body = ; // {{Dashboard}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDashboard(body, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addDashboardExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardsApi();
            var body = new Dashboard(); // Dashboard | 

            try
            {
                // add dashboard
                Dashboard result = apiInstance.addDashboard(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardsApi.addDashboard: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardsApi();
$body = ; // Dashboard | 

try {
    $result = $api_instance->addDashboard($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsApi->addDashboard: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardsApi->new();
my $body = WWW::SwaggerClient::Object::Dashboard->new(); # Dashboard | 

eval { 
    my $result = $api_instance->addDashboard(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsApi->addDashboard: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # add dashboard api_response = api_instance.add_dashboard(body) print(api_response) except ApiException as e: print("Exception when calling DashboardsApi->addDashboard: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddDashboardParams()
// add dashboard
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddDashboard(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDashboard: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


deleteDashboardById

delete dashboard

delete dashboard


/dashboard/dashboards/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/dashboard/dashboards/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardsApi;

import java.io.File;
import java.util.*;

public class DashboardsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardsApi apiInstance = new DashboardsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteDashboardById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#deleteDashboardById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardsApi;

public class DashboardsApiExample {

    public static void main(String[] args) {
        DashboardsApi apiInstance = new DashboardsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteDashboardById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#deleteDashboardById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 

DashboardsApi *apiInstance = [[DashboardsApi alloc] init];

// delete dashboard
[apiInstance deleteDashboardByIdWith:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardsApi()
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDashboardById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteDashboardByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardsApi();
            var id = 56;  // Integer | 

            try
            {
                // delete dashboard
                Object result = apiInstance.deleteDashboardById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardsApi.deleteDashboardById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardsApi();
$id = 56; // Integer | 

try {
    $result = $api_instance->deleteDashboardById($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsApi->deleteDashboardById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardsApi->new();
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->deleteDashboardById(id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsApi->deleteDashboardById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # delete dashboard api_response = api_instance.delete_dashboard_by_id(id) print(api_response) except ApiException as e: print("Exception when calling DashboardsApi->deleteDashboardById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDashboardByIdParams()
// delete dashboard
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteDashboardById(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteDashboardById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - Successful operation

Status: default - Error


getDashboardById

get dashboard

get dashboard


/dashboard/dashboards/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/dashboard/dashboards/{id}?template=&format=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardsApi;

import java.io.File;
import java.util.*;

public class DashboardsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardsApi apiInstance = new DashboardsApi();
        Integer id = 56; // Integer | 
        Boolean template = true; // Boolean | 
        String format = format_example; // String | 
        String fields = fields_example; // String | 
        try {
            Dashboard result = apiInstance.getDashboardById(id, template, format, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#getDashboardById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardsApi;

public class DashboardsApiExample {

    public static void main(String[] args) {
        DashboardsApi apiInstance = new DashboardsApi();
        Integer id = 56; // Integer | 
        Boolean template = true; // Boolean | 
        String format = format_example; // String | 
        String fields = fields_example; // String | 
        try {
            Dashboard result = apiInstance.getDashboardById(id, template, format, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#getDashboardById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
Boolean *template = true; //  (optional)
String *format = format_example; //  (optional)
String *fields = fields_example; //  (optional)

DashboardsApi *apiInstance = [[DashboardsApi alloc] init];

// get dashboard
[apiInstance getDashboardByIdWith:id
    template:template
    format:format
    fields:fields
              completionHandler: ^(Dashboard output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'template': true, // {{Boolean}} 
  'format': format_example, // {{String}} 
  'fields': fields_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashboardById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDashboardByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardsApi();
            var id = 56;  // Integer | 
            var template = true;  // Boolean |  (optional) 
            var format = format_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get dashboard
                Dashboard result = apiInstance.getDashboardById(id, template, format, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardsApi.getDashboardById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardsApi();
$id = 56; // Integer | 
$template = true; // Boolean | 
$format = format_example; // String | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->getDashboardById($id, $template, $format, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsApi->getDashboardById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardsApi->new();
my $id = 56; # Integer | 
my $template = true; # Boolean | 
my $format = format_example; # String | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->getDashboardById(id => $id, template => $template, format => $format, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsApi->getDashboardById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get dashboard api_response = api_instance.get_dashboard_by_id(id, template=template, format=format, fields=fields) print(api_response) except ApiException as e: print("Exception when calling DashboardsApi->getDashboardById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDashboardByIdParams()
// get dashboard
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDashboardById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDashboardById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
template
Boolean
format
String
fields
String

Responses

Status: 200 - Successful operation

Status: default - Error


getDashboardList

Get dashboard list

Retrieves a list of dashboards


/dashboard/dashboards

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/dashboard/dashboards?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardsApi;

import java.io.File;
import java.util.*;

public class DashboardsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardsApi apiInstance = new DashboardsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DashboardPaginationResponse result = apiInstance.getDashboardList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#getDashboardList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardsApi;

public class DashboardsApiExample {

    public static void main(String[] args) {
        DashboardsApi apiInstance = new DashboardsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DashboardPaginationResponse result = apiInstance.getDashboardList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#getDashboardList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

DashboardsApi *apiInstance = [[DashboardsApi alloc] init];

// Get dashboard list
[apiInstance getDashboardListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DashboardPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardsApi()
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDashboardList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDashboardListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // Get dashboard list
                DashboardPaginationResponse result = apiInstance.getDashboardList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardsApi.getDashboardList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getDashboardList($fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsApi->getDashboardList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getDashboardList(fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsApi->getDashboardList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get dashboard list api_response = api_instance.get_dashboard_list(fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling DashboardsApi->getDashboardList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDashboardListParams()
// Get dashboard list
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDashboardList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDashboardList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successfully retrieved the dashboard list

Status: default - Error


getWidgetListByDashboardId

get widget list by DashboardId

get widget list by DashboardId


/dashboard/dashboards/{id}/widgets

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/dashboard/dashboards/{id}/widgets?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardsApi;

import java.io.File;
import java.util.*;

public class DashboardsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardsApi apiInstance = new DashboardsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            WidgetPaginationResponse result = apiInstance.getWidgetListByDashboardId(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#getWidgetListByDashboardId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardsApi;

public class DashboardsApiExample {

    public static void main(String[] args) {
        DashboardsApi apiInstance = new DashboardsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            WidgetPaginationResponse result = apiInstance.getWidgetListByDashboardId(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#getWidgetListByDashboardId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

DashboardsApi *apiInstance = [[DashboardsApi alloc] init];

// get widget list by DashboardId
[apiInstance getWidgetListByDashboardIdWith:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(WidgetPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardsApi()
var id = 56; // {{Integer}} 
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWidgetListByDashboardId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWidgetListByDashboardIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardsApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get widget list by DashboardId
                WidgetPaginationResponse result = apiInstance.getWidgetListByDashboardId(id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardsApi.getWidgetListByDashboardId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardsApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getWidgetListByDashboardId($id, $fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsApi->getWidgetListByDashboardId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardsApi->new();
my $id = 56; # Integer | 
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getWidgetListByDashboardId(id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsApi->getWidgetListByDashboardId: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get widget list by DashboardId api_response = api_instance.get_widget_list_by_dashboard_id(id, fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling DashboardsApi->getWidgetListByDashboardId: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetWidgetListByDashboardIdParams()
// get widget list by DashboardId
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetWidgetListByDashboardId(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWidgetListByDashboardId: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successful operation

Status: default - Error


patchDashboardById

update dashboard

The template field works only for the POST API


/dashboard/dashboards/{id}

Usage and SDK Samples

curl -X PATCH\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/dashboard/dashboards/{id}?overwriteGroupFields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardsApi;

import java.io.File;
import java.util.*;

public class DashboardsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardsApi apiInstance = new DashboardsApi();
        Integer id = 56; // Integer | 
        Dashboard body = ; // Dashboard | 
        Boolean overwriteGroupFields = true; // Boolean | 
        try {
            Dashboard result = apiInstance.patchDashboardById(id, body, overwriteGroupFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#patchDashboardById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardsApi;

public class DashboardsApiExample {

    public static void main(String[] args) {
        DashboardsApi apiInstance = new DashboardsApi();
        Integer id = 56; // Integer | 
        Dashboard body = ; // Dashboard | 
        Boolean overwriteGroupFields = true; // Boolean | 
        try {
            Dashboard result = apiInstance.patchDashboardById(id, body, overwriteGroupFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#patchDashboardById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
Dashboard *body = ; // 
Boolean *overwriteGroupFields = true; //  (optional)

DashboardsApi *apiInstance = [[DashboardsApi alloc] init];

// update dashboard
[apiInstance patchDashboardByIdWith
    id:id:body
    overwriteGroupFields:overwriteGroupFields
              completionHandler: ^(Dashboard output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardsApi()
var id = 56; // {{Integer}} 
var body = ; // {{Dashboard}} 
var opts = { 
  'overwriteGroupFields': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.patchDashboardById(idbody, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchDashboardByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardsApi();
            var id = 56;  // Integer | 
            var body = new Dashboard(); // Dashboard | 
            var overwriteGroupFields = true;  // Boolean |  (optional) 

            try
            {
                // update dashboard
                Dashboard result = apiInstance.patchDashboardById(id, body, overwriteGroupFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardsApi.patchDashboardById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardsApi();
$id = 56; // Integer | 
$body = ; // Dashboard | 
$overwriteGroupFields = true; // Boolean | 

try {
    $result = $api_instance->patchDashboardById($id, $body, $overwriteGroupFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsApi->patchDashboardById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Dashboard->new(); # Dashboard | 
my $overwriteGroupFields = true; # Boolean | 

eval { 
    my $result = $api_instance->patchDashboardById(id => $id, body => $body, overwriteGroupFields => $overwriteGroupFields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsApi->patchDashboardById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # update dashboard api_response = api_instance.patch_dashboard_by_id(id, body, overwriteGroupFields=overwriteGroupFields) print(api_response) except ApiException as e: print("Exception when calling DashboardsApi->patchDashboardById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDashboardByIdParams()
// update dashboard
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.PatchDashboardById(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchDashboardById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
overwriteGroupFields
Boolean

Responses

Status: 200 - Successful operation

Status: default - Error


updateDashboardById

update dashboard

The template field works only for the POST API


/dashboard/dashboards/{id}

Usage and SDK Samples

curl -X PUT\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/dashboard/dashboards/{id}?overwriteGroupFields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DashboardsApi;

import java.io.File;
import java.util.*;

public class DashboardsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DashboardsApi apiInstance = new DashboardsApi();
        Integer id = 56; // Integer | 
        Dashboard body = ; // Dashboard | 
        Boolean overwriteGroupFields = true; // Boolean | 
        try {
            Dashboard result = apiInstance.updateDashboardById(id, body, overwriteGroupFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#updateDashboardById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DashboardsApi;

public class DashboardsApiExample {

    public static void main(String[] args) {
        DashboardsApi apiInstance = new DashboardsApi();
        Integer id = 56; // Integer | 
        Dashboard body = ; // Dashboard | 
        Boolean overwriteGroupFields = true; // Boolean | 
        try {
            Dashboard result = apiInstance.updateDashboardById(id, body, overwriteGroupFields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DashboardsApi#updateDashboardById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
Dashboard *body = ; // 
Boolean *overwriteGroupFields = true; //  (optional)

DashboardsApi *apiInstance = [[DashboardsApi alloc] init];

// update dashboard
[apiInstance updateDashboardByIdWith
    id:id:body
    overwriteGroupFields:overwriteGroupFields
              completionHandler: ^(Dashboard output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DashboardsApi()
var id = 56; // {{Integer}} 
var body = ; // {{Dashboard}} 
var opts = { 
  'overwriteGroupFields': true // {{Boolean}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.updateDashboardById(idbody, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateDashboardByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DashboardsApi();
            var id = 56;  // Integer | 
            var body = new Dashboard(); // Dashboard | 
            var overwriteGroupFields = true;  // Boolean |  (optional) 

            try
            {
                // update dashboard
                Dashboard result = apiInstance.updateDashboardById(id, body, overwriteGroupFields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DashboardsApi.updateDashboardById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDashboardsApi();
$id = 56; // Integer | 
$body = ; // Dashboard | 
$overwriteGroupFields = true; // Boolean | 

try {
    $result = $api_instance->updateDashboardById($id, $body, $overwriteGroupFields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DashboardsApi->updateDashboardById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DashboardsApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DashboardsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Dashboard->new(); # Dashboard | 
my $overwriteGroupFields = true; # Boolean | 

eval { 
    my $result = $api_instance->updateDashboardById(id => $id, body => $body, overwriteGroupFields => $overwriteGroupFields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DashboardsApi->updateDashboardById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # update dashboard api_response = api_instance.update_dashboard_by_id(id, body, overwriteGroupFields=overwriteGroupFields) print(api_response) except ApiException as e: print("Exception when calling DashboardsApi->updateDashboardById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDashboardByIdParams()
// update dashboard
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.UpdateDashboardById(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateDashboardById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
overwriteGroupFields
Boolean

Responses

Status: 200 - Successful operation

Status: default - Error


Data

fetchDeviceInstancesData

Fetch device instances data

Retrieve a paginated list of data for device instances


/device/instances/datafetch

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/device/instances/datafetch?period=&start=&end=&aggregate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        DeviceInstances body = ; // DeviceInstances | 
        Double period = 1.2; // Double | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String aggregate = aggregate_example; // String | The aggregate option
        try {
            DeviceInstanceDataPaginationResponse result = apiInstance.fetchDeviceInstancesData(body, period, start, end, aggregate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#fetchDeviceInstancesData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        DeviceInstances body = ; // DeviceInstances | 
        Double period = 1.2; // Double | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String aggregate = aggregate_example; // String | The aggregate option
        try {
            DeviceInstanceDataPaginationResponse result = apiInstance.fetchDeviceInstancesData(body, period, start, end, aggregate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#fetchDeviceInstancesData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
DeviceInstances *body = ; // 
Double *period = 1.2; //  (optional)
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *aggregate = aggregate_example; // The aggregate option (optional)

DataApi *apiInstance = [[DataApi alloc] init];

// Fetch device instances data
[apiInstance fetchDeviceInstancesDataWith:body
    period:period
    start:start
    end:end
    aggregate:aggregate
              completionHandler: ^(DeviceInstanceDataPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DataApi()
var body = ; // {{DeviceInstances}} 
var opts = { 
  'period': 1.2 // {{Double}} 
  'start': 789 // {{Long}} 
  'end': 789 // {{Long}} 
  'aggregate': aggregate_example // {{String}} The aggregate option
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.fetchDeviceInstancesData(body, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class fetchDeviceInstancesDataExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var body = new DeviceInstances(); // DeviceInstances | 
            var period = 1.2;  // Double |  (optional) 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var aggregate = aggregate_example;  // String | The aggregate option (optional) 

            try
            {
                // Fetch device instances data
                DeviceInstanceDataPaginationResponse result = apiInstance.fetchDeviceInstancesData(body, period, start, end, aggregate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.fetchDeviceInstancesData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$body = ; // DeviceInstances | 
$period = 1.2; // Double | 
$start = 789; // Long | 
$end = 789; // Long | 
$aggregate = aggregate_example; // String | The aggregate option

try {
    $result = $api_instance->fetchDeviceInstancesData($body, $period, $start, $end, $aggregate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->fetchDeviceInstancesData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $body = WWW::SwaggerClient::Object::DeviceInstances->new(); # DeviceInstances | 
my $period = 1.2; # Double | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $aggregate = aggregate_example; # String | The aggregate option

eval { 
    my $result = $api_instance->fetchDeviceInstancesData(body => $body, period => $period, start => $start, end => $end, aggregate => $aggregate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->fetchDeviceInstancesData: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Fetch device instances data api_response = api_instance.fetch_device_instances_data(body, period=period, start=start, end=end, aggregate=aggregate) print(api_response) except ApiException as e: print("Exception when calling DataApi->fetchDeviceInstancesData: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewFetchDeviceInstancesDataParams()
// Fetch device instances data
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.FetchDeviceInstancesData(params) if err != nil { fmt.Printf("Exception when calling client.LM.FetchDeviceInstancesData: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
period
Double (double)
start
Long (int64)
end
Long (int64)
aggregate
String
The aggregate option

Responses

Status: 200 - Successfully retrieved the device instances data

Status: default - Error


getDeviceConfigSourceConfigById

get a config for a device

get a config for a device


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/config/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/config/{id}?format=&startEpoch=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        Integer instanceId = 56; // Integer | 
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        String id = id_example; // String | 
        String format = format_example; // String | 
        Long startEpoch = 789; // Long | 
        String fields = fields_example; // String | 
        try {
            DeviceDataSourceInstanceConfig result = apiInstance.getDeviceConfigSourceConfigById(instanceId, deviceId, hdsId, id, format, startEpoch, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDeviceConfigSourceConfigById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        Integer instanceId = 56; // Integer | 
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        String id = id_example; // String | 
        String format = format_example; // String | 
        Long startEpoch = 789; // Long | 
        String fields = fields_example; // String | 
        try {
            DeviceDataSourceInstanceConfig result = apiInstance.getDeviceConfigSourceConfigById(instanceId, deviceId, hdsId, id, format, startEpoch, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDeviceConfigSourceConfigById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *instanceId = 56; // 
Integer *deviceId = 56; // 
Integer *hdsId = 56; // 
String *id = id_example; // 
String *format = format_example; //  (optional)
Long *startEpoch = 789; //  (optional)
String *fields = fields_example; //  (optional)

DataApi *apiInstance = [[DataApi alloc] init];

// get a config for a device
[apiInstance getDeviceConfigSourceConfigByIdWith:instanceId
    deviceId:deviceId
    hdsId:hdsId
    id:id
    format:format
    startEpoch:startEpoch
    fields:fields
              completionHandler: ^(DeviceDataSourceInstanceConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DataApi()
var instanceId = 56; // {{Integer}} 
var deviceId = 56; // {{Integer}} 
var hdsId = 56; // {{Integer}} 
var id = id_example; // {{String}} 
var opts = { 
  'format': format_example, // {{String}} 
  'startEpoch': 789, // {{Long}} 
  'fields': fields_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeviceConfigSourceConfigById(instanceId, deviceId, hdsId, id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceConfigSourceConfigByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var instanceId = 56;  // Integer | 
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | 
            var id = id_example;  // String | 
            var format = format_example;  // String |  (optional) 
            var startEpoch = 789;  // Long |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get a config for a device
                DeviceDataSourceInstanceConfig result = apiInstance.getDeviceConfigSourceConfigById(instanceId, deviceId, hdsId, id, format, startEpoch, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDeviceConfigSourceConfigById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$instanceId = 56; // Integer | 
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | 
$id = id_example; // String | 
$format = format_example; // String | 
$startEpoch = 789; // Long | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->getDeviceConfigSourceConfigById($instanceId, $deviceId, $hdsId, $id, $format, $startEpoch, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDeviceConfigSourceConfigById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $instanceId = 56; # Integer | 
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | 
my $id = id_example; # String | 
my $format = format_example; # String | 
my $startEpoch = 789; # Long | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->getDeviceConfigSourceConfigById(instanceId => $instanceId, deviceId => $deviceId, hdsId => $hdsId, id => $id, format => $format, startEpoch => $startEpoch, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getDeviceConfigSourceConfigById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get a config for a device api_response = api_instance.get_device_config_source_config_by_id(instanceId, deviceId, hdsId, id, format=format, startEpoch=startEpoch, fields=fields) print(api_response) except ApiException as e: print("Exception when calling DataApi->getDeviceConfigSourceConfigById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceConfigSourceConfigByIdParams()
// get a config for a device
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDeviceConfigSourceConfigById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceConfigSourceConfigById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
instanceId*
Integer (int32)
Required
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
Required
id*
String
Required
Query parameters
Name Description
format
String
startEpoch
Long (int64)
fields
String

Responses

Status: 200 - Successful operation

Status: default - Error


getDeviceDatasourceInstanceData

get device instance data

get device instance data


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}/data

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}/data?period=&start=&end=&datapoints=&format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        Integer id = 56; // Integer | 
        Double period = 1.2; // Double | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String datapoints = datapoints_example; // String | 
        String format = format_example; // String | 
        try {
            DeviceDataSourceInstanceData result = apiInstance.getDeviceDatasourceInstanceData(deviceId, hdsId, id, period, start, end, datapoints, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDeviceDatasourceInstanceData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        Integer id = 56; // Integer | 
        Double period = 1.2; // Double | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String datapoints = datapoints_example; // String | 
        String format = format_example; // String | 
        try {
            DeviceDataSourceInstanceData result = apiInstance.getDeviceDatasourceInstanceData(deviceId, hdsId, id, period, start, end, datapoints, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDeviceDatasourceInstanceData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *deviceId = 56; // 
Integer *hdsId = 56; // The device-datasource ID
Integer *id = 56; // 
Double *period = 1.2; //  (optional)
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *datapoints = datapoints_example; //  (optional)
String *format = format_example; //  (optional)

DataApi *apiInstance = [[DataApi alloc] init];

// get device instance data
[apiInstance getDeviceDatasourceInstanceDataWith:deviceId
    hdsId:hdsId
    id:id
    period:period
    start:start
    end:end
    datapoints:datapoints
    format:format
              completionHandler: ^(DeviceDataSourceInstanceData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DataApi()
var deviceId = 56; // {{Integer}} 
var hdsId = 56; // {{Integer}} The device-datasource ID
var id = 56; // {{Integer}} 
var opts = { 
  'period': 1.2, // {{Double}} 
  'start': 789, // {{Long}} 
  'end': 789, // {{Long}} 
  'datapoints': datapoints_example, // {{String}} 
  'format': format_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeviceDatasourceInstanceData(deviceId, hdsId, id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceDatasourceInstanceDataExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | The device-datasource ID
            var id = 56;  // Integer | 
            var period = 1.2;  // Double |  (optional) 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var datapoints = datapoints_example;  // String |  (optional) 
            var format = format_example;  // String |  (optional) 

            try
            {
                // get device instance data
                DeviceDataSourceInstanceData result = apiInstance.getDeviceDatasourceInstanceData(deviceId, hdsId, id, period, start, end, datapoints, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDeviceDatasourceInstanceData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | The device-datasource ID
$id = 56; // Integer | 
$period = 1.2; // Double | 
$start = 789; // Long | 
$end = 789; // Long | 
$datapoints = datapoints_example; // String | 
$format = format_example; // String | 

try {
    $result = $api_instance->getDeviceDatasourceInstanceData($deviceId, $hdsId, $id, $period, $start, $end, $datapoints, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDeviceDatasourceInstanceData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | The device-datasource ID
my $id = 56; # Integer | 
my $period = 1.2; # Double | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $datapoints = datapoints_example; # String | 
my $format = format_example; # String | 

eval { 
    my $result = $api_instance->getDeviceDatasourceInstanceData(deviceId => $deviceId, hdsId => $hdsId, id => $id, period => $period, start => $start, end => $end, datapoints => $datapoints, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getDeviceDatasourceInstanceData: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get device instance data api_response = api_instance.get_device_datasource_instance_data(deviceId, hdsId, id, period=period, start=start, end=end, datapoints=datapoints, format=format) print(api_response) except ApiException as e: print("Exception when calling DataApi->getDeviceDatasourceInstanceData: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceDataParams()
// get device instance data
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDeviceDatasourceInstanceData(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceInstanceData: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
The device-datasource ID
Required
id*
Integer (int32)
Required
Query parameters
Name Description
period
Double (double)
start
Long (int64)
end
Long (int64)
datapoints
String
format
String

Responses

Status: 200 - Successful operation

Status: default - Error


getDeviceDatasourceInstanceGraphData

get device instance graph data

get device instance graph data


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}/graphs/{graphId}/data

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}/graphs/{graphId}/data?start=&end=&format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        Integer id = 56; // Integer | 
        Integer graphId = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getDeviceDatasourceInstanceGraphData(deviceId, hdsId, id, graphId, start, end, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDeviceDatasourceInstanceGraphData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        Integer id = 56; // Integer | 
        Integer graphId = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getDeviceDatasourceInstanceGraphData(deviceId, hdsId, id, graphId, start, end, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDeviceDatasourceInstanceGraphData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *deviceId = 56; // 
Integer *hdsId = 56; // The device-datasource ID
Integer *id = 56; // 
Integer *graphId = 56; // 
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *format = format_example; //  (optional)

DataApi *apiInstance = [[DataApi alloc] init];

// get device instance graph data
[apiInstance getDeviceDatasourceInstanceGraphDataWith:deviceId
    hdsId:hdsId
    id:id
    graphId:graphId
    start:start
    end:end
    format:format
              completionHandler: ^(GraphPlot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DataApi()
var deviceId = 56; // {{Integer}} 
var hdsId = 56; // {{Integer}} The device-datasource ID
var id = 56; // {{Integer}} 
var graphId = 56; // {{Integer}} 
var opts = { 
  'start': 789, // {{Long}} 
  'end': 789, // {{Long}} 
  'format': format_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeviceDatasourceInstanceGraphData(deviceId, hdsId, id, graphId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceDatasourceInstanceGraphDataExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | The device-datasource ID
            var id = 56;  // Integer | 
            var graphId = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var format = format_example;  // String |  (optional) 

            try
            {
                // get device instance graph data
                GraphPlot result = apiInstance.getDeviceDatasourceInstanceGraphData(deviceId, hdsId, id, graphId, start, end, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDeviceDatasourceInstanceGraphData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | The device-datasource ID
$id = 56; // Integer | 
$graphId = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$format = format_example; // String | 

try {
    $result = $api_instance->getDeviceDatasourceInstanceGraphData($deviceId, $hdsId, $id, $graphId, $start, $end, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDeviceDatasourceInstanceGraphData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | The device-datasource ID
my $id = 56; # Integer | 
my $graphId = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $format = format_example; # String | 

eval { 
    my $result = $api_instance->getDeviceDatasourceInstanceGraphData(deviceId => $deviceId, hdsId => $hdsId, id => $id, graphId => $graphId, start => $start, end => $end, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getDeviceDatasourceInstanceGraphData: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get device instance graph data api_response = api_instance.get_device_datasource_instance_graph_data(deviceId, hdsId, id, graphId, start=start, end=end, format=format) print(api_response) except ApiException as e: print("Exception when calling DataApi->getDeviceDatasourceInstanceGraphData: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceGraphDataParams()
// get device instance graph data
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDeviceDatasourceInstanceGraphData(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceInstanceGraphData: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
The device-datasource ID
Required
id*
Integer (int32)
Required
graphId*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
format
String

Responses

Status: 200 - Successful operation

Status: default - Error


getDeviceDatasourceInstanceGroupOverviewGraphData

Get device instance group overview graph data

Retrieve graph data for the overview of a device instance group


/device/devices/{deviceId}/devicedatasources/{deviceDsId}/groups/{dsigId}/graphs/{ographId}/data

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{deviceDsId}/groups/{dsigId}/graphs/{ographId}/data?start=&end=&format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        Integer deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
        Integer deviceId = 56; // Integer | 
        Integer dsigId = 56; // Integer | 
        Integer ographId = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getDeviceDatasourceInstanceGroupOverviewGraphData(deviceDsId, deviceId, dsigId, ographId, start, end, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDeviceDatasourceInstanceGroupOverviewGraphData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        Integer deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
        Integer deviceId = 56; // Integer | 
        Integer dsigId = 56; // Integer | 
        Integer ographId = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getDeviceDatasourceInstanceGroupOverviewGraphData(deviceDsId, deviceId, dsigId, ographId, start, end, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDeviceDatasourceInstanceGroupOverviewGraphData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *deviceDsId = 56; // The device-datasource ID you'd like to add an instance group for
Integer *deviceId = 56; // 
Integer *dsigId = 56; // 
Integer *ographId = 56; // 
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *format = format_example; //  (optional)

DataApi *apiInstance = [[DataApi alloc] init];

// Get device instance group overview graph data
[apiInstance getDeviceDatasourceInstanceGroupOverviewGraphDataWith:deviceDsId
    deviceId:deviceId
    dsigId:dsigId
    ographId:ographId
    start:start
    end:end
    format:format
              completionHandler: ^(GraphPlot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DataApi()
var deviceDsId = 56; // {{Integer}} The device-datasource ID you'd like to add an instance group for
var deviceId = 56; // {{Integer}} 
var dsigId = 56; // {{Integer}} 
var ographId = 56; // {{Integer}} 
var opts = { 
  'start': 789, // {{Long}} 
  'end': 789, // {{Long}} 
  'format': format_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeviceDatasourceInstanceGroupOverviewGraphData(deviceDsId, deviceId, dsigId, ographId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceDatasourceInstanceGroupOverviewGraphDataExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var deviceDsId = 56;  // Integer | The device-datasource ID you'd like to add an instance group for
            var deviceId = 56;  // Integer | 
            var dsigId = 56;  // Integer | 
            var ographId = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var format = format_example;  // String |  (optional) 

            try
            {
                // Get device instance group overview graph data
                GraphPlot result = apiInstance.getDeviceDatasourceInstanceGroupOverviewGraphData(deviceDsId, deviceId, dsigId, ographId, start, end, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDeviceDatasourceInstanceGroupOverviewGraphData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
$deviceId = 56; // Integer | 
$dsigId = 56; // Integer | 
$ographId = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$format = format_example; // String | 

try {
    $result = $api_instance->getDeviceDatasourceInstanceGroupOverviewGraphData($deviceDsId, $deviceId, $dsigId, $ographId, $start, $end, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDeviceDatasourceInstanceGroupOverviewGraphData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $deviceDsId = 56; # Integer | The device-datasource ID you'd like to add an instance group for
my $deviceId = 56; # Integer | 
my $dsigId = 56; # Integer | 
my $ographId = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $format = format_example; # String | 

eval { 
    my $result = $api_instance->getDeviceDatasourceInstanceGroupOverviewGraphData(deviceDsId => $deviceDsId, deviceId => $deviceId, dsigId => $dsigId, ographId => $ographId, start => $start, end => $end, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getDeviceDatasourceInstanceGroupOverviewGraphData: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get device instance group overview graph data api_response = api_instance.get_device_datasource_instance_group_overview_graph_data(deviceDsId, deviceId, dsigId, ographId, start=start, end=end, format=format) print(api_response) except ApiException as e: print("Exception when calling DataApi->getDeviceDatasourceInstanceGroupOverviewGraphData: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceGroupOverviewGraphDataParams()
// Get device instance group overview graph data
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDeviceDatasourceInstanceGroupOverviewGraphData(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceInstanceGroupOverviewGraphData: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceDsId*
Integer (int32)
The device-datasource ID you'd like to add an instance group for
Required
deviceId*
Integer (int32)
Required
dsigId*
Integer (int32)
Required
ographId*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
format
String

Responses

Status: 200 - Successfully retrieved the graph data

Status: default - Error


getDeviceInstanceGraphDataOnlyByInstanceId

get device instance data

get device instance data


/device/devicedatasourceinstances/{instanceId}/graphs/{graphId}/data

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/device/devicedatasourceinstances/{instanceId}/graphs/{graphId}/data?start=&end=&format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        Integer instanceId = 56; // Integer | 
        Integer graphId = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getDeviceInstanceGraphDataOnlyByInstanceId(instanceId, graphId, start, end, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDeviceInstanceGraphDataOnlyByInstanceId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        Integer instanceId = 56; // Integer | 
        Integer graphId = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getDeviceInstanceGraphDataOnlyByInstanceId(instanceId, graphId, start, end, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getDeviceInstanceGraphDataOnlyByInstanceId");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *instanceId = 56; // 
Integer *graphId = 56; // 
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *format = format_example; //  (optional)

DataApi *apiInstance = [[DataApi alloc] init];

// get device instance data
[apiInstance getDeviceInstanceGraphDataOnlyByInstanceIdWith:instanceId
    graphId:graphId
    start:start
    end:end
    format:format
              completionHandler: ^(GraphPlot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DataApi()
var instanceId = 56; // {{Integer}} 
var graphId = 56; // {{Integer}} 
var opts = { 
  'start': 789, // {{Long}} 
  'end': 789, // {{Long}} 
  'format': format_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeviceInstanceGraphDataOnlyByInstanceId(instanceId, graphId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceInstanceGraphDataOnlyByInstanceIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var instanceId = 56;  // Integer | 
            var graphId = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var format = format_example;  // String |  (optional) 

            try
            {
                // get device instance data
                GraphPlot result = apiInstance.getDeviceInstanceGraphDataOnlyByInstanceId(instanceId, graphId, start, end, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getDeviceInstanceGraphDataOnlyByInstanceId: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$instanceId = 56; // Integer | 
$graphId = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$format = format_example; // String | 

try {
    $result = $api_instance->getDeviceInstanceGraphDataOnlyByInstanceId($instanceId, $graphId, $start, $end, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getDeviceInstanceGraphDataOnlyByInstanceId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $instanceId = 56; # Integer | 
my $graphId = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $format = format_example; # String | 

eval { 
    my $result = $api_instance->getDeviceInstanceGraphDataOnlyByInstanceId(instanceId => $instanceId, graphId => $graphId, start => $start, end => $end, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getDeviceInstanceGraphDataOnlyByInstanceId: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get device instance data api_response = api_instance.get_device_instance_graph_data_only_by_instance_id(instanceId, graphId, start=start, end=end, format=format) print(api_response) except ApiException as e: print("Exception when calling DataApi->getDeviceInstanceGraphDataOnlyByInstanceId: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceInstanceGraphDataOnlyByInstanceIdParams()
// get device instance data
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDeviceInstanceGraphDataOnlyByInstanceId(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceInstanceGraphDataOnlyByInstanceId: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
instanceId*
Integer (int32)
Required
graphId*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
format
String

Responses

Status: 200 - Successful operation

Status: default - Error


getWebsiteCheckpointDataById

get data for a website checkpoint

get data for a website checkpoint


/website/websites/{srvId}/checkpoints/{checkId}/data

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/website/websites/{srvId}/checkpoints/{checkId}/data?period=&start=&end=&datapoints=&format=&aggregate="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        Integer srvId = 56; // Integer | 
        Integer checkId = 56; // Integer | 
        Double period = 1.2; // Double | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String datapoints = datapoints_example; // String | 
        String format = format_example; // String | 
        String aggregate = aggregate_example; // String | the aggregate option
        try {
            WebsiteCheckpointRawData result = apiInstance.getWebsiteCheckpointDataById(srvId, checkId, period, start, end, datapoints, format, aggregate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getWebsiteCheckpointDataById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        Integer srvId = 56; // Integer | 
        Integer checkId = 56; // Integer | 
        Double period = 1.2; // Double | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String datapoints = datapoints_example; // String | 
        String format = format_example; // String | 
        String aggregate = aggregate_example; // String | the aggregate option
        try {
            WebsiteCheckpointRawData result = apiInstance.getWebsiteCheckpointDataById(srvId, checkId, period, start, end, datapoints, format, aggregate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getWebsiteCheckpointDataById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *srvId = 56; // 
Integer *checkId = 56; // 
Double *period = 1.2; //  (optional)
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *datapoints = datapoints_example; //  (optional)
String *format = format_example; //  (optional)
String *aggregate = aggregate_example; // the aggregate option (optional)

DataApi *apiInstance = [[DataApi alloc] init];

// get data for a website checkpoint
[apiInstance getWebsiteCheckpointDataByIdWith:srvId
    checkId:checkId
    period:period
    start:start
    end:end
    datapoints:datapoints
    format:format
    aggregate:aggregate
              completionHandler: ^(WebsiteCheckpointRawData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DataApi()
var srvId = 56; // {{Integer}} 
var checkId = 56; // {{Integer}} 
var opts = { 
  'period': 1.2, // {{Double}} 
  'start': 789, // {{Long}} 
  'end': 789, // {{Long}} 
  'datapoints': datapoints_example, // {{String}} 
  'format': format_example, // {{String}} 
  'aggregate': aggregate_example // {{String}} the aggregate option
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWebsiteCheckpointDataById(srvId, checkId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWebsiteCheckpointDataByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var srvId = 56;  // Integer | 
            var checkId = 56;  // Integer | 
            var period = 1.2;  // Double |  (optional) 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var datapoints = datapoints_example;  // String |  (optional) 
            var format = format_example;  // String |  (optional) 
            var aggregate = aggregate_example;  // String | the aggregate option (optional) 

            try
            {
                // get data for a website checkpoint
                WebsiteCheckpointRawData result = apiInstance.getWebsiteCheckpointDataById(srvId, checkId, period, start, end, datapoints, format, aggregate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getWebsiteCheckpointDataById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$srvId = 56; // Integer | 
$checkId = 56; // Integer | 
$period = 1.2; // Double | 
$start = 789; // Long | 
$end = 789; // Long | 
$datapoints = datapoints_example; // String | 
$format = format_example; // String | 
$aggregate = aggregate_example; // String | the aggregate option

try {
    $result = $api_instance->getWebsiteCheckpointDataById($srvId, $checkId, $period, $start, $end, $datapoints, $format, $aggregate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getWebsiteCheckpointDataById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $srvId = 56; # Integer | 
my $checkId = 56; # Integer | 
my $period = 1.2; # Double | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $datapoints = datapoints_example; # String | 
my $format = format_example; # String | 
my $aggregate = aggregate_example; # String | the aggregate option

eval { 
    my $result = $api_instance->getWebsiteCheckpointDataById(srvId => $srvId, checkId => $checkId, period => $period, start => $start, end => $end, datapoints => $datapoints, format => $format, aggregate => $aggregate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getWebsiteCheckpointDataById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get data for a website checkpoint api_response = api_instance.get_website_checkpoint_data_by_id(srvId, checkId, period=period, start=start, end=end, datapoints=datapoints, format=format, aggregate=aggregate) print(api_response) except ApiException as e: print("Exception when calling DataApi->getWebsiteCheckpointDataById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsiteCheckpointDataByIdParams()
// get data for a website checkpoint
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetWebsiteCheckpointDataById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWebsiteCheckpointDataById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
srvId*
Integer (int32)
Required
checkId*
Integer (int32)
Required
Query parameters
Name Description
period
Double (double)
start
Long (int64)
end
Long (int64)
datapoints
String
format
String
aggregate
String
the aggregate option

Responses

Status: 200 - Successful operation

Status: default - Error


getWebsiteGraphData

Get website graph data

Retrieves the graph data for a website


/website/websites/{websiteId}/checkpoints/{checkpointId}/graphs/{graphName}/data

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/website/websites/{websiteId}/checkpoints/{checkpointId}/graphs/{graphName}/data?end=&start=&format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        Integer checkpointId = 56; // Integer | 
        Integer websiteId = 56; // Integer | 
        String graphName = graphName_example; // String | 
        Long end = 789; // Long | 
        Long start = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getWebsiteGraphData(checkpointId, websiteId, graphName, end, start, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getWebsiteGraphData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        Integer checkpointId = 56; // Integer | 
        Integer websiteId = 56; // Integer | 
        String graphName = graphName_example; // String | 
        Long end = 789; // Long | 
        Long start = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getWebsiteGraphData(checkpointId, websiteId, graphName, end, start, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getWebsiteGraphData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *checkpointId = 56; // 
Integer *websiteId = 56; // 
String *graphName = graphName_example; // 
Long *end = 789; //  (optional)
Long *start = 789; //  (optional)
String *format = format_example; //  (optional)

DataApi *apiInstance = [[DataApi alloc] init];

// Get website graph data
[apiInstance getWebsiteGraphDataWith:checkpointId
    websiteId:websiteId
    graphName:graphName
    end:end
    start:start
    format:format
              completionHandler: ^(GraphPlot output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DataApi()
var checkpointId = 56; // {{Integer}} 
var websiteId = 56; // {{Integer}} 
var graphName = graphName_example; // {{String}} 
var opts = { 
  'end': 789, // {{Long}} 
  'start': 789, // {{Long}} 
  'format': format_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWebsiteGraphData(checkpointId, websiteId, graphName, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWebsiteGraphDataExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var checkpointId = 56;  // Integer | 
            var websiteId = 56;  // Integer | 
            var graphName = graphName_example;  // String | 
            var end = 789;  // Long |  (optional) 
            var start = 789;  // Long |  (optional) 
            var format = format_example;  // String |  (optional) 

            try
            {
                // Get website graph data
                GraphPlot result = apiInstance.getWebsiteGraphData(checkpointId, websiteId, graphName, end, start, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getWebsiteGraphData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$checkpointId = 56; // Integer | 
$websiteId = 56; // Integer | 
$graphName = graphName_example; // String | 
$end = 789; // Long | 
$start = 789; // Long | 
$format = format_example; // String | 

try {
    $result = $api_instance->getWebsiteGraphData($checkpointId, $websiteId, $graphName, $end, $start, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getWebsiteGraphData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $checkpointId = 56; # Integer | 
my $websiteId = 56; # Integer | 
my $graphName = graphName_example; # String | 
my $end = 789; # Long | 
my $start = 789; # Long | 
my $format = format_example; # String | 

eval { 
    my $result = $api_instance->getWebsiteGraphData(checkpointId => $checkpointId, websiteId => $websiteId, graphName => $graphName, end => $end, start => $start, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getWebsiteGraphData: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Get website graph data api_response = api_instance.get_website_graph_data(checkpointId, websiteId, graphName, end=end, start=start, format=format) print(api_response) except ApiException as e: print("Exception when calling DataApi->getWebsiteGraphData: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsiteGraphDataParams()
// Get website graph data
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetWebsiteGraphData(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWebsiteGraphData: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
checkpointId*
Integer (int32)
Required
websiteId*
Integer (int32)
Required
graphName*
String
Required
Query parameters
Name Description
end
Long (int64)
start
Long (int64)
format
String

Responses

Status: 200 - Successfully retrieved website graph data

Status: default - Error


getWidgetDataById

get widget data (Based upon widget type the response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes)

get widget data (Based upon widget type the response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes)


/dashboard/widgets/{id}/data

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/dashboard/widgets/{id}/data?end=&format=&start="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DataApi;

import java.io.File;
import java.util.*;

public class DataApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DataApi apiInstance = new DataApi();
        Integer id = 56; // Integer | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        Long start = 789; // Long | 
        try {
            WidgetData result = apiInstance.getWidgetDataById(id, end, format, start);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getWidgetDataById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DataApi;

public class DataApiExample {

    public static void main(String[] args) {
        DataApi apiInstance = new DataApi();
        Integer id = 56; // Integer | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        Long start = 789; // Long | 
        try {
            WidgetData result = apiInstance.getWidgetDataById(id, end, format, start);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DataApi#getWidgetDataById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *id = 56; // 
Long *end = 789; //  (optional)
String *format = format_example; //  (optional)
Long *start = 789; //  (optional)

DataApi *apiInstance = [[DataApi alloc] init];

// get widget data (Based upon widget type the response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes)
[apiInstance getWidgetDataByIdWith:id
    end:end
    format:format
    start:start
              completionHandler: ^(WidgetData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DataApi()
var id = 56; // {{Integer}} 
var opts = { 
  'end': 789, // {{Long}} 
  'format': format_example, // {{String}} 
  'start': 789 // {{Long}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWidgetDataById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWidgetDataByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DataApi();
            var id = 56;  // Integer | 
            var end = 789;  // Long |  (optional) 
            var format = format_example;  // String |  (optional) 
            var start = 789;  // Long |  (optional) 

            try
            {
                // get widget data (Based upon widget type the response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes)
                WidgetData result = apiInstance.getWidgetDataById(id, end, format, start);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DataApi.getWidgetDataById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDataApi();
$id = 56; // Integer | 
$end = 789; // Long | 
$format = format_example; // String | 
$start = 789; // Long | 

try {
    $result = $api_instance->getWidgetDataById($id, $end, $format, $start);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DataApi->getWidgetDataById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DataApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DataApi->new();
my $id = 56; # Integer | 
my $end = 789; # Long | 
my $format = format_example; # String | 
my $start = 789; # Long | 

eval { 
    my $result = $api_instance->getWidgetDataById(id => $id, end => $end, format => $format, start => $start);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getWidgetDataById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get widget data (Based upon widget type the response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes) api_response = api_instance.get_widget_data_by_id(id, end=end, format=format, start=start) print(api_response) except ApiException as e: print("Exception when calling DataApi->getWidgetDataById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetWidgetDataByIdParams()
// get widget data (Based upon widget type the response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes)
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetWidgetDataById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWidgetDataById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
end
Long (int64)
format
String
start
Long (int64)

Responses

Status: 200 - Successful operation

Status: default - Error


DatasourceInstances

addDeviceDatasourceInstance

add device instance

add device instance


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourceInstancesApi;

import java.io.File;
import java.util.*;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        DeviceDataSourceInstance body = ; // DeviceDataSourceInstance | 
        try {
            DeviceDataSourceInstance result = apiInstance.addDeviceDatasourceInstance(deviceId, hdsId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#addDeviceDatasourceInstance");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DatasourceInstancesApi;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        DeviceDataSourceInstance body = ; // DeviceDataSourceInstance | 
        try {
            DeviceDataSourceInstance result = apiInstance.addDeviceDatasourceInstance(deviceId, hdsId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#addDeviceDatasourceInstance");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *deviceId = 56; // 
Integer *hdsId = 56; // The device-datasource ID
DeviceDataSourceInstance *body = ; // 

DatasourceInstancesApi *apiInstance = [[DatasourceInstancesApi alloc] init];

// add device instance
[apiInstance addDeviceDatasourceInstanceWith
    deviceId:deviceId
    hdsId:hdsId:body
              completionHandler: ^(DeviceDataSourceInstance output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DatasourceInstancesApi()
var deviceId = 56; // {{Integer}} 
var hdsId = 56; // {{Integer}} The device-datasource ID
var body = ; // {{DeviceDataSourceInstance}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDeviceDatasourceInstance(deviceIdhdsIdbody, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addDeviceDatasourceInstanceExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DatasourceInstancesApi();
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | The device-datasource ID
            var body = new DeviceDataSourceInstance(); // DeviceDataSourceInstance | 

            try
            {
                // add device instance
                DeviceDataSourceInstance result = apiInstance.addDeviceDatasourceInstance(deviceId, hdsId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.addDeviceDatasourceInstance: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDatasourceInstancesApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | The device-datasource ID
$body = ; // DeviceDataSourceInstance | 

try {
    $result = $api_instance->addDeviceDatasourceInstance($deviceId, $hdsId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->addDeviceDatasourceInstance: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DatasourceInstancesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DatasourceInstancesApi->new();
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | The device-datasource ID
my $body = WWW::SwaggerClient::Object::DeviceDataSourceInstance->new(); # DeviceDataSourceInstance | 

eval { 
    my $result = $api_instance->addDeviceDatasourceInstance(deviceId => $deviceId, hdsId => $hdsId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourceInstancesApi->addDeviceDatasourceInstance: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # add device instance api_response = api_instance.add_device_datasource_instance(deviceId, hdsId, body) print(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->addDeviceDatasourceInstance: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddDeviceDatasourceInstanceParams()
// add device instance
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddDeviceDatasourceInstance(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDeviceDatasourceInstance: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
The device-datasource ID
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successful operation

Status: default - Error


addDeviceDatasourceInstanceGroup

Add device datasource instance group

Add a new device datasource instance group


/device/devices/{deviceId}/devicedatasources/{deviceDsId}/groups

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
-H "Content-Type: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{deviceDsId}/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourceInstancesApi;

import java.io.File;
import java.util.*;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
        Integer deviceId = 56; // Integer | 
        DeviceDataSourceInstanceGroup body = ; // DeviceDataSourceInstanceGroup | 
        try {
            DeviceDataSourceInstanceGroup result = apiInstance.addDeviceDatasourceInstanceGroup(deviceDsId, deviceId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#addDeviceDatasourceInstanceGroup");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DatasourceInstancesApi;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
        Integer deviceId = 56; // Integer | 
        DeviceDataSourceInstanceGroup body = ; // DeviceDataSourceInstanceGroup | 
        try {
            DeviceDataSourceInstanceGroup result = apiInstance.addDeviceDatasourceInstanceGroup(deviceDsId, deviceId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#addDeviceDatasourceInstanceGroup");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *deviceDsId = 56; // The device-datasource ID you'd like to add an instance group for
Integer *deviceId = 56; // 
DeviceDataSourceInstanceGroup *body = ; // 

DatasourceInstancesApi *apiInstance = [[DatasourceInstancesApi alloc] init];

// Add device datasource instance group
[apiInstance addDeviceDatasourceInstanceGroupWith
    deviceDsId:deviceDsId
    deviceId:deviceId:body
              completionHandler: ^(DeviceDataSourceInstanceGroup output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DatasourceInstancesApi()
var deviceDsId = 56; // {{Integer}} The device-datasource ID you'd like to add an instance group for
var deviceId = 56; // {{Integer}} 
var body = ; // {{DeviceDataSourceInstanceGroup}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addDeviceDatasourceInstanceGroup(deviceDsIddeviceIdbody, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class addDeviceDatasourceInstanceGroupExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DatasourceInstancesApi();
            var deviceDsId = 56;  // Integer | The device-datasource ID you'd like to add an instance group for
            var deviceId = 56;  // Integer | 
            var body = new DeviceDataSourceInstanceGroup(); // DeviceDataSourceInstanceGroup | 

            try
            {
                // Add device datasource instance group
                DeviceDataSourceInstanceGroup result = apiInstance.addDeviceDatasourceInstanceGroup(deviceDsId, deviceId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.addDeviceDatasourceInstanceGroup: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDatasourceInstancesApi();
$deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
$deviceId = 56; // Integer | 
$body = ; // DeviceDataSourceInstanceGroup | 

try {
    $result = $api_instance->addDeviceDatasourceInstanceGroup($deviceDsId, $deviceId, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->addDeviceDatasourceInstanceGroup: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DatasourceInstancesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DatasourceInstancesApi->new();
my $deviceDsId = 56; # Integer | The device-datasource ID you'd like to add an instance group for
my $deviceId = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DeviceDataSourceInstanceGroup->new(); # DeviceDataSourceInstanceGroup | 

eval { 
    my $result = $api_instance->addDeviceDatasourceInstanceGroup(deviceDsId => $deviceDsId, deviceId => $deviceId, body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourceInstancesApi->addDeviceDatasourceInstanceGroup: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # Add device datasource instance group api_response = api_instance.add_device_datasource_instance_group(deviceDsId, deviceId, body) print(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->addDeviceDatasourceInstanceGroup: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewAddDeviceDatasourceInstanceGroupParams()
// Add device datasource instance group
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.AddDeviceDatasourceInstanceGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDeviceDatasourceInstanceGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceDsId*
Integer (int32)
The device-datasource ID you'd like to add an instance group for
Required
deviceId*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - Successfully added the device datasource instance group

Status: default - Error


collectDeviceConfigSourceConfig

collect a config for a device

collect a config for a device


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/config/configCollection

Usage and SDK Samples

curl -X POST\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/config/configCollection"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourceInstancesApi;

import java.io.File;
import java.util.*;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer instanceId = 56; // Integer | 
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        try {
            Object result = apiInstance.collectDeviceConfigSourceConfig(instanceId, deviceId, hdsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#collectDeviceConfigSourceConfig");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DatasourceInstancesApi;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer instanceId = 56; // Integer | 
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        try {
            Object result = apiInstance.collectDeviceConfigSourceConfig(instanceId, deviceId, hdsId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#collectDeviceConfigSourceConfig");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *instanceId = 56; // 
Integer *deviceId = 56; // 
Integer *hdsId = 56; // 

DatasourceInstancesApi *apiInstance = [[DatasourceInstancesApi alloc] init];

// collect a config for a device
[apiInstance collectDeviceConfigSourceConfigWith:instanceId
    deviceId:deviceId
    hdsId:hdsId
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DatasourceInstancesApi()
var instanceId = 56; // {{Integer}} 
var deviceId = 56; // {{Integer}} 
var hdsId = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.collectDeviceConfigSourceConfig(instanceId, deviceId, hdsId, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class collectDeviceConfigSourceConfigExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DatasourceInstancesApi();
            var instanceId = 56;  // Integer | 
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | 

            try
            {
                // collect a config for a device
                Object result = apiInstance.collectDeviceConfigSourceConfig(instanceId, deviceId, hdsId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.collectDeviceConfigSourceConfig: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDatasourceInstancesApi();
$instanceId = 56; // Integer | 
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | 

try {
    $result = $api_instance->collectDeviceConfigSourceConfig($instanceId, $deviceId, $hdsId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->collectDeviceConfigSourceConfig: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DatasourceInstancesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DatasourceInstancesApi->new();
my $instanceId = 56; # Integer | 
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | 

eval { 
    my $result = $api_instance->collectDeviceConfigSourceConfig(instanceId => $instanceId, deviceId => $deviceId, hdsId => $hdsId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourceInstancesApi->collectDeviceConfigSourceConfig: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # collect a config for a device api_response = api_instance.collect_device_config_source_config(instanceId, deviceId, hdsId) print(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->collectDeviceConfigSourceConfig: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewCollectDeviceConfigSourceConfigParams()
// collect a config for a device
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.CollectDeviceConfigSourceConfig(params) if err != nil { fmt.Printf("Exception when calling client.LM.CollectDeviceConfigSourceConfig: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
instanceId*
Integer (int32)
Required
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
Required

Responses

Status: 200 - Successful operation

Status: default - Error


deleteDeviceDatasourceInstanceById

delete a device instance

delete a device instance


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}

Usage and SDK Samples

curl -X DELETE\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourceInstancesApi;

import java.io.File;
import java.util.*;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteDeviceDatasourceInstanceById(deviceId, hdsId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#deleteDeviceDatasourceInstanceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DatasourceInstancesApi;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteDeviceDatasourceInstanceById(deviceId, hdsId, id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#deleteDeviceDatasourceInstanceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *deviceId = 56; // 
Integer *hdsId = 56; // The device-datasource ID
Integer *id = 56; // 

DatasourceInstancesApi *apiInstance = [[DatasourceInstancesApi alloc] init];

// delete a device instance
[apiInstance deleteDeviceDatasourceInstanceByIdWith:deviceId
    hdsId:hdsId
    id:id
              completionHandler: ^(Object output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DatasourceInstancesApi()
var deviceId = 56; // {{Integer}} 
var hdsId = 56; // {{Integer}} The device-datasource ID
var id = 56; // {{Integer}} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.deleteDeviceDatasourceInstanceById(deviceId, hdsId, id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteDeviceDatasourceInstanceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DatasourceInstancesApi();
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | The device-datasource ID
            var id = 56;  // Integer | 

            try
            {
                // delete a device instance
                Object result = apiInstance.deleteDeviceDatasourceInstanceById(deviceId, hdsId, id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.deleteDeviceDatasourceInstanceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDatasourceInstancesApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | The device-datasource ID
$id = 56; // Integer | 

try {
    $result = $api_instance->deleteDeviceDatasourceInstanceById($deviceId, $hdsId, $id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->deleteDeviceDatasourceInstanceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DatasourceInstancesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DatasourceInstancesApi->new();
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | The device-datasource ID
my $id = 56; # Integer | 

eval { 
    my $result = $api_instance->deleteDeviceDatasourceInstanceById(deviceId => $deviceId, hdsId => $hdsId, id => $id);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourceInstancesApi->deleteDeviceDatasourceInstanceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # delete a device instance api_response = api_instance.delete_device_datasource_instance_by_id(deviceId, hdsId, id) print(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->deleteDeviceDatasourceInstanceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDeviceDatasourceInstanceByIdParams()
// delete a device instance
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.DeleteDeviceDatasourceInstanceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteDeviceDatasourceInstanceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
The device-datasource ID
Required
id*
Integer (int32)
Required

Responses

Status: 200 - Successful operation

Status: default - Error


getDeviceConfigSourceConfigById

get a config for a device

get a config for a device


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/config/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/config/{id}?format=&startEpoch=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourceInstancesApi;

import java.io.File;
import java.util.*;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer instanceId = 56; // Integer | 
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        String id = id_example; // String | 
        String format = format_example; // String | 
        Long startEpoch = 789; // Long | 
        String fields = fields_example; // String | 
        try {
            DeviceDataSourceInstanceConfig result = apiInstance.getDeviceConfigSourceConfigById(instanceId, deviceId, hdsId, id, format, startEpoch, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceConfigSourceConfigById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DatasourceInstancesApi;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer instanceId = 56; // Integer | 
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        String id = id_example; // String | 
        String format = format_example; // String | 
        Long startEpoch = 789; // Long | 
        String fields = fields_example; // String | 
        try {
            DeviceDataSourceInstanceConfig result = apiInstance.getDeviceConfigSourceConfigById(instanceId, deviceId, hdsId, id, format, startEpoch, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceConfigSourceConfigById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *instanceId = 56; // 
Integer *deviceId = 56; // 
Integer *hdsId = 56; // 
String *id = id_example; // 
String *format = format_example; //  (optional)
Long *startEpoch = 789; //  (optional)
String *fields = fields_example; //  (optional)

DatasourceInstancesApi *apiInstance = [[DatasourceInstancesApi alloc] init];

// get a config for a device
[apiInstance getDeviceConfigSourceConfigByIdWith:instanceId
    deviceId:deviceId
    hdsId:hdsId
    id:id
    format:format
    startEpoch:startEpoch
    fields:fields
              completionHandler: ^(DeviceDataSourceInstanceConfig output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DatasourceInstancesApi()
var instanceId = 56; // {{Integer}} 
var deviceId = 56; // {{Integer}} 
var hdsId = 56; // {{Integer}} 
var id = id_example; // {{String}} 
var opts = { 
  'format': format_example, // {{String}} 
  'startEpoch': 789, // {{Long}} 
  'fields': fields_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeviceConfigSourceConfigById(instanceId, deviceId, hdsId, id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceConfigSourceConfigByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DatasourceInstancesApi();
            var instanceId = 56;  // Integer | 
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | 
            var id = id_example;  // String | 
            var format = format_example;  // String |  (optional) 
            var startEpoch = 789;  // Long |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get a config for a device
                DeviceDataSourceInstanceConfig result = apiInstance.getDeviceConfigSourceConfigById(instanceId, deviceId, hdsId, id, format, startEpoch, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.getDeviceConfigSourceConfigById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDatasourceInstancesApi();
$instanceId = 56; // Integer | 
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | 
$id = id_example; // String | 
$format = format_example; // String | 
$startEpoch = 789; // Long | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->getDeviceConfigSourceConfigById($instanceId, $deviceId, $hdsId, $id, $format, $startEpoch, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->getDeviceConfigSourceConfigById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DatasourceInstancesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DatasourceInstancesApi->new();
my $instanceId = 56; # Integer | 
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | 
my $id = id_example; # String | 
my $format = format_example; # String | 
my $startEpoch = 789; # Long | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->getDeviceConfigSourceConfigById(instanceId => $instanceId, deviceId => $deviceId, hdsId => $hdsId, id => $id, format => $format, startEpoch => $startEpoch, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourceInstancesApi->getDeviceConfigSourceConfigById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get a config for a device api_response = api_instance.get_device_config_source_config_by_id(instanceId, deviceId, hdsId, id, format=format, startEpoch=startEpoch, fields=fields) print(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->getDeviceConfigSourceConfigById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceConfigSourceConfigByIdParams()
// get a config for a device
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDeviceConfigSourceConfigById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceConfigSourceConfigById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
instanceId*
Integer (int32)
Required
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
Required
id*
String
Required
Query parameters
Name Description
format
String
startEpoch
Long (int64)
fields
String

Responses

Status: 200 - Successful operation

Status: default - Error


getDeviceConfigSourceConfigList

get detailed config information for the instance

get detailed config information for the instance


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/config

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/config?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourceInstancesApi;

import java.io.File;
import java.util.*;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer instanceId = 56; // Integer | 
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceDatasourceInstanceConfigPaginationResponse result = apiInstance.getDeviceConfigSourceConfigList(instanceId, deviceId, hdsId, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceConfigSourceConfigList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DatasourceInstancesApi;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer instanceId = 56; // Integer | 
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceDatasourceInstanceConfigPaginationResponse result = apiInstance.getDeviceConfigSourceConfigList(instanceId, deviceId, hdsId, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceConfigSourceConfigList");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *instanceId = 56; // 
Integer *deviceId = 56; // 
Integer *hdsId = 56; // 
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional) (default to 50)
Integer *offset = 56; //  (optional) (default to 0)
String *filter = filter_example; //  (optional)

DatasourceInstancesApi *apiInstance = [[DatasourceInstancesApi alloc] init];

// get detailed config information for the instance
[apiInstance getDeviceConfigSourceConfigListWith:instanceId
    deviceId:deviceId
    hdsId:hdsId
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceDatasourceInstanceConfigPaginationResponse output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DatasourceInstancesApi()
var instanceId = 56; // {{Integer}} 
var deviceId = 56; // {{Integer}} 
var hdsId = 56; // {{Integer}} 
var opts = { 
  'fields': fields_example, // {{String}} 
  'size': 56, // {{Integer}} 
  'offset': 56, // {{Integer}} 
  'filter': filter_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeviceConfigSourceConfigList(instanceId, deviceId, hdsId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceConfigSourceConfigListExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DatasourceInstancesApi();
            var instanceId = 56;  // Integer | 
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional)  (default to 50)
            var offset = 56;  // Integer |  (optional)  (default to 0)
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get detailed config information for the instance
                DeviceDatasourceInstanceConfigPaginationResponse result = apiInstance.getDeviceConfigSourceConfigList(instanceId, deviceId, hdsId, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.getDeviceConfigSourceConfigList: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDatasourceInstancesApi();
$instanceId = 56; // Integer | 
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getDeviceConfigSourceConfigList($instanceId, $deviceId, $hdsId, $fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->getDeviceConfigSourceConfigList: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DatasourceInstancesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DatasourceInstancesApi->new();
my $instanceId = 56; # Integer | 
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | 
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

eval { 
    my $result = $api_instance->getDeviceConfigSourceConfigList(instanceId => $instanceId, deviceId => $deviceId, hdsId => $hdsId, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourceInstancesApi->getDeviceConfigSourceConfigList: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get detailed config information for the instance api_response = api_instance.get_device_config_source_config_list(instanceId, deviceId, hdsId, fields=fields, size=size, offset=offset, filter=filter) print(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->getDeviceConfigSourceConfigList: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceConfigSourceConfigListParams()
// get detailed config information for the instance
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDeviceConfigSourceConfigList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceConfigSourceConfigList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
instanceId*
Integer (int32)
Required
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
Required
Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - Successful operation

Status: default - Error


getDeviceDatasourceInstanceById

get device instance

get device instance


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourceInstancesApi;

import java.io.File;
import java.util.*;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            DeviceDataSourceInstance result = apiInstance.getDeviceDatasourceInstanceById(deviceId, hdsId, id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceDatasourceInstanceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DatasourceInstancesApi;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            DeviceDataSourceInstance result = apiInstance.getDeviceDatasourceInstanceById(deviceId, hdsId, id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceDatasourceInstanceById");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *deviceId = 56; // 
Integer *hdsId = 56; // The device-datasource ID
Integer *id = 56; // 
String *fields = fields_example; //  (optional)

DatasourceInstancesApi *apiInstance = [[DatasourceInstancesApi alloc] init];

// get device instance
[apiInstance getDeviceDatasourceInstanceByIdWith:deviceId
    hdsId:hdsId
    id:id
    fields:fields
              completionHandler: ^(DeviceDataSourceInstance output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DatasourceInstancesApi()
var deviceId = 56; // {{Integer}} 
var hdsId = 56; // {{Integer}} The device-datasource ID
var id = 56; // {{Integer}} 
var opts = { 
  'fields': fields_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeviceDatasourceInstanceById(deviceId, hdsId, id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceDatasourceInstanceByIdExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DatasourceInstancesApi();
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | The device-datasource ID
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get device instance
                DeviceDataSourceInstance result = apiInstance.getDeviceDatasourceInstanceById(deviceId, hdsId, id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.getDeviceDatasourceInstanceById: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDatasourceInstancesApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | The device-datasource ID
$id = 56; // Integer | 
$fields = fields_example; // String | 

try {
    $result = $api_instance->getDeviceDatasourceInstanceById($deviceId, $hdsId, $id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DatasourceInstancesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DatasourceInstancesApi->new();
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | The device-datasource ID
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

eval { 
    my $result = $api_instance->getDeviceDatasourceInstanceById(deviceId => $deviceId, hdsId => $hdsId, id => $id, fields => $fields);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceById: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get device instance api_response = api_instance.get_device_datasource_instance_by_id(deviceId, hdsId, id, fields=fields) print(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceById: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceByIdParams()
// get device instance
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDeviceDatasourceInstanceById(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceInstanceById: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
The device-datasource ID
Required
id*
Integer (int32)
Required
Query parameters
Name Description
fields
String

Responses

Status: 200 - Successful operation

Status: default - Error


getDeviceDatasourceInstanceData

get device instance data

get device instance data


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}/data

Usage and SDK Samples

curl -X GET\
-H "Authorization: [[apiKey]]"\
-H "Accept: application/json"\
"/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}/data?period=&start=&end=&datapoints=&format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourceInstancesApi;

import java.io.File;
import java.util.*;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();

        // Configure API key authorization: LMv1
        ApiKeyAuth LMv1 = (ApiKeyAuth) defaultClient.getAuthentication("LMv1");
        LMv1.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //LMv1.setApiKeyPrefix("Token");

        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        Integer id = 56; // Integer | 
        Double period = 1.2; // Double | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String datapoints = datapoints_example; // String | 
        String format = format_example; // String | 
        try {
            DeviceDataSourceInstanceData result = apiInstance.getDeviceDatasourceInstanceData(deviceId, hdsId, id, period, start, end, datapoints, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceDatasourceInstanceData");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DatasourceInstancesApi;

public class DatasourceInstancesApiExample {

    public static void main(String[] args) {
        DatasourceInstancesApi apiInstance = new DatasourceInstancesApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        Integer id = 56; // Integer | 
        Double period = 1.2; // Double | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String datapoints = datapoints_example; // String | 
        String format = format_example; // String | 
        try {
            DeviceDataSourceInstanceData result = apiInstance.getDeviceDatasourceInstanceData(deviceId, hdsId, id, period, start, end, datapoints, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceDatasourceInstanceData");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: LMv1)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
Integer *deviceId = 56; // 
Integer *hdsId = 56; // The device-datasource ID
Integer *id = 56; // 
Double *period = 1.2; //  (optional)
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *datapoints = datapoints_example; //  (optional)
String *format = format_example; //  (optional)

DatasourceInstancesApi *apiInstance = [[DatasourceInstancesApi alloc] init];

// get device instance data
[apiInstance getDeviceDatasourceInstanceDataWith:deviceId
    hdsId:hdsId
    id:id
    period:period
    start:start
    end:end
    datapoints:datapoints
    format:format
              completionHandler: ^(DeviceDataSourceInstanceData output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var LogicMonitorRestApi = require('logic_monitor_rest_api');
var defaultClient = LogicMonitorRestApi.ApiClient.instance;

// Configure API key authorization: LMv1
var LMv1 = defaultClient.authentications['LMv1'];
LMv1.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//LMv1.apiKeyPrefix['Authorization'] = "Token"

var api = new LogicMonitorRestApi.DatasourceInstancesApi()
var deviceId = 56; // {{Integer}} 
var hdsId = 56; // {{Integer}} The device-datasource ID
var id = 56; // {{Integer}} 
var opts = { 
  'period': 1.2, // {{Double}} 
  'start': 789, // {{Long}} 
  'end': 789, // {{Long}} 
  'datapoints': datapoints_example, // {{String}} 
  'format': format_example // {{String}} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getDeviceDatasourceInstanceData(deviceId, hdsId, id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceDatasourceInstanceDataExample
    {
        public void main()
        {

            // Configure API key authorization: LMv1
            Configuration.Default.ApiKey.Add("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("Authorization", "Bearer");

            var apiInstance = new DatasourceInstancesApi();
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | The device-datasource ID
            var id = 56;  // Integer | 
            var period = 1.2;  // Double |  (optional) 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var datapoints = datapoints_example;  // String |  (optional) 
            var format = format_example;  // String |  (optional) 

            try
            {
                // get device instance data
                DeviceDataSourceInstanceData result = apiInstance.getDeviceDatasourceInstanceData(deviceId, hdsId, id, period, start, end, datapoints, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.getDeviceDatasourceInstanceData: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: LMv1
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$api_instance = new Swagger\Client\ApiDatasourceInstancesApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | The device-datasource ID
$id = 56; // Integer | 
$period = 1.2; // Double | 
$start = 789; // Long | 
$end = 789; // Long | 
$datapoints = datapoints_example; // String | 
$format = format_example; // String | 

try {
    $result = $api_instance->getDeviceDatasourceInstanceData($deviceId, $hdsId, $id, $period, $start, $end, $datapoints, $format);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceData: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DatasourceInstancesApi;

# Configure API key authorization: LMv1
$WWW::SwaggerClient::Configuration::api_key->{'Authorization'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'Authorization'} = "Bearer";

my $api_instance = WWW::SwaggerClient::DatasourceInstancesApi->new();
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | The device-datasource ID
my $id = 56; # Integer | 
my $period = 1.2; # Double | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $datapoints = datapoints_example; # String | 
my $format = format_example; # String | 

eval { 
    my $result = $api_instance->getDeviceDatasourceInstanceData(deviceId => $deviceId, hdsId => $hdsId, id => $id, period => $period, start => $start, end => $end, datapoints => $datapoints, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceData: $@\n";
}
from __future__ import print_function
import time
import getpass
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


configuration = logicmonitor_sdk.Configuration()
# Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
# Note: The below is provided for illustration purposes only.
# Configure API key authorization: LMv1
configuration.company = 'YOUR_COMPANY'
configuration.access_id = getpass.getpass("Enter your AccessId: ")
configuration.access_key = getpass.getpass("Enter your AccessKey: ")

# Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
# configuration.auth_type = "Bearer"
# configuration.bearer_token = getpass.getpass("Enter your Bearer Token: ")

# create an instance of the API class test2
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))

    
try: # get device instance data api_response = api_instance.get_device_datasource_instance_data(deviceId, hdsId, id, period=period, start=start, end=end, datapoints=datapoints, format=format) print(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceData: %s\n" % e)
package main

import (
    "fmt"
    "strings"
    "syscall"
    "golang.org/x/term"
    "github.com/logicmonitor/lm-sdk-go/client"
    "github.com/logicmonitor/lm-sdk-go/client/lm"
    "github.com/logicmonitor/lm-sdk-go/models"
)
func main() {
// Configure API key authorization: LMv1
domain := "YOUR_COMPANY.logicmonitor.com"
// Account Info: LogicMonitor recommends to NEVER hardcode the credentials. Instead, retrieve the values from a secure storage.
// Note: The below is provided for illustration purposes only.

// Configure API key authorization: LMv1
fmt.Println("\nEnter AccessID: ")
byteAccessID, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessID := strings.TrimSpace(string(byteAccessID))

fmt.Println("\nEnter AccessKey: ")
byteAccessKey, err := term.ReadPassword(int(syscall.Stdin))
if err != nil {
        return
}
accessKey := strings.TrimSpace(string(byteAccessKey))

// Configure API key authorization: Bearer configuration. In case of bearer token remove the above access_key and access_id assignments as they are LMv1 specific
// fmt.Println("\nEnter Bearer Token: ")
// byteBearer, err := term.ReadPassword(int(syscall.Stdin))
// if err != nil {
//        return
// }
// bearer := strings.TrimSpace(string(byteBearer))


config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)
// config.SetBearerToken(&bearer)
// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceDataParams()
// get device instance data
// This method returns the all fields irrespective of 'fields' param. resp, err := client.LM.GetDeviceDatasourceInstanceData(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceInstanceData: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
The device-datasource ID
Required
id*
Integer (int32)
Required
Query parameters
Name Description
period
Double (double)
start
Long (int64)
end
Long (int64)
datapoints
String
format
String

Responses

Status: 200 - Successful operation

Status: default - Error


getDeviceDatasourceInstanceGraphData

get device instance graph data

get device instance graph data


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}/graphs/{graphId}/data