LogicMonitor REST API

APITokens

addApiTokenByAdminId

add api tokens for a user


/setting/admins/{adminId}/apitokens

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/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) (default to API Token)

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

// add api tokens for a user
[apiInstance addApiTokenByAdminIdWith:adminId
    body: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(adminId, body, 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)  (default to API Token)

            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\Api\APITokensApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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, ) pprint(api_response) except ApiException as e: print("Exception when calling APITokensApi->addApiTokenByAdminId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddAPITokenByAdminIDParams()
    
// add api tokens for a user 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 - successful operation

Status: default - Error


getApiTokenList

get a list of api tokens across users


/setting/admins/apitokens

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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)
Integer *offset = 56; //  (optional)
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) 
            var offset = 56;  // Integer |  (optional) 
            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\Api\APITokensApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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(, , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling APITokensApi->getApiTokenList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAPITokenListParams()
    
// get a list of api tokens across users 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 - successful operation

Status: default - Error


getApiTokenListByAdminId

get api tokens for a user


/setting/admins/{adminId}/apitokens

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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)
Integer *offset = 56; //  (optional)
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) 
            var offset = 56;  // Integer |  (optional) 
            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\Api\APITokensApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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, , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling APITokensApi->getApiTokenListByAdminId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAPITokenListByAdminIDParams()
    
// get api tokens for a user 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 - successful operation

Status: default - Error


AlertRules

addAlertRule

add alert rule


/setting/alert/rules

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/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\Api\AlertRulesApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add alert rule api_response = api_instance.add_alert_rule(body) pprint(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->addAlertRule: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddAlertRuleParams()
    
// add alert rule 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


/setting/alert/rules/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/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\Api\AlertRulesApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete alert rule api_response = api_instance.delete_alert_rule_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->deleteAlertRuleById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteAlertRuleByIDParams()
    
// delete alert rule 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


/setting/alert/rules/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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\Api\AlertRulesApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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, ) pprint(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->getAlertRuleById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAlertRuleByIDParams()
    
// get alert rule by id 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


/setting/alert/rules

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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)
Integer *offset = 56; //  (optional)
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) 
            var offset = 56;  // Integer |  (optional) 
            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\Api\AlertRulesApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get alert rule list api_response = api_instance.get_alert_rule_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->getAlertRuleList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAlertRuleListParams()
    
// get alert rule list 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


/setting/alert/rules/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/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
    body: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(id, body, 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\Api\AlertRulesApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update alert rule api_response = api_instance.patch_alert_rule_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->patchAlertRuleById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchAlertRuleByIDParams()
    
// update alert rule 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


/setting/alert/rules/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/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
    body: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(id, body, 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\Api\AlertRulesApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update alert rule api_response = api_instance.update_alert_rule_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling AlertRulesApi->updateAlertRuleById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateAlertRuleByIDParams()
    
// update alert rule 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

ack alert by id


/alert/alerts/{id}/ack

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/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];

// ack 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(body, id, 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
            {
                // ack 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\Api\AlertsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # ack alert by id api_response = api_instance.ack_alert_by_id(body, id) pprint(api_response) except ApiException as e: print("Exception when calling AlertsApi->ackAlertById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAckAlertByIDParams()
    
// ack alert by id 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 - successful operation

Status: default - Error


addAlertNoteById

add alert note


/alert/alerts/{id}/note

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/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(body, id, 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\Api\AlertsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add alert note api_response = api_instance.add_alert_note_by_id(body, id) pprint(api_response) except ApiException as e: print("Exception when calling AlertsApi->addAlertNoteById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddAlertNoteByIDParams()
    
// add alert note 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 - successful operation

Status: default - Error


getAlertById

get alert


/alert/alerts/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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) (default to false)
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)  (default to false)
            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\Api\AlertsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get alert api_response = api_instance.get_alert_by_id(id, , , ) pprint(api_response) except ApiException as e: print("Exception when calling AlertsApi->getAlertById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAlertByIDParams()
    
// get alert 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 - successful operation

Status: default - Error


getAlertList

get alert list


/alert/alerts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/alert/alerts?customColumns=&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 customColumns = customColumns_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertPaginationResponse result = apiInstance.getAlertList(customColumns, 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 customColumns = customColumns_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertPaginationResponse result = apiInstance.getAlertList(customColumns, 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 *customColumns = customColumns_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get alert list
[apiInstance getAlertListWith:customColumns
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(AlertPaginationResponse 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 = { 
  'customColumns': customColumns_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.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 customColumns = customColumns_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get alert list
                AlertPaginationResponse result = apiInstance.getAlertList(customColumns, 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\Api\AlertsApi();
$customColumns = customColumns_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getAlertList($customColumns, $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 $customColumns = customColumns_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->getAlertList(customColumns => $customColumns, 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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get alert list api_response = api_instance.get_alert_list(, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling AlertsApi->getAlertList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAlertListParams()
    
// get alert list 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
customColumns
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


ApiPerfStats

getExternalApiStats

get external api stats info


/apiStats/externalApis

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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\Api\ApiPerfStatsApi();

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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
try:
    # get external api stats info
    api_response = api_instance.get_external_api_stats()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ApiPerfStatsApi->getExternalApiStats: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetExternalApiStatsParams()
// get external api stats info
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


/setting/functions

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/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\Api\AppliesToFunctionsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add applies to function api_response = api_instance.add_applies_to_function() pprint(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->addAppliesToFunction: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddAppliesToFunctionParams()
    
// add applies to function 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 - successful operation

Status: default - Error


getAppliesToFunctionById

get applies to function


/setting/functions/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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
[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
                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\Api\AppliesToFunctionsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get applies to function api_response = api_instance.get_applies_to_function_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->getAppliesToFunctionById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAppliesToFunctionByIDParams()
    
// get applies to function 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 - successful operation

Status: default - Error


getAppliesToFunctionList

get applies to function list


/setting/functions

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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)
Integer *offset = 56; //  (optional)
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) 
            var offset = 56;  // Integer |  (optional) 
            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\Api\AppliesToFunctionsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get applies to function list api_response = api_instance.get_applies_to_function_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->getAppliesToFunctionList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAppliesToFunctionListParams()
    
// get applies to function list 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 - successful operation

Status: default - Error


patchAppliesToFunction

update applies to function


/setting/functions/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/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) (default to false)

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)  (default to false)

            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\Api\AppliesToFunctionsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update applies to function api_response = api_instance.patch_applies_to_function(id, , , ) pprint(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->patchAppliesToFunction: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchAppliesToFunctionParams()
    
// update applies to function 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 - successful operation

Status: default - Error


updateAppliesToFunction

update applies to function


/setting/functions/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/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) (default to false)

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)  (default to false)

            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\Api\AppliesToFunctionsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update applies to function api_response = api_instance.update_applies_to_function(id, , , ) pprint(api_response) except ApiException as e: print("Exception when calling AppliesToFunctionsApi->updateAppliesToFunction: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateAppliesToFunctionParams()
    
// update applies to function 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 - successful operation

Status: default - Error


AuditLogs

getAuditLogList

Get audit logs


/setting/accesslogs

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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)
Integer *offset = 56; //  (optional)
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) 
            var offset = 56;  // Integer |  (optional) 
            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\Api\AuditLogsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # Get audit logs api_response = api_instance.get_audit_log_list(, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling AuditLogsApi->getAuditLogList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAuditLogListParams()
    
// Get audit logs 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 - successful operation

Status: default - Error


CollectorGroups

addCollectorGroup

add collector group


/setting/collector/groups

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/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\Api\CollectorGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add collector group api_response = api_instance.add_collector_group(body) pprint(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->addCollectorGroup: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddCollectorGroupParams()
    
// add collector group 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 - successful operation

Status: default - Error


deleteCollectorGroupById

delete collector group


/setting/collector/groups/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/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\Api\CollectorGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete collector group api_response = api_instance.delete_collector_group_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->deleteCollectorGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteCollectorGroupByIDParams()
    
// delete collector group 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 - successful operation

Status: default - Error


getCollectorGroupById

get collector group


/setting/collector/groups/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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\Api\CollectorGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get collector group api_response = api_instance.get_collector_group_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->getCollectorGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorGroupByIDParams()
    
// get collector group 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 - successful operation

Status: default - Error


getCollectorGroupList

get collector group list


/setting/collector/groups

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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)
Integer *offset = 56; //  (optional)
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) 
            var offset = 56;  // Integer |  (optional) 
            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\Api\CollectorGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get collector group list api_response = api_instance.get_collector_group_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->getCollectorGroupList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorGroupListParams()
    
// get collector group list 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 - successful operation

Status: default - Error


patchCollectorGroupById

update collector group


/setting/collector/groups/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/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) (default to false)
Boolean *forceUpdateFailedOverDevices = true; //  (optional) (default to false)
String *opType = opType_example; //  (optional) (default to refresh)

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

// update collector group
[apiInstance patchCollectorGroupByIdWith:id
    body: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(id, body, 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)  (default to false)
            var forceUpdateFailedOverDevices = true;  // Boolean |  (optional)  (default to false)
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            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\Api\CollectorGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update collector group api_response = api_instance.patch_collector_group_by_id(id, body, , , ) pprint(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->patchCollectorGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchCollectorGroupByIDParams()
    
// update collector group 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 - successful operation

Status: default - Error


updateCollectorGroupById

update collector group


/setting/collector/groups/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/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) (default to false)
Boolean *forceUpdateFailedOverDevices = true; //  (optional) (default to false)
String *opType = opType_example; //  (optional) (default to refresh)

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

// update collector group
[apiInstance updateCollectorGroupByIdWith:id
    body: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(id, body, 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)  (default to false)
            var forceUpdateFailedOverDevices = true;  // Boolean |  (optional)  (default to false)
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            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\Api\CollectorGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update collector group api_response = api_instance.update_collector_group_by_id(id, body, , , ) pprint(api_response) except ApiException as e: print("Exception when calling CollectorGroupsApi->updateCollectorGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateCollectorGroupByIDParams()
    
// update collector group 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 - successful operation

Status: default - Error


CollectorVersions

getCollectorVersionList

get collector version list


/setting/collector/collectors/versions

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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)
Integer *offset = 56; //  (optional)
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) 
            var offset = 56;  // Integer |  (optional) 
            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\Api\CollectorVersionsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get collector version list api_response = api_instance.get_collector_version_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling CollectorVersionsApi->getCollectorVersionList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorVersionListParams()
    
// get collector version list 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


/setting/collector/collectors/{id}/ackdown

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/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
    body: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(id, body, 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\Api\CollectorsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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) pprint(api_response) except ApiException as e: print("Exception when calling CollectorsApi->ackCollectorDownAlertById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAckCollectorDownAlertByIDParams()
    
// ack collector down alert 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


/setting/collector/collectors

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/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\Api\CollectorsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add collector api_response = api_instance.add_collector(body) pprint(api_response) except ApiException as e: print("Exception when calling CollectorsApi->addCollector: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddCollectorParams()
    
// add collector 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


/setting/collector/collectors/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/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\Api\CollectorsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete collector api_response = api_instance.delete_collector_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling CollectorsApi->deleteCollectorById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteCollectorByIDParams()
    
// delete collector 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


getCollectorByHostName

get collector id for HostName


/setting/collector/collectors/getCollectorByHostName

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/collector/collectors/getCollectorByHostName"
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 {
            Response result = apiInstance.getCollectorByHostName(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#getCollectorByHostName");
            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 {
            Response result = apiInstance.getCollectorByHostName(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#getCollectorByHostName");
            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];

// get collector id for HostName
[apiInstance getCollectorByHostNameWith:body
              completionHandler: ^(Response 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.getCollectorByHostName(body, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getCollectorByHostNameExample
    {
        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
            {
                // get collector id for HostName
                Response result = apiInstance.getCollectorByHostName(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorsApi.getCollectorByHostName: " + 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\Api\CollectorsApi();
$body = ; // Collector | 

try {
    $result = $api_instance->getCollectorByHostName($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorsApi->getCollectorByHostName: ', $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->getCollectorByHostName(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorsApi->getCollectorByHostName: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get collector id for HostName api_response = api_instance.get_collector_by_host_name(body) pprint(api_response) except ApiException as e: print("Exception when calling CollectorsApi->getCollectorByHostName: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorByHostNameParams()
    
// get collector id for HostName resp, err := client.LM.GetCollectorByHostName(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetCollectorByHostName: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


getCollectorById

get collector


/setting/collector/collectors/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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\Api\CollectorsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get collector api_response = api_instance.get_collector_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling CollectorsApi->getCollectorById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorByIDParams()
    
// get collector 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


/setting/collector/collectors/{collectorId}/installers/{osAndArch}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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 {
            File 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 {
            File 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) (default to true)
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) (default to medium)
Boolean *useEA = true; // If true, the latest EA Collector version will be used. Defaults to false (optional) (default to false)

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

// get collector installer
[apiInstance getCollectorInstallerWith:collectorId
    osAndArch:osAndArch
    collectorVersion:collectorVersion
    token:token
    monitorOthers:monitorOthers
    collectorSize:collectorSize
    useEA:useEA
              completionHandler: ^(File 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)  (default to true)
            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)  (default to medium)
            var useEA = true;  // Boolean | If true, the latest EA Collector version will be used. Defaults to false (optional)  (default to false)

            try
            {
                // get collector installer
                File 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\Api\CollectorsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get collector installer api_response = api_instance.get_collector_installer(collectorId, osAndArch, , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling CollectorsApi->getCollectorInstaller: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorInstallerParams()
    
// get collector installer 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


/setting/collector/collectors

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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)
Integer *offset = 56; //  (optional)
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) 
            var offset = 56;  // Integer |  (optional) 
            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\Api\CollectorsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get collector list api_response = api_instance.get_collector_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling CollectorsApi->getCollectorList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetCollectorListParams()
    
// get collector list 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


/setting/collector/collectors/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/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) (default to false)
Boolean *forceUpdateFailedOverDevices = true; //  (optional) (default to false)
String *opType = opType_example; //  (optional) (default to refresh)

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

// update collector
[apiInstance patchCollectorByIdWith:id
    body: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(id, body, 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)  (default to false)
            var forceUpdateFailedOverDevices = true;  // Boolean |  (optional)  (default to false)
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            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\Api\CollectorsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update collector api_response = api_instance.patch_collector_by_id(id, body, , , ) pprint(api_response) except ApiException as e: print("Exception when calling CollectorsApi->patchCollectorById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchCollectorByIDParams()
    
// update collector 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


/setting/collector/collectors/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/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) (default to false)
Boolean *forceUpdateFailedOverDevices = true; //  (optional) (default to false)
String *opType = opType_example; //  (optional) (default to refresh)

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

// update collector
[apiInstance updateCollectorByIdWith:id
    body: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(id, body, 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)  (default to false)
            var forceUpdateFailedOverDevices = true;  // Boolean |  (optional)  (default to false)
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            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\Api\CollectorsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update collector api_response = api_instance.update_collector_by_id(id, body, , , ) pprint(api_response) except ApiException as e: print("Exception when calling CollectorsApi->updateCollectorById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateCollectorByIDParams()
    
// update collector 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


validateCollectorConfig

validate collector configuration


/setting/collector/collectors/lmotel/validateconfig

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/collector/collectors/lmotel/validateconfig"
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 {
            Response result = apiInstance.validateCollectorConfig(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#validateCollectorConfig");
            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 {
            Response result = apiInstance.validateCollectorConfig(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CollectorsApi#validateCollectorConfig");
            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 = ; //  (optional)

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

// validate collector configuration
[apiInstance validateCollectorConfigWith:body
              completionHandler: ^(Response 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 = { 
  'body':  // {Collector} 
};

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

namespace Example
{
    public class validateCollectorConfigExample
    {
        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 |  (optional) 

            try
            {
                // validate collector configuration
                Response result = apiInstance.validateCollectorConfig(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling CollectorsApi.validateCollectorConfig: " + 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\Api\CollectorsApi();
$body = ; // Collector | 

try {
    $result = $api_instance->validateCollectorConfig($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CollectorsApi->validateCollectorConfig: ', $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->validateCollectorConfig(body => $body);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling CollectorsApi->validateCollectorConfig: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # validate collector configuration api_response = api_instance.validate_collector_config() pprint(api_response) except ApiException as e: print("Exception when calling CollectorsApi->validateCollectorConfig: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewValidateCollectorConfigParams()
    
// validate collector configuration resp, err := client.LM.ValidateCollectorConfig(params) if err != nil { fmt.Printf("Exception when calling client.LM.ValidateCollectorConfig: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - successful operation

Status: default - Error


ConfigSources

addConfigsourceAuditVersion

add audit version


/setting/configsources/{id}/audit

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/configsources/{id}/audit"
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 | 
        Audit body = ; // Audit | 
        try {
            ConfigSource result = apiInstance.addConfigsourceAuditVersion(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#addConfigsourceAuditVersion");
            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 | 
        Audit body = ; // Audit | 
        try {
            ConfigSource result = apiInstance.addConfigsourceAuditVersion(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ConfigSourcesApi#addConfigsourceAuditVersion");
            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; // 
Audit *body = ; //  (optional)

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

// add audit version
[apiInstance addConfigsourceAuditVersionWith:id
    body: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 id = 56; // {Integer} 

var opts = { 
  'body':  // {Audit} 
};

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

namespace Example
{
    public class addConfigsourceAuditVersionExample
    {
        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 Audit(); // Audit |  (optional) 

            try
            {
                // add audit version
                ConfigSource result = apiInstance.addConfigsourceAuditVersion(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ConfigSourcesApi.addConfigsourceAuditVersion: " + 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\Api\ConfigSourcesApi();
$id = 56; // Integer | 
$body = ; // Audit | 

try {
    $result = $api_instance->addConfigsourceAuditVersion($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ConfigSourcesApi->addConfigsourceAuditVersion: ', $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::Audit->new(); # Audit | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add audit version api_response = api_instance.add_configsource_audit_version(id, ) pprint(api_response) except ApiException as e: print("Exception when calling ConfigSourcesApi->addConfigsourceAuditVersion: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddConfigsourceAuditVersionParams()
    
// add audit version resp, err := client.LM.AddConfigsourceAuditVersion(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddConfigsourceAuditVersion: %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


DashboardGroups

addDashboardGroup

add dashboard group


/dashboard/groups

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/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\Api\DashboardGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add dashboard group api_response = api_instance.add_dashboard_group(body) pprint(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->addDashboardGroup: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddDashboardGroupParams()
    
// add dashboard group 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


deleteDashboardGroupById

delete dashboard group


/dashboard/groups/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/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) (default to false)

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)  (default to false)

            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\Api\DashboardGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete dashboard group api_response = api_instance.delete_dashboard_group_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->deleteDashboardGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDashboardGroupByIDParams()
    
// delete dashboard group 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 - OK

Status: default - Error


getDashboardGroupById

get dashboard group


/dashboard/groups/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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) (default to false)
String *format = format_example; //  (optional) (default to json)
String *fields = fields_example; //  (optional)

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

// get dashboard group
[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)  (default to false)
            var format = format_example;  // String |  (optional)  (default to json)
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get dashboard group
                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\Api\DashboardGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get dashboard group api_response = api_instance.get_dashboard_group_by_id(id, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->getDashboardGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDashboardGroupByIDParams()
    
// get dashboard group 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 - successful operation

Status: default - Error


getDashboardGroupList

get dashboard group list


/dashboard/groups

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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)
Integer *offset = 56; //  (optional)
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) 
            var offset = 56;  // Integer |  (optional) 
            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\Api\DashboardGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get dashboard group list api_response = api_instance.get_dashboard_group_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->getDashboardGroupList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDashboardGroupListParams()
    
// get dashboard group list 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]]" "https://localhost/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
    body: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(id, body, 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\Api\DashboardGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update dashboard group api_response = api_instance.patch_dashboard_group_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->patchDashboardGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDashboardGroupByIDParams()
    
// update dashboard group 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]]" "https://localhost/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
    body: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(id, body, 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\Api\DashboardGroupsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update dashboard group api_response = api_instance.update_dashboard_group_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling DashboardGroupsApi->updateDashboardGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDashboardGroupByIDParams()
    
// update dashboard group 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


/dashboard/dashboards

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/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\Api\DashboardsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add dashboard api_response = api_instance.add_dashboard(body) pprint(api_response) except ApiException as e: print("Exception when calling DashboardsApi->addDashboard: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddDashboardParams()
    
// add dashboard 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


/dashboard/dashboards/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/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\Api\DashboardsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete dashboard api_response = api_instance.delete_dashboard_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling DashboardsApi->deleteDashboardById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDashboardByIDParams()
    
// delete dashboard 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


/dashboard/dashboards/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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) (default to false)
String *format = format_example; //  (optional) (default to json)
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)  (default to false)
            var format = format_example;  // String |  (optional)  (default to json)
            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\Api\DashboardsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get dashboard api_response = api_instance.get_dashboard_by_id(id, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DashboardsApi->getDashboardById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDashboardByIDParams()
    
// get dashboard 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


/dashboard/dashboards

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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)
Integer *offset = 56; //  (optional)
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) 
            var offset = 56;  // Integer |  (optional) 
            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\Api\DashboardsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get dashboard list api_response = api_instance.get_dashboard_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DashboardsApi->getDashboardList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDashboardListParams()
    
// get dashboard list 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 - successful operation

Status: default - Error


getWidgetListByDashboardId

get widget list by DashboardId


/dashboard/dashboards/{id}/widgets

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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)
Integer *offset = 56; //  (optional)
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) 
            var offset = 56;  // Integer |  (optional) 
            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\Api\DashboardsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DashboardsApi->getWidgetListByDashboardId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWidgetListByDashboardIDParams()
    
// get widget list by DashboardId 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]]" "https://localhost/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) (default to false)

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

// update dashboard
[apiInstance patchDashboardByIdWith:id
    body: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(id, body, 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)  (default to false)

            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\Api\DashboardsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update dashboard api_response = api_instance.patch_dashboard_by_id(id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling DashboardsApi->patchDashboardById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDashboardByIDParams()
    
// update dashboard 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]]" "https://localhost/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) (default to false)

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

// update dashboard
[apiInstance updateDashboardByIdWith:id
    body: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(id, body, 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)  (default to false)

            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\Api\DashboardsApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update dashboard api_response = api_instance.update_dashboard_by_id(id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling DashboardsApi->updateDashboardById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDashboardByIDParams()
    
// update dashboard 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

getDeviceDatasourceInstanceData

get device instance data


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}/data

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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) (default to 1.0)
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *datapoints = datapoints_example; //  (optional)
String *format = format_example; //  (optional) (default to json)

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)  (default to 1.0)
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var datapoints = datapoints_example;  // String |  (optional) 
            var format = format_example;  // String |  (optional)  (default to json)

            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\Api\DataApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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, , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DataApi->getDeviceDatasourceInstanceData: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceDataParams()
    
// get device instance data 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


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}/graphs/{graphId}/data

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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\Api\DataApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DataApi->getDeviceDatasourceInstanceGraphData: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceGraphDataParams()
    
// get device instance graph data 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


/device/devices/{deviceId}/devicedatasources/{deviceDsId}/groups/{dsigId}/graphs/{ographId}/data

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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 deviceId = 56; // Integer | 
        Integer deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
        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(deviceId, deviceDsId, 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 deviceId = 56; // Integer | 
        Integer deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
        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(deviceId, deviceDsId, 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 *deviceId = 56; // 
Integer *deviceDsId = 56; // The device-datasource ID you'd like to add an instance group for
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:deviceId
    deviceDsId:deviceDsId
    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 deviceId = 56; // {Integer} 

var deviceDsId = 56; // {Integer} The device-datasource ID you'd like to add an instance group for

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(deviceId, deviceDsId, 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 deviceId = 56;  // Integer | 
            var deviceDsId = 56;  // Integer | The device-datasource ID you'd like to add an instance group for
            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(deviceId, deviceDsId, 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\Api\DataApi();
$deviceId = 56; // Integer | 
$deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
$dsigId = 56; // Integer | 
$ographId = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$format = format_example; // String | 

try {
    $result = $api_instance->getDeviceDatasourceInstanceGroupOverviewGraphData($deviceId, $deviceDsId, $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 $deviceId = 56; # Integer | 
my $deviceDsId = 56; # Integer | The device-datasource ID you'd like to add an instance group for
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(deviceId => $deviceId, deviceDsId => $deviceDsId, 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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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(deviceId, deviceDsId, dsigId, ographId, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DataApi->getDeviceDatasourceInstanceGroupOverviewGraphData: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceGroupOverviewGraphDataParams()
    
// get device instance group overview graph data 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
deviceId*
Integer (int32)
Required
deviceDsId*
Integer (int32)
The device-datasource ID you'd like to add an instance group for
Required
dsigId*
Integer (int32)
Required
ographId*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
format
String

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceInstanceGraphDataOnlyByInstanceId

get device instance data


/device/devicedatasourceinstances/{instanceId}/graphs/{graphId}/data

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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\Api\DataApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DataApi->getDeviceInstanceGraphDataOnlyByInstanceId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceInstanceGraphDataOnlyByInstanceIDParams()
    
// get device instance data 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


/website/websites/{srvId}/checkpoints/{checkId}/data

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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) (default to 1.0)
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *datapoints = datapoints_example; //  (optional)
String *format = format_example; //  (optional) (default to json)
String *aggregate = aggregate_example; // the aggregate option (optional) (default to none)

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)  (default to 1.0)
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var datapoints = datapoints_example;  // String |  (optional) 
            var format = format_example;  // String |  (optional)  (default to json)
            var aggregate = aggregate_example;  // String | the aggregate option (optional)  (default to none)

            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\Api\DataApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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, , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DataApi->getWebsiteCheckpointDataById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsiteCheckpointDataByIDParams()
    
// get data for a website checkpoint 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


/website/websites/{websiteId}/checkpoints/{checkpointId}/graphs/{graphName}/data

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites/{websiteId}/checkpoints/{checkpointId}/graphs/{graphName}/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 websiteId = 56; // Integer | 
        Integer checkpointId = 56; // Integer | 
        String graphName = graphName_example; // String | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getWebsiteGraphData(websiteId, checkpointId, graphName, start, end, 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 websiteId = 56; // Integer | 
        Integer checkpointId = 56; // Integer | 
        String graphName = graphName_example; // String | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getWebsiteGraphData(websiteId, checkpointId, graphName, start, end, 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 *websiteId = 56; // 
Integer *checkpointId = 56; // 
String *graphName = graphName_example; // 
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *format = format_example; //  (optional)

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

// get website graph data
[apiInstance getWebsiteGraphDataWith:websiteId
    checkpointId:checkpointId
    graphName:graphName
    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 websiteId = 56; // {Integer} 

var checkpointId = 56; // {Integer} 

var graphName = graphName_example; // {String} 

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.getWebsiteGraphData(websiteId, checkpointId, 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 websiteId = 56;  // Integer | 
            var checkpointId = 56;  // Integer | 
            var graphName = graphName_example;  // String | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var format = format_example;  // String |  (optional) 

            try
            {
                // get website graph data
                GraphPlot result = apiInstance.getWebsiteGraphData(websiteId, checkpointId, graphName, start, end, 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\Api\DataApi();
$websiteId = 56; // Integer | 
$checkpointId = 56; // Integer | 
$graphName = graphName_example; // String | 
$start = 789; // Long | 
$end = 789; // Long | 
$format = format_example; // String | 

try {
    $result = $api_instance->getWebsiteGraphData($websiteId, $checkpointId, $graphName, $start, $end, $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 $websiteId = 56; # Integer | 
my $checkpointId = 56; # Integer | 
my $graphName = graphName_example; # String | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $format = format_example; # String | 

eval { 
    my $result = $api_instance->getWebsiteGraphData(websiteId => $websiteId, checkpointId => $checkpointId, graphName => $graphName, start => $start, end => $end, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DataApi->getWebsiteGraphData: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get website graph data api_response = api_instance.get_website_graph_data(websiteId, checkpointId, graphName, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DataApi->getWebsiteGraphData: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsiteGraphDataParams()
    
// get website graph data 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
websiteId*
Integer (int32)
Required
checkpointId*
Integer (int32)
Required
graphName*
String
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
format
String

Responses

Status: 200 - successful operation

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)


/dashboard/widgets/{id}/data

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/dashboard/widgets/{id}/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 id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            WidgetData result = apiInstance.getWidgetDataById(id, start, end, format);
            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 start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            WidgetData result = apiInstance.getWidgetDataById(id, start, end, format);
            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 *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *format = format_example; //  (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
    start:start
    end:end
    format:format
              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 = { 
  '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.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 start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var format = format_example;  // String |  (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, start, end, format);
                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\Api\DataApi();
$id = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$format = format_example; // String | 

try {
    $result = $api_instance->getWidgetDataById($id, $start, $end, $format);
    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 $start = 789; # Long | 
my $end = 789; # Long | 
my $format = format_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DataApi->getWidgetDataById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// 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) 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
start
Long (int64)
end
Long (int64)
format
String

Responses

Status: 200 - successful operation

Status: default - Error


DatasourceInstances

addDeviceDatasourceInstance

add device instance


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/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
    hdsId:hdsId
    body: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(deviceId, hdsId, body, 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\Api\DatasourceInstancesApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add device instance api_response = api_instance.add_device_datasource_instance(deviceId, hdsId, body) pprint(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->addDeviceDatasourceInstance: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddDeviceDatasourceInstanceParams()
    
// add device instance 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


collectDeviceConfigSourceConfig

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]]" "https://localhost/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 deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        Integer instanceId = 56; // Integer | 
        try {
            Object result = apiInstance.collectDeviceConfigSourceConfig(deviceId, hdsId, instanceId);
            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 deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        Integer instanceId = 56; // Integer | 
        try {
            Object result = apiInstance.collectDeviceConfigSourceConfig(deviceId, hdsId, instanceId);
            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 *deviceId = 56; // 
Integer *hdsId = 56; // 
Integer *instanceId = 56; // 

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

// collect a config for a device
[apiInstance collectDeviceConfigSourceConfigWith:deviceId
    hdsId:hdsId
    instanceId:instanceId
              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} 

var instanceId = 56; // {Integer} 


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

            try
            {
                // collect a config for a device
                Object result = apiInstance.collectDeviceConfigSourceConfig(deviceId, hdsId, instanceId);
                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\Api\DatasourceInstancesApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | 
$instanceId = 56; // Integer | 

try {
    $result = $api_instance->collectDeviceConfigSourceConfig($deviceId, $hdsId, $instanceId);
    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 $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | 
my $instanceId = 56; # Integer | 

eval { 
    my $result = $api_instance->collectDeviceConfigSourceConfig(deviceId => $deviceId, hdsId => $hdsId, instanceId => $instanceId);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourceInstancesApi->collectDeviceConfigSourceConfig: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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(deviceId, hdsId, instanceId) pprint(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->collectDeviceConfigSourceConfig: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewCollectDeviceConfigSourceConfigParams()
    
// collect a config for a device 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
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
Required
instanceId*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


deleteDeviceDatasourceInstanceById

delete a device instance


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/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\Api\DatasourceInstancesApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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) pprint(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->deleteDeviceDatasourceInstanceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDeviceDatasourceInstanceByIDParams()
    
// delete a device instance 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


getDeviceConfigSourceConfigList

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]]" "https://localhost/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 deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        Integer instanceId = 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(deviceId, hdsId, instanceId, 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 deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | 
        Integer instanceId = 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(deviceId, hdsId, instanceId, 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 *deviceId = 56; // 
Integer *hdsId = 56; // 
Integer *instanceId = 56; // 
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get detailed config information for the instance
[apiInstance getDeviceConfigSourceConfigListWith:deviceId
    hdsId:hdsId
    instanceId:instanceId
    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 deviceId = 56; // {Integer} 

var hdsId = 56; // {Integer} 

var instanceId = 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(deviceId, hdsId, instanceId, 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 deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | 
            var instanceId = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get detailed config information for the instance
                DeviceDatasourceInstanceConfigPaginationResponse result = apiInstance.getDeviceConfigSourceConfigList(deviceId, hdsId, instanceId, 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\Api\DatasourceInstancesApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | 
$instanceId = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getDeviceConfigSourceConfigList($deviceId, $hdsId, $instanceId, $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 $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | 
my $instanceId = 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(deviceId => $deviceId, hdsId => $hdsId, instanceId => $instanceId, 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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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(deviceId, hdsId, instanceId, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->getDeviceConfigSourceConfigList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceConfigSourceConfigListParams()
    
// get detailed config information for the instance 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
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
Required
instanceId*
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


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/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\Api\DatasourceInstancesApi();
$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 logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
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, ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceByIDParams()
    
// get device instance 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


getDeviceDatasourceInstanceGroupList

get device datasource instance group list


/device/devices/{deviceId}/devicedatasources/{deviceDsId}/groups

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources/{deviceDsId}/groups?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 deviceId = 56; // Integer | 
        Integer deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceDatasourceInstanceGroupPaginationResponse result = apiInstance.getDeviceDatasourceInstanceGroupList(deviceId, deviceDsId, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceDatasourceInstanceGroupList");
            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 deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceDatasourceInstanceGroupPaginationResponse result = apiInstance.getDeviceDatasourceInstanceGroupList(deviceId, deviceDsId, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceDatasourceInstanceGroupList");
            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 *deviceDsId = 56; // The device-datasource ID you'd like to add an instance group for
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device datasource instance group list 
[apiInstance getDeviceDatasourceInstanceGroupListWith:deviceId
    deviceDsId:deviceDsId
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceDatasourceInstanceGroupPaginationResponse 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 deviceDsId = 56; // {Integer} The device-datasource ID you'd like to add an instance group for

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.getDeviceDatasourceInstanceGroupList(deviceId, deviceDsId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceDatasourceInstanceGroupListExample
    {
        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 deviceDsId = 56;  // Integer | The device-datasource ID you'd like to add an instance group for
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device datasource instance group list 
                DeviceDatasourceInstanceGroupPaginationResponse result = apiInstance.getDeviceDatasourceInstanceGroupList(deviceId, deviceDsId, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.getDeviceDatasourceInstanceGroupList: " + 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\Api\DatasourceInstancesApi();
$deviceId = 56; // Integer | 
$deviceDsId = 56; // Integer | The device-datasource ID you'd like to add an instance group for
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getDeviceDatasourceInstanceGroupList($deviceId, $deviceDsId, $fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceGroupList: ', $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 $deviceDsId = 56; # Integer | The device-datasource ID you'd like to add an instance group for
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device datasource instance group list api_response = api_instance.get_device_datasource_instance_group_list(deviceId, deviceDsId, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceGroupList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceGroupListParams()
    
// get device datasource instance group list resp, err := client.LM.GetDeviceDatasourceInstanceGroupList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceInstanceGroupList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
deviceDsId*
Integer (int32)
The device-datasource ID you'd like to add an instance group for
Required
Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceDatasourceInstanceList

get device instance list


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances?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 deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceDatasourceInstancePaginationResponse result = apiInstance.getDeviceDatasourceInstanceList(deviceId, hdsId, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceDatasourceInstanceList");
            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
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceDatasourceInstancePaginationResponse result = apiInstance.getDeviceDatasourceInstanceList(deviceId, hdsId, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceDatasourceInstanceList");
            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
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device instance list
[apiInstance getDeviceDatasourceInstanceListWith:deviceId
    hdsId:hdsId
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceDatasourceInstancePaginationResponse 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 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.getDeviceDatasourceInstanceList(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 getDeviceDatasourceInstanceListExample
    {
        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 fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device instance list
                DeviceDatasourceInstancePaginationResponse result = apiInstance.getDeviceDatasourceInstanceList(deviceId, hdsId, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.getDeviceDatasourceInstanceList: " + 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\Api\DatasourceInstancesApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | The device-datasource ID
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getDeviceDatasourceInstanceList($deviceId, $hdsId, $fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceList: ', $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 $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device instance list api_response = api_instance.get_device_datasource_instance_list(deviceId, hdsId, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceListParams()
    
// get device instance list resp, err := client.LM.GetDeviceDatasourceInstanceList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceInstanceList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
The device-datasource ID
Required
Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceDatasourceInstanceSDTHistory

get device instance SDT history


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}/historysdts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}/historysdts?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 deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | The device-datasource ID
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceGroupSDTHistoryPaginationResponse result = apiInstance.getDeviceDatasourceInstanceSDTHistory(deviceId, hdsId, id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceDatasourceInstanceSDTHistory");
            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 | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceGroupSDTHistoryPaginationResponse result = apiInstance.getDeviceDatasourceInstanceSDTHistory(deviceId, hdsId, id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#getDeviceDatasourceInstanceSDTHistory");
            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)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device instance SDT history
[apiInstance getDeviceDatasourceInstanceSDTHistoryWith:deviceId
    hdsId:hdsId
    id:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceGroupSDTHistoryPaginationResponse 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} 
  '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.getDeviceDatasourceInstanceSDTHistory(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 getDeviceDatasourceInstanceSDTHistoryExample
    {
        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) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device instance SDT history
                DeviceGroupSDTHistoryPaginationResponse result = apiInstance.getDeviceDatasourceInstanceSDTHistory(deviceId, hdsId, id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.getDeviceDatasourceInstanceSDTHistory: " + 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\Api\DatasourceInstancesApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | The device-datasource ID
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getDeviceDatasourceInstanceSDTHistory($deviceId, $hdsId, $id, $fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceSDTHistory: ', $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 | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device instance SDT history api_response = api_instance.get_device_datasource_instance_sdt_history(deviceId, hdsId, id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->getDeviceDatasourceInstanceSDTHistory: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceSDTHistoryParams()
    
// get device instance SDT history resp, err := client.LM.GetDeviceDatasourceInstanceSDTHistory(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceInstanceSDTHistory: %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
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


patchDeviceDatasourceInstanceById

update device instance


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}?opType="
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 | 
        DeviceDataSourceInstance body = ; // DeviceDataSourceInstance | 
        String opType = opType_example; // String | 
        try {
            DeviceDataSourceInstance result = apiInstance.patchDeviceDatasourceInstanceById(deviceId, hdsId, id, body, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#patchDeviceDatasourceInstanceById");
            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 | 
        DeviceDataSourceInstance body = ; // DeviceDataSourceInstance | 
        String opType = opType_example; // String | 
        try {
            DeviceDataSourceInstance result = apiInstance.patchDeviceDatasourceInstanceById(deviceId, hdsId, id, body, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#patchDeviceDatasourceInstanceById");
            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; // 
DeviceDataSourceInstance *body = ; // 
String *opType = opType_example; //  (optional) (default to refresh)

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

// update device instance
[apiInstance patchDeviceDatasourceInstanceByIdWith:deviceId
    hdsId:hdsId
    id:id
    body:body
    opType:opType
              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 body = ; // {DeviceDataSourceInstance} 

var opts = { 
  '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.patchDeviceDatasourceInstanceById(deviceId, hdsId, id, body, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchDeviceDatasourceInstanceByIdExample
    {
        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 body = new DeviceDataSourceInstance(); // DeviceDataSourceInstance | 
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            try
            {
                // update device instance
                DeviceDataSourceInstance result = apiInstance.patchDeviceDatasourceInstanceById(deviceId, hdsId, id, body, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.patchDeviceDatasourceInstanceById: " + 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\Api\DatasourceInstancesApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | The device-datasource ID
$id = 56; // Integer | 
$body = ; // DeviceDataSourceInstance | 
$opType = opType_example; // String | 

try {
    $result = $api_instance->patchDeviceDatasourceInstanceById($deviceId, $hdsId, $id, $body, $opType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->patchDeviceDatasourceInstanceById: ', $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 $body = WWW::SwaggerClient::Object::DeviceDataSourceInstance->new(); # DeviceDataSourceInstance | 
my $opType = opType_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device instance api_response = api_instance.patch_device_datasource_instance_by_id(deviceId, hdsId, id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->patchDeviceDatasourceInstanceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDeviceDatasourceInstanceByIDParams()
    
// update device instance resp, err := client.LM.PatchDeviceDatasourceInstanceByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchDeviceDatasourceInstanceByID: %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
Body parameters
Name Description
body *
Query parameters
Name Description
opType
String

Responses

Status: 200 - successful operation

Status: default - Error


updateDeviceDatasourceInstanceById

update device instance


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{id}?opType="
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 | 
        DeviceDataSourceInstance body = ; // DeviceDataSourceInstance | 
        String opType = opType_example; // String | 
        try {
            DeviceDataSourceInstance result = apiInstance.updateDeviceDatasourceInstanceById(deviceId, hdsId, id, body, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#updateDeviceDatasourceInstanceById");
            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 | 
        DeviceDataSourceInstance body = ; // DeviceDataSourceInstance | 
        String opType = opType_example; // String | 
        try {
            DeviceDataSourceInstance result = apiInstance.updateDeviceDatasourceInstanceById(deviceId, hdsId, id, body, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourceInstancesApi#updateDeviceDatasourceInstanceById");
            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; // 
DeviceDataSourceInstance *body = ; // 
String *opType = opType_example; //  (optional) (default to refresh)

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

// update device instance
[apiInstance updateDeviceDatasourceInstanceByIdWith:deviceId
    hdsId:hdsId
    id:id
    body:body
    opType:opType
              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 body = ; // {DeviceDataSourceInstance} 

var opts = { 
  '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.updateDeviceDatasourceInstanceById(deviceId, hdsId, id, body, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateDeviceDatasourceInstanceByIdExample
    {
        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 body = new DeviceDataSourceInstance(); // DeviceDataSourceInstance | 
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            try
            {
                // update device instance
                DeviceDataSourceInstance result = apiInstance.updateDeviceDatasourceInstanceById(deviceId, hdsId, id, body, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourceInstancesApi.updateDeviceDatasourceInstanceById: " + 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\Api\DatasourceInstancesApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | The device-datasource ID
$id = 56; // Integer | 
$body = ; // DeviceDataSourceInstance | 
$opType = opType_example; // String | 

try {
    $result = $api_instance->updateDeviceDatasourceInstanceById($deviceId, $hdsId, $id, $body, $opType);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DatasourceInstancesApi->updateDeviceDatasourceInstanceById: ', $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 $body = WWW::SwaggerClient::Object::DeviceDataSourceInstance->new(); # DeviceDataSourceInstance | 
my $opType = opType_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device instance api_response = api_instance.update_device_datasource_instance_by_id(deviceId, hdsId, id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourceInstancesApi->updateDeviceDatasourceInstanceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDeviceDatasourceInstanceByIDParams()
    
// update device instance resp, err := client.LM.UpdateDeviceDatasourceInstanceByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateDeviceDatasourceInstanceByID: %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
Body parameters
Name Description
body *
Query parameters
Name Description
opType
String

Responses

Status: 200 - successful operation

Status: default - Error


Datasources

addDatasourceAuditVersion

add audit version


/setting/datasources/{id}/audit

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/datasources/{id}/audit"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourcesApi;

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

public class DatasourcesApiExample {

    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");

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

public class DatasourcesApiExample {

    public static void main(String[] args) {
        DatasourcesApi apiInstance = new DatasourcesApi();
        Integer id = 56; // Integer | 
        Audit body = ; // Audit | 
        try {
            DataSource result = apiInstance.addDatasourceAuditVersion(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourcesApi#addDatasourceAuditVersion");
            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; // 
Audit *body = ; //  (optional)

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

// add audit version
[apiInstance addDatasourceAuditVersionWith:id
    body:body
              completionHandler: ^(DataSource 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.DatasourcesApi()

var id = 56; // {Integer} 

var opts = { 
  'body':  // {Audit} 
};

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

namespace Example
{
    public class addDatasourceAuditVersionExample
    {
        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 DatasourcesApi();
            var id = 56;  // Integer | 
            var body = new Audit(); // Audit |  (optional) 

            try
            {
                // add audit version
                DataSource result = apiInstance.addDatasourceAuditVersion(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourcesApi.addDatasourceAuditVersion: " + 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\Api\DatasourcesApi();
$id = 56; // Integer | 
$body = ; // Audit | 

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

# 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::DatasourcesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Audit->new(); # Audit | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add audit version api_response = api_instance.add_datasource_audit_version(id, ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourcesApi->addDatasourceAuditVersion: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddDatasourceAuditVersionParams()
    
// add audit version resp, err := client.LM.AddDatasourceAuditVersion(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDatasourceAuditVersion: %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


deleteDatasourceById

delete datasource


/setting/datasources/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/datasources/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourcesApi;

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

public class DatasourcesApiExample {

    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");

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

public class DatasourcesApiExample {

    public static void main(String[] args) {
        DatasourcesApi apiInstance = new DatasourcesApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteDatasourceById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourcesApi#deleteDatasourceById");
            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; // 

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

// delete datasource
[apiInstance deleteDatasourceByIdWith: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.DatasourcesApi()

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.deleteDatasourceById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteDatasourceByIdExample
    {
        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 DatasourcesApi();
            var id = 56;  // Integer | 

            try
            {
                // delete datasource
                Object result = apiInstance.deleteDatasourceById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourcesApi.deleteDatasourceById: " + 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\Api\DatasourcesApi();
$id = 56; // Integer | 

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

# 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::DatasourcesApi->new();
my $id = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete datasource api_response = api_instance.delete_datasource_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling DatasourcesApi->deleteDatasourceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDatasourceByIDParams()
    
// delete datasource resp, err := client.LM.DeleteDatasourceByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteDatasourceByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


getAssociatedDeviceListByDataSourceId

get devices associated with a datasource


/setting/datasources/{id}/devices

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/datasources/{id}/devices?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourcesApi;

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

public class DatasourcesApiExample {

    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");

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

public class DatasourcesApiExample {

    public static void main(String[] args) {
        DatasourcesApi apiInstance = new DatasourcesApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceDataSourceAssociatedPaginationResponse result = apiInstance.getAssociatedDeviceListByDataSourceId(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourcesApi#getAssociatedDeviceListByDataSourceId");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get devices associated with a datasource
[apiInstance getAssociatedDeviceListByDataSourceIdWith:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceDataSourceAssociatedPaginationResponse 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.DatasourcesApi()

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.getAssociatedDeviceListByDataSourceId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAssociatedDeviceListByDataSourceIdExample
    {
        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 DatasourcesApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get devices associated with a datasource
                DeviceDataSourceAssociatedPaginationResponse result = apiInstance.getAssociatedDeviceListByDataSourceId(id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourcesApi.getAssociatedDeviceListByDataSourceId: " + 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\Api\DatasourcesApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DatasourcesApi->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->getAssociatedDeviceListByDataSourceId(id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourcesApi->getAssociatedDeviceListByDataSourceId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get devices associated with a datasource api_response = api_instance.get_associated_device_list_by_data_source_id(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourcesApi->getAssociatedDeviceListByDataSourceId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAssociatedDeviceListByDataSourceIDParams()
    
// get devices associated with a datasource resp, err := client.LM.GetAssociatedDeviceListByDataSourceID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAssociatedDeviceListByDataSourceID: %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


getDataSourceOverviewGraphList

get datasource overview graph list


/setting/datasources/{dsId}/ographs

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/datasources/{dsId}/ographs?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourcesApi;

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

public class DatasourcesApiExample {

    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");

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

public class DatasourcesApiExample {

    public static void main(String[] args) {
        DatasourcesApi apiInstance = new DatasourcesApi();
        Integer dsId = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DatasourceOverviewGraphPaginationResponse result = apiInstance.getDataSourceOverviewGraphList(dsId, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourcesApi#getDataSourceOverviewGraphList");
            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 *dsId = 56; // 
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get datasource overview graph list
[apiInstance getDataSourceOverviewGraphListWith:dsId
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DatasourceOverviewGraphPaginationResponse 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.DatasourcesApi()

var dsId = 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.getDataSourceOverviewGraphList(dsId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDataSourceOverviewGraphListExample
    {
        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 DatasourcesApi();
            var dsId = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get datasource overview graph list
                DatasourceOverviewGraphPaginationResponse result = apiInstance.getDataSourceOverviewGraphList(dsId, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourcesApi.getDataSourceOverviewGraphList: " + 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\Api\DatasourcesApi();
$dsId = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DatasourcesApi->new();
my $dsId = 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->getDataSourceOverviewGraphList(dsId => $dsId, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourcesApi->getDataSourceOverviewGraphList: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get datasource overview graph list api_response = api_instance.get_data_source_overview_graph_list(dsId, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourcesApi->getDataSourceOverviewGraphList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDataSourceOverviewGraphListParams()
    
// get datasource overview graph list resp, err := client.LM.GetDataSourceOverviewGraphList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDataSourceOverviewGraphList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
dsId*
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


getDatasourceById

get datasource by id


/setting/datasources/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/datasources/{id}?format=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourcesApi;

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

public class DatasourcesApiExample {

    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");

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

public class DatasourcesApiExample {

    public static void main(String[] args) {
        DatasourcesApi apiInstance = new DatasourcesApi();
        Integer id = 56; // Integer | 
        String format = format_example; // String | 
        String fields = fields_example; // String | 
        try {
            DataSource result = apiInstance.getDatasourceById(id, format, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourcesApi#getDatasourceById");
            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) (default to json)
String *fields = fields_example; //  (optional)

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

// get datasource by id
[apiInstance getDatasourceByIdWith:id
    format:format
    fields:fields
              completionHandler: ^(DataSource 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.DatasourcesApi()

var id = 56; // {Integer} 

var opts = { 
  '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.getDatasourceById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDatasourceByIdExample
    {
        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 DatasourcesApi();
            var id = 56;  // Integer | 
            var format = format_example;  // String |  (optional)  (default to json)
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get datasource by id
                DataSource result = apiInstance.getDatasourceById(id, format, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourcesApi.getDatasourceById: " + 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\Api\DatasourcesApi();
$id = 56; // Integer | 
$format = format_example; // String | 
$fields = fields_example; // String | 

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

# 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::DatasourcesApi->new();
my $id = 56; # Integer | 
my $format = format_example; # String | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get datasource by id api_response = api_instance.get_datasource_by_id(id, , ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourcesApi->getDatasourceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDatasourceByIDParams()
    
// get datasource by id resp, err := client.LM.GetDatasourceByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDatasourceByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


getDatasourceList

get datasource list


/setting/datasources

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/datasources?format=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourcesApi;

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

public class DatasourcesApiExample {

    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");

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

public class DatasourcesApiExample {

    public static void main(String[] args) {
        DatasourcesApi apiInstance = new DatasourcesApi();
        String format = format_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DatasourcePaginationResponse result = apiInstance.getDatasourceList(format, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourcesApi#getDatasourceList");
            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) (default to json)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get datasource list
[apiInstance getDatasourceListWith:format
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DatasourcePaginationResponse 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.DatasourcesApi()

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.getDatasourceList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDatasourceListExample
    {
        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 DatasourcesApi();
            var format = format_example;  // String |  (optional)  (default to json)
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get datasource list
                DatasourcePaginationResponse result = apiInstance.getDatasourceList(format, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourcesApi.getDatasourceList: " + 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\Api\DatasourcesApi();
$format = format_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DatasourcesApi->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->getDatasourceList(format => $format, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourcesApi->getDatasourceList: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get datasource list api_response = api_instance.get_datasource_list(, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourcesApi->getDatasourceList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDatasourceListParams()
    
// get datasource list resp, err := client.LM.GetDatasourceList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDatasourceList: %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 - successful operation

Status: default - Error


getUpdateReasonListByDataSourceId

get update history for a datasource


/setting/datasources/{id}/updatereasons

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/datasources/{id}/updatereasons?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DatasourcesApi;

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

public class DatasourcesApiExample {

    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");

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

public class DatasourcesApiExample {

    public static void main(String[] args) {
        DatasourcesApi apiInstance = new DatasourcesApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DataSourceUpdateReasonsPaginationResponse result = apiInstance.getUpdateReasonListByDataSourceId(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DatasourcesApi#getUpdateReasonListByDataSourceId");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get update history for a datasource
[apiInstance getUpdateReasonListByDataSourceIdWith:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DataSourceUpdateReasonsPaginationResponse 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.DatasourcesApi()

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.getUpdateReasonListByDataSourceId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getUpdateReasonListByDataSourceIdExample
    {
        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 DatasourcesApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get update history for a datasource
                DataSourceUpdateReasonsPaginationResponse result = apiInstance.getUpdateReasonListByDataSourceId(id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DatasourcesApi.getUpdateReasonListByDataSourceId: " + 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\Api\DatasourcesApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DatasourcesApi->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->getUpdateReasonListByDataSourceId(id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DatasourcesApi->getUpdateReasonListByDataSourceId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get update history for a datasource api_response = api_instance.get_update_reason_list_by_data_source_id(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DatasourcesApi->getUpdateReasonListByDataSourceId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetUpdateReasonListByDataSourceIDParams()
    
// get update history for a datasource resp, err := client.LM.GetUpdateReasonListByDataSourceID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetUpdateReasonListByDataSourceID: %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


Debug

executeDebugCommand

Execute a Collector debug command


/debug

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/debug?collectorId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DebugApi;

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

public class DebugApiExample {

    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");

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

public class DebugApiExample {

    public static void main(String[] args) {
        DebugApi apiInstance = new DebugApi();
        Debug body = ; // Debug | 
        Integer collectorId = 56; // Integer | 
        try {
            Debug result = apiInstance.executeDebugCommand(body, collectorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DebugApi#executeDebugCommand");
            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"];

Debug *body = ; //  (optional)
Integer *collectorId = 56; //  (optional)

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

// Execute a Collector debug command
[apiInstance executeDebugCommandWith:body
    collectorId:collectorId
              completionHandler: ^(Debug 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.DebugApi()

var opts = { 
  'body': , // {Debug} 
  'collectorId': 56 // {Integer} 
};

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

namespace Example
{
    public class executeDebugCommandExample
    {
        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 DebugApi();
            var body = new Debug(); // Debug |  (optional) 
            var collectorId = 56;  // Integer |  (optional) 

            try
            {
                // Execute a Collector debug command
                Debug result = apiInstance.executeDebugCommand(body, collectorId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DebugApi.executeDebugCommand: " + 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\Api\DebugApi();
$body = ; // Debug | 
$collectorId = 56; // Integer | 

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

# 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::DebugApi->new();
my $body = WWW::SwaggerClient::Object::Debug->new(); # Debug | 
my $collectorId = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # Execute a Collector debug command api_response = api_instance.execute_debug_command(, ) pprint(api_response) except ApiException as e: print("Exception when calling DebugApi->executeDebugCommand: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewExecuteDebugCommandParams()
    
// Execute a Collector debug command resp, err := client.LM.ExecuteDebugCommand(params) if err != nil { fmt.Printf("Exception when calling client.LM.ExecuteDebugCommand: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body
Query parameters
Name Description
collectorId
Integer (int32)

Responses

Status: 200 - successful operation

Status: default - Error


getDebugCommandResult

Get the result of a Collector debug command using sessionId


/debug/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/debug/{id}?collectorId="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DebugApi;

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

public class DebugApiExample {

    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");

        DebugApi apiInstance = new DebugApi();
        String id = id_example; // String | 
        Integer collectorId = 56; // Integer | 
        try {
            Debug result = apiInstance.getDebugCommandResult(id, collectorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DebugApi#getDebugCommandResult");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DebugApi;

public class DebugApiExample {

    public static void main(String[] args) {
        DebugApi apiInstance = new DebugApi();
        String id = id_example; // String | 
        Integer collectorId = 56; // Integer | 
        try {
            Debug result = apiInstance.getDebugCommandResult(id, collectorId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DebugApi#getDebugCommandResult");
            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; // 
Integer *collectorId = 56; //  (optional)

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

// Get the result of a Collector debug command using sessionId
[apiInstance getDebugCommandResultWith:id
    collectorId:collectorId
              completionHandler: ^(Debug 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.DebugApi()

var id = id_example; // {String} 

var opts = { 
  'collectorId': 56 // {Integer} 
};

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

namespace Example
{
    public class getDebugCommandResultExample
    {
        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 DebugApi();
            var id = id_example;  // String | 
            var collectorId = 56;  // Integer |  (optional) 

            try
            {
                // Get the result of a Collector debug command using sessionId
                Debug result = apiInstance.getDebugCommandResult(id, collectorId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DebugApi.getDebugCommandResult: " + 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\Api\DebugApi();
$id = id_example; // String | 
$collectorId = 56; // Integer | 

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

# 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::DebugApi->new();
my $id = id_example; # String | 
my $collectorId = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # Get the result of a Collector debug command using sessionId api_response = api_instance.get_debug_command_result(id, ) pprint(api_response) except ApiException as e: print("Exception when calling DebugApi->getDebugCommandResult: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDebugCommandResultParams()
    
// Get the result of a Collector debug command using sessionId resp, err := client.LM.GetDebugCommandResult(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDebugCommandResult: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


DeviceGroups

addDeviceGroup

add device group


/device/groups

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        DeviceGroup body = ; // DeviceGroup | 
        try {
            DeviceGroup result = apiInstance.addDeviceGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#addDeviceGroup");
            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"];

DeviceGroup *body = ; // 

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

// add device group
[apiInstance addDeviceGroupWith:body
              completionHandler: ^(DeviceGroup 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.DeviceGroupsApi()

var body = ; // {DeviceGroup} 


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

namespace Example
{
    public class addDeviceGroupExample
    {
        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 DeviceGroupsApi();
            var body = new DeviceGroup(); // DeviceGroup | 

            try
            {
                // add device group
                DeviceGroup result = apiInstance.addDeviceGroup(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.addDeviceGroup: " + 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\Api\DeviceGroupsApi();
$body = ; // DeviceGroup | 

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

# 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::DeviceGroupsApi->new();
my $body = WWW::SwaggerClient::Object::DeviceGroup->new(); # DeviceGroup | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add device group api_response = api_instance.add_device_group(body) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->addDeviceGroup: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddDeviceGroupParams()
    
// add device group resp, err := client.LM.AddDeviceGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDeviceGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


addDeviceGroupProperty

add device group property


/device/groups/{gid}/properties

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{gid}/properties"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer gid = 56; // Integer | group ID
        EntityProperty body = ; // EntityProperty | 
        try {
            EntityProperty result = apiInstance.addDeviceGroupProperty(gid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#addDeviceGroupProperty");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeviceGroupsApi;

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer gid = 56; // Integer | group ID
        EntityProperty body = ; // EntityProperty | 
        try {
            EntityProperty result = apiInstance.addDeviceGroupProperty(gid, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#addDeviceGroupProperty");
            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 *gid = 56; // group ID
EntityProperty *body = ; // 

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

// add device group property
[apiInstance addDeviceGroupPropertyWith:gid
    body:body
              completionHandler: ^(EntityProperty 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.DeviceGroupsApi()

var gid = 56; // {Integer} group ID

var body = ; // {EntityProperty} 


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

namespace Example
{
    public class addDeviceGroupPropertyExample
    {
        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 DeviceGroupsApi();
            var gid = 56;  // Integer | group ID
            var body = new EntityProperty(); // EntityProperty | 

            try
            {
                // add device group property
                EntityProperty result = apiInstance.addDeviceGroupProperty(gid, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.addDeviceGroupProperty: " + 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\Api\DeviceGroupsApi();
$gid = 56; // Integer | group ID
$body = ; // EntityProperty | 

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

# 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::DeviceGroupsApi->new();
my $gid = 56; # Integer | group ID
my $body = WWW::SwaggerClient::Object::EntityProperty->new(); # EntityProperty | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add device group property api_response = api_instance.add_device_group_property(gid, body) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->addDeviceGroupProperty: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddDeviceGroupPropertyParams()
    
// add device group property resp, err := client.LM.AddDeviceGroupProperty(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDeviceGroupProperty: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
gid*
Integer (int32)
group ID
Required
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


deleteDeviceGroupById

delete device group


/device/groups/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{id}?deleteChildren=&deleteHard="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer id = 56; // Integer | 
        Boolean deleteChildren = true; // Boolean | 
        Boolean deleteHard = true; // Boolean | 
        try {
            Object result = apiInstance.deleteDeviceGroupById(id, deleteChildren, deleteHard);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#deleteDeviceGroupById");
            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 *deleteChildren = true; //  (optional) (default to false)
Boolean *deleteHard = true; //  (optional) (default to true)

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

// delete device group
[apiInstance deleteDeviceGroupByIdWith:id
    deleteChildren:deleteChildren
    deleteHard:deleteHard
              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.DeviceGroupsApi()

var id = 56; // {Integer} 

var opts = { 
  'deleteChildren': true, // {Boolean} 
  'deleteHard': true // {Boolean} 
};

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

namespace Example
{
    public class deleteDeviceGroupByIdExample
    {
        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 DeviceGroupsApi();
            var id = 56;  // Integer | 
            var deleteChildren = true;  // Boolean |  (optional)  (default to false)
            var deleteHard = true;  // Boolean |  (optional)  (default to true)

            try
            {
                // delete device group
                Object result = apiInstance.deleteDeviceGroupById(id, deleteChildren, deleteHard);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.deleteDeviceGroupById: " + 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\Api\DeviceGroupsApi();
$id = 56; // Integer | 
$deleteChildren = true; // Boolean | 
$deleteHard = true; // Boolean | 

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

# 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::DeviceGroupsApi->new();
my $id = 56; # Integer | 
my $deleteChildren = true; # Boolean | 
my $deleteHard = true; # Boolean | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete device group api_response = api_instance.delete_device_group_by_id(id, , ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->deleteDeviceGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDeviceGroupByIDParams()
    
// delete device group resp, err := client.LM.DeleteDeviceGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteDeviceGroupByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
deleteChildren
Boolean
deleteHard
Boolean

Responses

Status: 200 - successful operation

Status: default - Error


deleteDeviceGroupPropertyByName

delete device group property


/device/groups/{gid}/properties/{name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{gid}/properties/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer gid = 56; // Integer | group ID
        String name = name_example; // String | 
        try {
            Object result = apiInstance.deleteDeviceGroupPropertyByName(gid, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#deleteDeviceGroupPropertyByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeviceGroupsApi;

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer gid = 56; // Integer | group ID
        String name = name_example; // String | 
        try {
            Object result = apiInstance.deleteDeviceGroupPropertyByName(gid, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#deleteDeviceGroupPropertyByName");
            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 *gid = 56; // group ID
String *name = name_example; // 

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

// delete device group property
[apiInstance deleteDeviceGroupPropertyByNameWith:gid
    name:name
              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.DeviceGroupsApi()

var gid = 56; // {Integer} group ID

var name = name_example; // {String} 


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

namespace Example
{
    public class deleteDeviceGroupPropertyByNameExample
    {
        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 DeviceGroupsApi();
            var gid = 56;  // Integer | group ID
            var name = name_example;  // String | 

            try
            {
                // delete device group property
                Object result = apiInstance.deleteDeviceGroupPropertyByName(gid, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.deleteDeviceGroupPropertyByName: " + 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\Api\DeviceGroupsApi();
$gid = 56; // Integer | group ID
$name = name_example; // String | 

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

# 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::DeviceGroupsApi->new();
my $gid = 56; # Integer | group ID
my $name = name_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete device group property api_response = api_instance.delete_device_group_property_by_name(gid, name) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->deleteDeviceGroupPropertyByName: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDeviceGroupPropertyByNameParams()
    
// delete device group property resp, err := client.LM.DeleteDeviceGroupPropertyByName(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteDeviceGroupPropertyByName: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
gid*
Integer (int32)
group ID
Required
name*
String
Required

Responses

Status: 200 - successful operation

Status: default - Error


getAlertListByDeviceGroupId

get device group alerts


/device/groups/{id}/alerts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{id}/alerts?needMessage=&customColumns=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer id = 56; // Integer | 
        Boolean needMessage = true; // Boolean | 
        String customColumns = customColumns_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertPaginationResponse result = apiInstance.getAlertListByDeviceGroupId(id, needMessage, customColumns, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getAlertListByDeviceGroupId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeviceGroupsApi;

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer id = 56; // Integer | 
        Boolean needMessage = true; // Boolean | 
        String customColumns = customColumns_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertPaginationResponse result = apiInstance.getAlertListByDeviceGroupId(id, needMessage, customColumns, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getAlertListByDeviceGroupId");
            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 *needMessage = true; //  (optional) (default to false)
String *customColumns = customColumns_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device group alerts
[apiInstance getAlertListByDeviceGroupIdWith:id
    needMessage:needMessage
    customColumns:customColumns
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(AlertPaginationResponse 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.DeviceGroupsApi()

var id = 56; // {Integer} 

var opts = { 
  'needMessage': true, // {Boolean} 
  'customColumns': customColumns_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.getAlertListByDeviceGroupId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAlertListByDeviceGroupIdExample
    {
        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 DeviceGroupsApi();
            var id = 56;  // Integer | 
            var needMessage = true;  // Boolean |  (optional)  (default to false)
            var customColumns = customColumns_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device group alerts
                AlertPaginationResponse result = apiInstance.getAlertListByDeviceGroupId(id, needMessage, customColumns, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.getAlertListByDeviceGroupId: " + 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\Api\DeviceGroupsApi();
$id = 56; // Integer | 
$needMessage = true; // Boolean | 
$customColumns = customColumns_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DeviceGroupsApi->new();
my $id = 56; # Integer | 
my $needMessage = true; # Boolean | 
my $customColumns = customColumns_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->getAlertListByDeviceGroupId(id => $id, needMessage => $needMessage, customColumns => $customColumns, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeviceGroupsApi->getAlertListByDeviceGroupId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device group alerts api_response = api_instance.get_alert_list_by_device_group_id(id, , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->getAlertListByDeviceGroupId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAlertListByDeviceGroupIDParams()
    
// get device group alerts resp, err := client.LM.GetAlertListByDeviceGroupID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAlertListByDeviceGroupID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
needMessage
Boolean
customColumns
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getAwsExternalId

Get AWS external id


/aws/externalId

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/aws/externalId"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        try {
            AwsExternalId result = apiInstance.getAwsExternalId();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getAwsExternalId");
            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"];


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

// Get AWS external id
[apiInstance getAwsExternalIdWithCompletionHandler: 
              ^(AwsExternalId 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.DeviceGroupsApi()

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

namespace Example
{
    public class getAwsExternalIdExample
    {
        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 DeviceGroupsApi();

            try
            {
                // Get AWS external id
                AwsExternalId result = apiInstance.getAwsExternalId();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.getAwsExternalId: " + 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\Api\DeviceGroupsApi();

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

# 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::DeviceGroupsApi->new();

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
try:
    # Get AWS external id
    api_response = api_instance.get_aws_external_id()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling DeviceGroupsApi->getAwsExternalId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAwsExternalIDParams()
// Get AWS external id
resp, err := client.LM.GetAwsExternalID(params)
if err != nil {
fmt.Printf("Exception when calling client.LM.GetAwsExternalID: %v", err.Error())
}
fmt.Print(resp)
}

Parameters

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceGroupById

get device group


/device/groups/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            DeviceGroup result = apiInstance.getDeviceGroupById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getDeviceGroupById");
            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)

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

// get device group
[apiInstance getDeviceGroupByIdWith:id
    fields:fields
              completionHandler: ^(DeviceGroup 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.DeviceGroupsApi()

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.getDeviceGroupById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceGroupByIdExample
    {
        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 DeviceGroupsApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get device group
                DeviceGroup result = apiInstance.getDeviceGroupById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.getDeviceGroupById: " + 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\Api\DeviceGroupsApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 

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

# 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::DeviceGroupsApi->new();
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device group api_response = api_instance.get_device_group_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->getDeviceGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceGroupByIDParams()
    
// get device group resp, err := client.LM.GetDeviceGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceGroupByID: %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


getDeviceGroupDatasourceById

get device group datasource


/device/groups/{deviceGroupId}/datasources/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{deviceGroupId}/datasources/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer deviceGroupId = 56; // Integer | 
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            DeviceGroupDataSource result = apiInstance.getDeviceGroupDatasourceById(deviceGroupId, id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getDeviceGroupDatasourceById");
            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 *deviceGroupId = 56; // 
Integer *id = 56; // 
String *fields = fields_example; //  (optional)

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

// get device group datasource
[apiInstance getDeviceGroupDatasourceByIdWith:deviceGroupId
    id:id
    fields:fields
              completionHandler: ^(DeviceGroupDataSource 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.DeviceGroupsApi()

var deviceGroupId = 56; // {Integer} 

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.getDeviceGroupDatasourceById(deviceGroupId, id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceGroupDatasourceByIdExample
    {
        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 DeviceGroupsApi();
            var deviceGroupId = 56;  // Integer | 
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get device group datasource
                DeviceGroupDataSource result = apiInstance.getDeviceGroupDatasourceById(deviceGroupId, id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.getDeviceGroupDatasourceById: " + 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\Api\DeviceGroupsApi();
$deviceGroupId = 56; // Integer | 
$id = 56; // Integer | 
$fields = fields_example; // String | 

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

# 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::DeviceGroupsApi->new();
my $deviceGroupId = 56; # Integer | 
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device group datasource api_response = api_instance.get_device_group_datasource_by_id(deviceGroupId, id, ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->getDeviceGroupDatasourceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceGroupDatasourceByIDParams()
    
// get device group datasource resp, err := client.LM.GetDeviceGroupDatasourceByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceGroupDatasourceByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceGroupDatasourceList

get device group datasource list


/device/groups/{deviceGroupId}/datasources

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{deviceGroupId}/datasources?includeDisabledDataSourceWithoutInstance=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer deviceGroupId = 56; // Integer | 
        Boolean includeDisabledDataSourceWithoutInstance = true; // Boolean | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceGroupDatasourcePaginationResponse result = apiInstance.getDeviceGroupDatasourceList(deviceGroupId, includeDisabledDataSourceWithoutInstance, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getDeviceGroupDatasourceList");
            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 *deviceGroupId = 56; // 
Boolean *includeDisabledDataSourceWithoutInstance = true; //  (optional) (default to false)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device group datasource list
[apiInstance getDeviceGroupDatasourceListWith:deviceGroupId
    includeDisabledDataSourceWithoutInstance:includeDisabledDataSourceWithoutInstance
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceGroupDatasourcePaginationResponse 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.DeviceGroupsApi()

var deviceGroupId = 56; // {Integer} 

var opts = { 
  'includeDisabledDataSourceWithoutInstance': true, // {Boolean} 
  '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.getDeviceGroupDatasourceList(deviceGroupId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceGroupDatasourceListExample
    {
        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 DeviceGroupsApi();
            var deviceGroupId = 56;  // Integer | 
            var includeDisabledDataSourceWithoutInstance = true;  // Boolean |  (optional)  (default to false)
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device group datasource list
                DeviceGroupDatasourcePaginationResponse result = apiInstance.getDeviceGroupDatasourceList(deviceGroupId, includeDisabledDataSourceWithoutInstance, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.getDeviceGroupDatasourceList: " + 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\Api\DeviceGroupsApi();
$deviceGroupId = 56; // Integer | 
$includeDisabledDataSourceWithoutInstance = true; // Boolean | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DeviceGroupsApi->new();
my $deviceGroupId = 56; # Integer | 
my $includeDisabledDataSourceWithoutInstance = true; # Boolean | 
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device group datasource list api_response = api_instance.get_device_group_datasource_list(deviceGroupId, , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->getDeviceGroupDatasourceList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceGroupDatasourceListParams()
    
// get device group datasource list resp, err := client.LM.GetDeviceGroupDatasourceList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceGroupDatasourceList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceGroupId*
Integer (int32)
Required
Query parameters
Name Description
includeDisabledDataSourceWithoutInstance
Boolean
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceGroupList

get device group list


/device/groups

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceGroupPaginationResponse result = apiInstance.getDeviceGroupList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getDeviceGroupList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device group list
[apiInstance getDeviceGroupListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceGroupPaginationResponse 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.DeviceGroupsApi()

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.getDeviceGroupList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceGroupListExample
    {
        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 DeviceGroupsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device group list
                DeviceGroupPaginationResponse result = apiInstance.getDeviceGroupList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.getDeviceGroupList: " + 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\Api\DeviceGroupsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DeviceGroupsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device group list api_response = api_instance.get_device_group_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->getDeviceGroupList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceGroupListParams()
    
// get device group list resp, err := client.LM.GetDeviceGroupList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceGroupList: %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


getDeviceGroupPropertyByName

get device group property by name


/device/groups/{gid}/properties/{name}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{gid}/properties/{name}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer gid = 56; // Integer | group ID
        String name = name_example; // String | 
        String fields = fields_example; // String | 
        try {
            EntityProperty result = apiInstance.getDeviceGroupPropertyByName(gid, name, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getDeviceGroupPropertyByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeviceGroupsApi;

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer gid = 56; // Integer | group ID
        String name = name_example; // String | 
        String fields = fields_example; // String | 
        try {
            EntityProperty result = apiInstance.getDeviceGroupPropertyByName(gid, name, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getDeviceGroupPropertyByName");
            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 *gid = 56; // group ID
String *name = name_example; // 
String *fields = fields_example; //  (optional)

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

// get device group property by name
[apiInstance getDeviceGroupPropertyByNameWith:gid
    name:name
    fields:fields
              completionHandler: ^(EntityProperty 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.DeviceGroupsApi()

var gid = 56; // {Integer} group ID

var name = name_example; // {String} 

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.getDeviceGroupPropertyByName(gid, name, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceGroupPropertyByNameExample
    {
        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 DeviceGroupsApi();
            var gid = 56;  // Integer | group ID
            var name = name_example;  // String | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get device group property by name
                EntityProperty result = apiInstance.getDeviceGroupPropertyByName(gid, name, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.getDeviceGroupPropertyByName: " + 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\Api\DeviceGroupsApi();
$gid = 56; // Integer | group ID
$name = name_example; // String | 
$fields = fields_example; // String | 

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

# 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::DeviceGroupsApi->new();
my $gid = 56; # Integer | group ID
my $name = name_example; # String | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device group property by name api_response = api_instance.get_device_group_property_by_name(gid, name, ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->getDeviceGroupPropertyByName: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceGroupPropertyByNameParams()
    
// get device group property by name resp, err := client.LM.GetDeviceGroupPropertyByName(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceGroupPropertyByName: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
gid*
Integer (int32)
group ID
Required
name*
String
Required
Query parameters
Name Description
fields
String

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceGroupPropertyList

get device group properties


/device/groups/{gid}/properties

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{gid}/properties?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer gid = 56; // Integer | group ID
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            PropertyPaginationResponse result = apiInstance.getDeviceGroupPropertyList(gid, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getDeviceGroupPropertyList");
            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 *gid = 56; // group ID
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device group properties
[apiInstance getDeviceGroupPropertyListWith:gid
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(PropertyPaginationResponse 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.DeviceGroupsApi()

var gid = 56; // {Integer} group ID

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.getDeviceGroupPropertyList(gid, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceGroupPropertyListExample
    {
        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 DeviceGroupsApi();
            var gid = 56;  // Integer | group ID
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device group properties
                PropertyPaginationResponse result = apiInstance.getDeviceGroupPropertyList(gid, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.getDeviceGroupPropertyList: " + 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\Api\DeviceGroupsApi();
$gid = 56; // Integer | group ID
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DeviceGroupsApi->new();
my $gid = 56; # Integer | group ID
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device group properties api_response = api_instance.get_device_group_property_list(gid, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->getDeviceGroupPropertyList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceGroupPropertyListParams()
    
// get device group properties resp, err := client.LM.GetDeviceGroupPropertyList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceGroupPropertyList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
gid*
Integer (int32)
group ID
Required
Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceGroupSDTList

get device group SDTs


/device/groups/{id}/sdts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{id}/sdts?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            SDTPaginationResponse result = apiInstance.getDeviceGroupSDTList(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getDeviceGroupSDTList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device group SDTs
[apiInstance getDeviceGroupSDTListWith:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(SDTPaginationResponse 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.DeviceGroupsApi()

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.getDeviceGroupSDTList(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceGroupSDTListExample
    {
        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 DeviceGroupsApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device group SDTs
                SDTPaginationResponse result = apiInstance.getDeviceGroupSDTList(id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.getDeviceGroupSDTList: " + 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\Api\DeviceGroupsApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DeviceGroupsApi->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->getDeviceGroupSDTList(id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeviceGroupsApi->getDeviceGroupSDTList: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device group SDTs api_response = api_instance.get_device_group_sdt_list(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->getDeviceGroupSDTList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceGroupSDTListParams()
    
// get device group SDTs resp, err := client.LM.GetDeviceGroupSDTList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceGroupSDTList: %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


getImmediateDeviceListByDeviceGroupId

get immediate devices under group


/device/groups/{id}/devices

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{id}/devices?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DevicePaginationResponse result = apiInstance.getImmediateDeviceListByDeviceGroupId(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getImmediateDeviceListByDeviceGroupId");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get immediate devices under group
[apiInstance getImmediateDeviceListByDeviceGroupIdWith:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DevicePaginationResponse 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.DeviceGroupsApi()

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.getImmediateDeviceListByDeviceGroupId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getImmediateDeviceListByDeviceGroupIdExample
    {
        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 DeviceGroupsApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get immediate devices under group
                DevicePaginationResponse result = apiInstance.getImmediateDeviceListByDeviceGroupId(id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.getImmediateDeviceListByDeviceGroupId: " + 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\Api\DeviceGroupsApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DeviceGroupsApi->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->getImmediateDeviceListByDeviceGroupId(id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeviceGroupsApi->getImmediateDeviceListByDeviceGroupId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get immediate devices under group api_response = api_instance.get_immediate_device_list_by_device_group_id(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->getImmediateDeviceListByDeviceGroupId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetImmediateDeviceListByDeviceGroupIDParams()
    
// get immediate devices under group resp, err := client.LM.GetImmediateDeviceListByDeviceGroupID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetImmediateDeviceListByDeviceGroupID: %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


getSDTHistoryByDeviceGroupId

get SDT history for the group


/device/groups/{id}/historysdts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{id}/historysdts?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceGroupSDTHistoryPaginationResponse result = apiInstance.getSDTHistoryByDeviceGroupId(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#getSDTHistoryByDeviceGroupId");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get SDT history for the group
[apiInstance getSDTHistoryByDeviceGroupIdWith:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceGroupSDTHistoryPaginationResponse 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.DeviceGroupsApi()

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.getSDTHistoryByDeviceGroupId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getSDTHistoryByDeviceGroupIdExample
    {
        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 DeviceGroupsApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get SDT history for the group
                DeviceGroupSDTHistoryPaginationResponse result = apiInstance.getSDTHistoryByDeviceGroupId(id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.getSDTHistoryByDeviceGroupId: " + 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\Api\DeviceGroupsApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DeviceGroupsApi->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->getSDTHistoryByDeviceGroupId(id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DeviceGroupsApi->getSDTHistoryByDeviceGroupId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get SDT history for the group api_response = api_instance.get_sdt_history_by_device_group_id(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->getSDTHistoryByDeviceGroupId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetSDTHistoryByDeviceGroupIDParams()
    
// get SDT history for the group resp, err := client.LM.GetSDTHistoryByDeviceGroupID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetSDTHistoryByDeviceGroupID: %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


patchDeviceGroupById

update device group


/device/groups/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{id}?opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer id = 56; // Integer | 
        DeviceGroup body = ; // DeviceGroup | 
        String opType = opType_example; // String | 
        try {
            DeviceGroup result = apiInstance.patchDeviceGroupById(id, body, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#patchDeviceGroupById");
            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; // 
DeviceGroup *body = ; // 
String *opType = opType_example; //  (optional) (default to refresh)

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

// update device group
[apiInstance patchDeviceGroupByIdWith:id
    body:body
    opType:opType
              completionHandler: ^(DeviceGroup 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.DeviceGroupsApi()

var id = 56; // {Integer} 

var body = ; // {DeviceGroup} 

var opts = { 
  '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.patchDeviceGroupById(id, body, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchDeviceGroupByIdExample
    {
        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 DeviceGroupsApi();
            var id = 56;  // Integer | 
            var body = new DeviceGroup(); // DeviceGroup | 
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            try
            {
                // update device group
                DeviceGroup result = apiInstance.patchDeviceGroupById(id, body, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.patchDeviceGroupById: " + 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\Api\DeviceGroupsApi();
$id = 56; // Integer | 
$body = ; // DeviceGroup | 
$opType = opType_example; // String | 

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

# 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::DeviceGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DeviceGroup->new(); # DeviceGroup | 
my $opType = opType_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device group api_response = api_instance.patch_device_group_by_id(id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->patchDeviceGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDeviceGroupByIDParams()
    
// update device group resp, err := client.LM.PatchDeviceGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchDeviceGroupByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


patchDeviceGroupDatasourceById

update device group datasource


/device/groups/{deviceGroupId}/datasources/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{deviceGroupId}/datasources/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer deviceGroupId = 56; // Integer | 
        Integer id = 56; // Integer | 
        DeviceGroupDataSource body = ; // DeviceGroupDataSource | 
        try {
            DeviceGroupDataSource result = apiInstance.patchDeviceGroupDatasourceById(deviceGroupId, id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#patchDeviceGroupDatasourceById");
            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 *deviceGroupId = 56; // 
Integer *id = 56; // 
DeviceGroupDataSource *body = ; //  (optional)

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

// update device group datasource
[apiInstance patchDeviceGroupDatasourceByIdWith:deviceGroupId
    id:id
    body:body
              completionHandler: ^(DeviceGroupDataSource 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.DeviceGroupsApi()

var deviceGroupId = 56; // {Integer} 

var id = 56; // {Integer} 

var opts = { 
  'body':  // {DeviceGroupDataSource} 
};

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

namespace Example
{
    public class patchDeviceGroupDatasourceByIdExample
    {
        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 DeviceGroupsApi();
            var deviceGroupId = 56;  // Integer | 
            var id = 56;  // Integer | 
            var body = new DeviceGroupDataSource(); // DeviceGroupDataSource |  (optional) 

            try
            {
                // update device group datasource
                DeviceGroupDataSource result = apiInstance.patchDeviceGroupDatasourceById(deviceGroupId, id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.patchDeviceGroupDatasourceById: " + 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\Api\DeviceGroupsApi();
$deviceGroupId = 56; // Integer | 
$id = 56; // Integer | 
$body = ; // DeviceGroupDataSource | 

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

# 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::DeviceGroupsApi->new();
my $deviceGroupId = 56; # Integer | 
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DeviceGroupDataSource->new(); # DeviceGroupDataSource | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device group datasource api_response = api_instance.patch_device_group_datasource_by_id(deviceGroupId, id, ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->patchDeviceGroupDatasourceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDeviceGroupDatasourceByIDParams()
    
// update device group datasource resp, err := client.LM.PatchDeviceGroupDatasourceByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchDeviceGroupDatasourceByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


patchDeviceGroupPropertyByName

update device group property


/device/groups/{gid}/properties/{name}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{gid}/properties/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer gid = 56; // Integer | group ID
        String name = name_example; // String | 
        EntityProperty body = ; // EntityProperty | 
        try {
            EntityProperty result = apiInstance.patchDeviceGroupPropertyByName(gid, name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#patchDeviceGroupPropertyByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeviceGroupsApi;

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer gid = 56; // Integer | group ID
        String name = name_example; // String | 
        EntityProperty body = ; // EntityProperty | 
        try {
            EntityProperty result = apiInstance.patchDeviceGroupPropertyByName(gid, name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#patchDeviceGroupPropertyByName");
            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 *gid = 56; // group ID
String *name = name_example; // 
EntityProperty *body = ; // 

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

// update device group property
[apiInstance patchDeviceGroupPropertyByNameWith:gid
    name:name
    body:body
              completionHandler: ^(EntityProperty 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.DeviceGroupsApi()

var gid = 56; // {Integer} group ID

var name = name_example; // {String} 

var body = ; // {EntityProperty} 


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

namespace Example
{
    public class patchDeviceGroupPropertyByNameExample
    {
        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 DeviceGroupsApi();
            var gid = 56;  // Integer | group ID
            var name = name_example;  // String | 
            var body = new EntityProperty(); // EntityProperty | 

            try
            {
                // update device group property
                EntityProperty result = apiInstance.patchDeviceGroupPropertyByName(gid, name, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.patchDeviceGroupPropertyByName: " + 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\Api\DeviceGroupsApi();
$gid = 56; // Integer | group ID
$name = name_example; // String | 
$body = ; // EntityProperty | 

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

# 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::DeviceGroupsApi->new();
my $gid = 56; # Integer | group ID
my $name = name_example; # String | 
my $body = WWW::SwaggerClient::Object::EntityProperty->new(); # EntityProperty | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device group property api_response = api_instance.patch_device_group_property_by_name(gid, name, body) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->patchDeviceGroupPropertyByName: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDeviceGroupPropertyByNameParams()
    
// update device group property resp, err := client.LM.PatchDeviceGroupPropertyByName(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchDeviceGroupPropertyByName: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
gid*
Integer (int32)
group ID
Required
name*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


updateDeviceGroupById

update device group


/device/groups/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{id}?opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer id = 56; // Integer | 
        DeviceGroup body = ; // DeviceGroup | 
        String opType = opType_example; // String | 
        try {
            DeviceGroup result = apiInstance.updateDeviceGroupById(id, body, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#updateDeviceGroupById");
            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; // 
DeviceGroup *body = ; // 
String *opType = opType_example; //  (optional) (default to refresh)

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

// update device group
[apiInstance updateDeviceGroupByIdWith:id
    body:body
    opType:opType
              completionHandler: ^(DeviceGroup 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.DeviceGroupsApi()

var id = 56; // {Integer} 

var body = ; // {DeviceGroup} 

var opts = { 
  '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.updateDeviceGroupById(id, body, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateDeviceGroupByIdExample
    {
        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 DeviceGroupsApi();
            var id = 56;  // Integer | 
            var body = new DeviceGroup(); // DeviceGroup | 
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            try
            {
                // update device group
                DeviceGroup result = apiInstance.updateDeviceGroupById(id, body, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.updateDeviceGroupById: " + 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\Api\DeviceGroupsApi();
$id = 56; // Integer | 
$body = ; // DeviceGroup | 
$opType = opType_example; // String | 

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

# 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::DeviceGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DeviceGroup->new(); # DeviceGroup | 
my $opType = opType_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device group api_response = api_instance.update_device_group_by_id(id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->updateDeviceGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDeviceGroupByIDParams()
    
// update device group resp, err := client.LM.UpdateDeviceGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateDeviceGroupByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


updateDeviceGroupDatasourceById

update device group datasource


/device/groups/{deviceGroupId}/datasources/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{deviceGroupId}/datasources/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

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

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer deviceGroupId = 56; // Integer | 
        Integer id = 56; // Integer | 
        DeviceGroupDataSource body = ; // DeviceGroupDataSource | 
        try {
            DeviceGroupDataSource result = apiInstance.updateDeviceGroupDatasourceById(deviceGroupId, id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#updateDeviceGroupDatasourceById");
            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 *deviceGroupId = 56; // 
Integer *id = 56; // 
DeviceGroupDataSource *body = ; //  (optional)

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

// update device group datasource
[apiInstance updateDeviceGroupDatasourceByIdWith:deviceGroupId
    id:id
    body:body
              completionHandler: ^(DeviceGroupDataSource 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.DeviceGroupsApi()

var deviceGroupId = 56; // {Integer} 

var id = 56; // {Integer} 

var opts = { 
  'body':  // {DeviceGroupDataSource} 
};

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

namespace Example
{
    public class updateDeviceGroupDatasourceByIdExample
    {
        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 DeviceGroupsApi();
            var deviceGroupId = 56;  // Integer | 
            var id = 56;  // Integer | 
            var body = new DeviceGroupDataSource(); // DeviceGroupDataSource |  (optional) 

            try
            {
                // update device group datasource
                DeviceGroupDataSource result = apiInstance.updateDeviceGroupDatasourceById(deviceGroupId, id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.updateDeviceGroupDatasourceById: " + 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\Api\DeviceGroupsApi();
$deviceGroupId = 56; // Integer | 
$id = 56; // Integer | 
$body = ; // DeviceGroupDataSource | 

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

# 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::DeviceGroupsApi->new();
my $deviceGroupId = 56; # Integer | 
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DeviceGroupDataSource->new(); # DeviceGroupDataSource | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device group datasource api_response = api_instance.update_device_group_datasource_by_id(deviceGroupId, id, ) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->updateDeviceGroupDatasourceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDeviceGroupDatasourceByIDParams()
    
// update device group datasource resp, err := client.LM.UpdateDeviceGroupDatasourceByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateDeviceGroupDatasourceByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


updateDeviceGroupPropertyByName

update device group property


/device/groups/{gid}/properties/{name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{gid}/properties/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DeviceGroupsApi;

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

public class DeviceGroupsApiExample {

    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");

        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer gid = 56; // Integer | group ID
        String name = name_example; // String | 
        EntityProperty body = ; // EntityProperty | 
        try {
            EntityProperty result = apiInstance.updateDeviceGroupPropertyByName(gid, name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#updateDeviceGroupPropertyByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DeviceGroupsApi;

public class DeviceGroupsApiExample {

    public static void main(String[] args) {
        DeviceGroupsApi apiInstance = new DeviceGroupsApi();
        Integer gid = 56; // Integer | group ID
        String name = name_example; // String | 
        EntityProperty body = ; // EntityProperty | 
        try {
            EntityProperty result = apiInstance.updateDeviceGroupPropertyByName(gid, name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DeviceGroupsApi#updateDeviceGroupPropertyByName");
            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 *gid = 56; // group ID
String *name = name_example; // 
EntityProperty *body = ; // 

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

// update device group property
[apiInstance updateDeviceGroupPropertyByNameWith:gid
    name:name
    body:body
              completionHandler: ^(EntityProperty 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.DeviceGroupsApi()

var gid = 56; // {Integer} group ID

var name = name_example; // {String} 

var body = ; // {EntityProperty} 


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

namespace Example
{
    public class updateDeviceGroupPropertyByNameExample
    {
        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 DeviceGroupsApi();
            var gid = 56;  // Integer | group ID
            var name = name_example;  // String | 
            var body = new EntityProperty(); // EntityProperty | 

            try
            {
                // update device group property
                EntityProperty result = apiInstance.updateDeviceGroupPropertyByName(gid, name, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DeviceGroupsApi.updateDeviceGroupPropertyByName: " + 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\Api\DeviceGroupsApi();
$gid = 56; // Integer | group ID
$name = name_example; // String | 
$body = ; // EntityProperty | 

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

# 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::DeviceGroupsApi->new();
my $gid = 56; # Integer | group ID
my $name = name_example; # String | 
my $body = WWW::SwaggerClient::Object::EntityProperty->new(); # EntityProperty | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device group property api_response = api_instance.update_device_group_property_by_name(gid, name, body) pprint(api_response) except ApiException as e: print("Exception when calling DeviceGroupsApi->updateDeviceGroupPropertyByName: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDeviceGroupPropertyByNameParams()
    
// update device group property resp, err := client.LM.UpdateDeviceGroupPropertyByName(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateDeviceGroupPropertyByName: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
gid*
Integer (int32)
group ID
Required
name*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


Devices

addDevice

add a new device


/device/devices

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices?start=&end=&netflowFilter=&addFromWizard="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Device body = ; // Device | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        Boolean addFromWizard = true; // Boolean | 
        try {
            Device result = apiInstance.addDevice(body, start, end, netflowFilter, addFromWizard);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#addDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Device body = ; // Device | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        Boolean addFromWizard = true; // Boolean | 
        try {
            Device result = apiInstance.addDevice(body, start, end, netflowFilter, addFromWizard);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#addDevice");
            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"];

Device *body = ; // 
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
Boolean *addFromWizard = true; //  (optional) (default to false)

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

// add a new device
[apiInstance addDeviceWith:body
    start:start
    end:end
    netflowFilter:netflowFilter
    addFromWizard:addFromWizard
              completionHandler: ^(Device 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.DevicesApi()

var body = ; // {Device} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_example, // {String} 
  'addFromWizard': true // {Boolean} 
};

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

namespace Example
{
    public class addDeviceExample
    {
        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 DevicesApi();
            var body = new Device(); // Device | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var addFromWizard = true;  // Boolean |  (optional)  (default to false)

            try
            {
                // add a new device
                Device result = apiInstance.addDevice(body, start, end, netflowFilter, addFromWizard);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.addDevice: " + 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\Api\DevicesApi();
$body = ; // Device | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$addFromWizard = true; // Boolean | 

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

# 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::DevicesApi->new();
my $body = WWW::SwaggerClient::Object::Device->new(); # Device | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_example; # String | 
my $addFromWizard = true; # Boolean | 

eval { 
    my $result = $api_instance->addDevice(body => $body, start => $start, end => $end, netflowFilter => $netflowFilter, addFromWizard => $addFromWizard);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->addDevice: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add a new device api_response = api_instance.add_device(body, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->addDevice: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddDeviceParams()
    
// add a new device resp, err := client.LM.AddDevice(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDevice: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
addFromWizard
Boolean

Responses

Status: 200 - successful operation

Status: default - Error


addDeviceProperty

add device property


/device/devices/{deviceId}/properties

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/properties"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

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

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        EntityProperty body = ; // EntityProperty | 
        try {
            EntityProperty result = apiInstance.addDeviceProperty(deviceId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#addDeviceProperty");
            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; // 
EntityProperty *body = ; // 

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

// add device property
[apiInstance addDevicePropertyWith:deviceId
    body:body
              completionHandler: ^(EntityProperty 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.DevicesApi()

var deviceId = 56; // {Integer} 

var body = ; // {EntityProperty} 


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

namespace Example
{
    public class addDevicePropertyExample
    {
        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 DevicesApi();
            var deviceId = 56;  // Integer | 
            var body = new EntityProperty(); // EntityProperty | 

            try
            {
                // add device property
                EntityProperty result = apiInstance.addDeviceProperty(deviceId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.addDeviceProperty: " + 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\Api\DevicesApi();
$deviceId = 56; // Integer | 
$body = ; // EntityProperty | 

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

# 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::DevicesApi->new();
my $deviceId = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::EntityProperty->new(); # EntityProperty | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add device property api_response = api_instance.add_device_property(deviceId, body) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->addDeviceProperty: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddDevicePropertyParams()
    
// add device property resp, err := client.LM.AddDeviceProperty(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddDeviceProperty: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


deleteDeviceById

delete a device


/device/devices/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{id}?start=&end=&netflowFilter=&deleteHard="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        Boolean deleteHard = true; // Boolean | 
        try {
            Object result = apiInstance.deleteDeviceById(id, start, end, netflowFilter, deleteHard);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#deleteDeviceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        Boolean deleteHard = true; // Boolean | 
        try {
            Object result = apiInstance.deleteDeviceById(id, start, end, netflowFilter, deleteHard);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#deleteDeviceById");
            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 *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
Boolean *deleteHard = true; //  (optional) (default to true)

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

// delete a device
[apiInstance deleteDeviceByIdWith:id
    start:start
    end:end
    netflowFilter:netflowFilter
    deleteHard:deleteHard
              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.DevicesApi()

var id = 56; // {Integer} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_example, // {String} 
  'deleteHard': true // {Boolean} 
};

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

namespace Example
{
    public class deleteDeviceByIdExample
    {
        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 DevicesApi();
            var id = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var deleteHard = true;  // Boolean |  (optional)  (default to true)

            try
            {
                // delete a device
                Object result = apiInstance.deleteDeviceById(id, start, end, netflowFilter, deleteHard);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.deleteDeviceById: " + 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\Api\DevicesApi();
$id = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$deleteHard = true; // Boolean | 

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

# 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::DevicesApi->new();
my $id = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_example; # String | 
my $deleteHard = true; # Boolean | 

eval { 
    my $result = $api_instance->deleteDeviceById(id => $id, start => $start, end => $end, netflowFilter => $netflowFilter, deleteHard => $deleteHard);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->deleteDeviceById: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete a device api_response = api_instance.delete_device_by_id(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->deleteDeviceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDeviceByIDParams()
    
// delete a device resp, err := client.LM.DeleteDeviceByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteDeviceByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
deleteHard
Boolean

Responses

Status: 200 - successful operation

Status: default - Error


deleteDevicePropertyByName

delete device property


/device/devices/{deviceId}/properties/{name}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/properties/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        String name = name_example; // String | 
        try {
            Object result = apiInstance.deleteDevicePropertyByName(deviceId, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#deleteDevicePropertyByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        String name = name_example; // String | 
        try {
            Object result = apiInstance.deleteDevicePropertyByName(deviceId, name);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#deleteDevicePropertyByName");
            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; // 
String *name = name_example; // 

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

// delete device property
[apiInstance deleteDevicePropertyByNameWith:deviceId
    name:name
              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.DevicesApi()

var deviceId = 56; // {Integer} 

var name = name_example; // {String} 


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

namespace Example
{
    public class deleteDevicePropertyByNameExample
    {
        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 DevicesApi();
            var deviceId = 56;  // Integer | 
            var name = name_example;  // String | 

            try
            {
                // delete device property
                Object result = apiInstance.deleteDevicePropertyByName(deviceId, name);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.deleteDevicePropertyByName: " + 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\Api\DevicesApi();
$deviceId = 56; // Integer | 
$name = name_example; // String | 

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

# 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::DevicesApi->new();
my $deviceId = 56; # Integer | 
my $name = name_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete device property api_response = api_instance.delete_device_property_by_name(deviceId, name) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->deleteDevicePropertyByName: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteDevicePropertyByNameParams()
    
// delete device property resp, err := client.LM.DeleteDevicePropertyByName(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteDevicePropertyByName: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
name*
String
Required

Responses

Status: 200 - successful operation

Status: default - Error


getAlertListByDeviceId

get alerts


/device/devices/{id}/alerts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{id}/alerts?start=&end=&netflowFilter=&needMessage=&customColumns=&bound=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        Boolean needMessage = true; // Boolean | 
        String customColumns = customColumns_example; // String | 
        String bound = bound_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertPaginationResponse result = apiInstance.getAlertListByDeviceId(id, start, end, netflowFilter, needMessage, customColumns, bound, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getAlertListByDeviceId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        Boolean needMessage = true; // Boolean | 
        String customColumns = customColumns_example; // String | 
        String bound = bound_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertPaginationResponse result = apiInstance.getAlertListByDeviceId(id, start, end, netflowFilter, needMessage, customColumns, bound, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getAlertListByDeviceId");
            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 *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
Boolean *needMessage = true; //  (optional) (default to false)
String *customColumns = customColumns_example; //  (optional)
String *bound = bound_example; //  (optional) (default to instances)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get alerts
[apiInstance getAlertListByDeviceIdWith:id
    start:start
    end:end
    netflowFilter:netflowFilter
    needMessage:needMessage
    customColumns:customColumns
    bound:bound
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(AlertPaginationResponse 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.DevicesApi()

var id = 56; // {Integer} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_example, // {String} 
  'needMessage': true, // {Boolean} 
  'customColumns': customColumns_example, // {String} 
  'bound': bound_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.getAlertListByDeviceId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAlertListByDeviceIdExample
    {
        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 DevicesApi();
            var id = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var needMessage = true;  // Boolean |  (optional)  (default to false)
            var customColumns = customColumns_example;  // String |  (optional) 
            var bound = bound_example;  // String |  (optional)  (default to instances)
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get alerts
                AlertPaginationResponse result = apiInstance.getAlertListByDeviceId(id, start, end, netflowFilter, needMessage, customColumns, bound, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getAlertListByDeviceId: " + 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\Api\DevicesApi();
$id = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$needMessage = true; // Boolean | 
$customColumns = customColumns_example; // String | 
$bound = bound_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

try {
    $result = $api_instance->getAlertListByDeviceId($id, $start, $end, $netflowFilter, $needMessage, $customColumns, $bound, $fields, $size, $offset, $filter);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->getAlertListByDeviceId: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DevicesApi;

# 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::DevicesApi->new();
my $id = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_example; # String | 
my $needMessage = true; # Boolean | 
my $customColumns = customColumns_example; # String | 
my $bound = bound_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->getAlertListByDeviceId(id => $id, start => $start, end => $end, netflowFilter => $netflowFilter, needMessage => $needMessage, customColumns => $customColumns, bound => $bound, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getAlertListByDeviceId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get alerts api_response = api_instance.get_alert_list_by_device_id(id, , , , , , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getAlertListByDeviceId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAlertListByDeviceIDParams()
    
// get alerts resp, err := client.LM.GetAlertListByDeviceID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAlertListByDeviceID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
needMessage
Boolean
customColumns
String
bound
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getAllSDTListByDeviceId

get SDTs for a device


/device/devices/{id}/sdts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{id}/sdts?start=&end=&netflowFilter=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            SDTPaginationResponse result = apiInstance.getAllSDTListByDeviceId(id, start, end, netflowFilter, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getAllSDTListByDeviceId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            SDTPaginationResponse result = apiInstance.getAllSDTListByDeviceId(id, start, end, netflowFilter, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getAllSDTListByDeviceId");
            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 *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get SDTs for a device
[apiInstance getAllSDTListByDeviceIdWith:id
    start:start
    end:end
    netflowFilter:netflowFilter
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(SDTPaginationResponse 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.DevicesApi()

var id = 56; // {Integer} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_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.getAllSDTListByDeviceId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAllSDTListByDeviceIdExample
    {
        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 DevicesApi();
            var id = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get SDTs for a device
                SDTPaginationResponse result = apiInstance.getAllSDTListByDeviceId(id, start, end, netflowFilter, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getAllSDTListByDeviceId: " + 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\Api\DevicesApi();
$id = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DevicesApi->new();
my $id = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_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->getAllSDTListByDeviceId(id => $id, start => $start, end => $end, netflowFilter => $netflowFilter, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getAllSDTListByDeviceId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get SDTs for a device api_response = api_instance.get_all_sdt_list_by_device_id(id, , , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getAllSDTListByDeviceId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAllSDTListByDeviceIDParams()
    
// get SDTs for a device resp, err := client.LM.GetAllSDTListByDeviceID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAllSDTListByDeviceID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceById

get device by id


/device/devices/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{id}?start=&end=&netflowFilter=&fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        try {
            Device result = apiInstance.getDeviceById(id, start, end, netflowFilter, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        try {
            Device result = apiInstance.getDeviceById(id, start, end, netflowFilter, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceById");
            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 *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
String *fields = fields_example; //  (optional)

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

// get device by id
[apiInstance getDeviceByIdWith:id
    start:start
    end:end
    netflowFilter:netflowFilter
    fields:fields
              completionHandler: ^(Device 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.DevicesApi()

var id = 56; // {Integer} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_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.getDeviceById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceByIdExample
    {
        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 DevicesApi();
            var id = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get device by id
                Device result = apiInstance.getDeviceById(id, start, end, netflowFilter, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getDeviceById: " + 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\Api\DevicesApi();
$id = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$fields = fields_example; // String | 

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

# 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::DevicesApi->new();
my $id = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_example; # String | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device by id api_response = api_instance.get_device_by_id(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getDeviceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceByIDParams()
    
// get device by id resp, err := client.LM.GetDeviceByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
fields
String

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceDatasourceById

get device datasource


/device/devices/{deviceId}/devicedatasources/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

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

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            DeviceDataSource result = apiInstance.getDeviceDatasourceById(deviceId, id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceDatasourceById");
            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 *id = 56; // 
String *fields = fields_example; //  (optional)

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

// get device datasource 
[apiInstance getDeviceDatasourceByIdWith:deviceId
    id:id
    fields:fields
              completionHandler: ^(DeviceDataSource 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.DevicesApi()

var deviceId = 56; // {Integer} 

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.getDeviceDatasourceById(deviceId, id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceDatasourceByIdExample
    {
        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 DevicesApi();
            var deviceId = 56;  // Integer | 
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get device datasource 
                DeviceDataSource result = apiInstance.getDeviceDatasourceById(deviceId, id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getDeviceDatasourceById: " + 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\Api\DevicesApi();
$deviceId = 56; // Integer | 
$id = 56; // Integer | 
$fields = fields_example; // String | 

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

# 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::DevicesApi->new();
my $deviceId = 56; # Integer | 
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device datasource api_response = api_instance.get_device_datasource_by_id(deviceId, id, ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getDeviceDatasourceById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceByIDParams()
    
// get device datasource resp, err := client.LM.GetDeviceDatasourceByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceDatasourceDataById

get device datasource data


/device/devices/{deviceId}/devicedatasources/{id}/data

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources/{id}/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.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        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 | 
        String aggregate = aggregate_example; // String | the aggregate option
        try {
            DeviceDataSourceData result = apiInstance.getDeviceDatasourceDataById(deviceId, id, period, start, end, datapoints, format, aggregate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceDatasourceDataById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        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 | 
        String aggregate = aggregate_example; // String | the aggregate option
        try {
            DeviceDataSourceData result = apiInstance.getDeviceDatasourceDataById(deviceId, id, period, start, end, datapoints, format, aggregate);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceDatasourceDataById");
            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 *id = 56; // 
Double *period = 1.2; //  (optional) (default to 1.0)
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *datapoints = datapoints_example; //  (optional)
String *format = format_example; //  (optional) (default to json)
String *aggregate = aggregate_example; // the aggregate option (optional) (default to none)

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

// get device datasource data 
[apiInstance getDeviceDatasourceDataByIdWith:deviceId
    id:id
    period:period
    start:start
    end:end
    datapoints:datapoints
    format:format
    aggregate:aggregate
              completionHandler: ^(DeviceDataSourceData 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.DevicesApi()

var deviceId = 56; // {Integer} 

var id = 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.getDeviceDatasourceDataById(deviceId, id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceDatasourceDataByIdExample
    {
        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 DevicesApi();
            var deviceId = 56;  // Integer | 
            var id = 56;  // Integer | 
            var period = 1.2;  // Double |  (optional)  (default to 1.0)
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var datapoints = datapoints_example;  // String |  (optional) 
            var format = format_example;  // String |  (optional)  (default to json)
            var aggregate = aggregate_example;  // String | the aggregate option (optional)  (default to none)

            try
            {
                // get device datasource data 
                DeviceDataSourceData result = apiInstance.getDeviceDatasourceDataById(deviceId, id, period, start, end, datapoints, format, aggregate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getDeviceDatasourceDataById: " + 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\Api\DevicesApi();
$deviceId = 56; // Integer | 
$id = 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->getDeviceDatasourceDataById($deviceId, $id, $period, $start, $end, $datapoints, $format, $aggregate);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->getDeviceDatasourceDataById: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DevicesApi;

# 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::DevicesApi->new();
my $deviceId = 56; # Integer | 
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 | 
my $aggregate = aggregate_example; # String | the aggregate option

eval { 
    my $result = $api_instance->getDeviceDatasourceDataById(deviceId => $deviceId, id => $id, period => $period, start => $start, end => $end, datapoints => $datapoints, format => $format, aggregate => $aggregate);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getDeviceDatasourceDataById: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device datasource data api_response = api_instance.get_device_datasource_data_by_id(deviceId, id, , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getDeviceDatasourceDataById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceDataByIDParams()
    
// get device datasource data resp, err := client.LM.GetDeviceDatasourceDataByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceDataByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
id*
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


getDeviceDatasourceList

get device datasource list


/device/devices/{deviceId}/devicedatasources

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

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

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceDatasourcePaginationResponse result = apiInstance.getDeviceDatasourceList(deviceId, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceDatasourceList");
            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; // 
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device datasource list 
[apiInstance getDeviceDatasourceListWith:deviceId
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceDatasourcePaginationResponse 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.DevicesApi()

var deviceId = 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.getDeviceDatasourceList(deviceId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceDatasourceListExample
    {
        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 DevicesApi();
            var deviceId = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device datasource list 
                DeviceDatasourcePaginationResponse result = apiInstance.getDeviceDatasourceList(deviceId, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getDeviceDatasourceList: " + 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\Api\DevicesApi();
$deviceId = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DevicesApi->new();
my $deviceId = 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->getDeviceDatasourceList(deviceId => $deviceId, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getDeviceDatasourceList: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device datasource list api_response = api_instance.get_device_datasource_list(deviceId, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getDeviceDatasourceList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceListParams()
    
// get device datasource list resp, err := client.LM.GetDeviceDatasourceList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
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


getDeviceInstanceList

get device instance list


/device/devices/{id}/instances

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{id}/instances?start=&end=&netflowFilter=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceDatasourceInstancePaginationResponse result = apiInstance.getDeviceInstanceList(id, start, end, netflowFilter, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceInstanceList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceDatasourceInstancePaginationResponse result = apiInstance.getDeviceInstanceList(id, start, end, netflowFilter, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceInstanceList");
            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 *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device instance list
[apiInstance getDeviceInstanceListWith:id
    start:start
    end:end
    netflowFilter:netflowFilter
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceDatasourceInstancePaginationResponse 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.DevicesApi()

var id = 56; // {Integer} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_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.getDeviceInstanceList(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceInstanceListExample
    {
        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 DevicesApi();
            var id = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device instance list
                DeviceDatasourceInstancePaginationResponse result = apiInstance.getDeviceInstanceList(id, start, end, netflowFilter, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getDeviceInstanceList: " + 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\Api\DevicesApi();
$id = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DevicesApi->new();
my $id = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_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->getDeviceInstanceList(id => $id, start => $start, end => $end, netflowFilter => $netflowFilter, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getDeviceInstanceList: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device instance list api_response = api_instance.get_device_instance_list(id, , , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getDeviceInstanceList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceInstanceListParams()
    
// get device instance list resp, err := client.LM.GetDeviceInstanceList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceInstanceList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceList

get device list


/device/devices

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices?start=&end=&netflowFilter=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DevicePaginationResponse result = apiInstance.getDeviceList(start, end, netflowFilter, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DevicePaginationResponse result = apiInstance.getDeviceList(start, end, netflowFilter, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDeviceList");
            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"];

Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device list
[apiInstance getDeviceListWith:start
    end:end
    netflowFilter:netflowFilter
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DevicePaginationResponse 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.DevicesApi()

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_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.getDeviceList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceListExample
    {
        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 DevicesApi();
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device list
                DevicePaginationResponse result = apiInstance.getDeviceList(start, end, netflowFilter, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getDeviceList: " + 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\Api\DevicesApi();
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DevicesApi->new();
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_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->getDeviceList(start => $start, end => $end, netflowFilter => $netflowFilter, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getDeviceList: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device list api_response = api_instance.get_device_list(, , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getDeviceList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceListParams()
    
// get device list resp, err := client.LM.GetDeviceList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getDevicePropertyByName

get device property by name


/device/devices/{deviceId}/properties/{name}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/properties/{name}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        String name = name_example; // String | 
        String fields = fields_example; // String | 
        try {
            EntityProperty result = apiInstance.getDevicePropertyByName(deviceId, name, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDevicePropertyByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        String name = name_example; // String | 
        String fields = fields_example; // String | 
        try {
            EntityProperty result = apiInstance.getDevicePropertyByName(deviceId, name, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDevicePropertyByName");
            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; // 
String *name = name_example; // 
String *fields = fields_example; //  (optional)

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

// get device property by name
[apiInstance getDevicePropertyByNameWith:deviceId
    name:name
    fields:fields
              completionHandler: ^(EntityProperty 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.DevicesApi()

var deviceId = 56; // {Integer} 

var name = name_example; // {String} 

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.getDevicePropertyByName(deviceId, name, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDevicePropertyByNameExample
    {
        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 DevicesApi();
            var deviceId = 56;  // Integer | 
            var name = name_example;  // String | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get device property by name
                EntityProperty result = apiInstance.getDevicePropertyByName(deviceId, name, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getDevicePropertyByName: " + 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\Api\DevicesApi();
$deviceId = 56; // Integer | 
$name = name_example; // String | 
$fields = fields_example; // String | 

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

# 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::DevicesApi->new();
my $deviceId = 56; # Integer | 
my $name = name_example; # String | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device property by name api_response = api_instance.get_device_property_by_name(deviceId, name, ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getDevicePropertyByName: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDevicePropertyByNameParams()
    
// get device property by name resp, err := client.LM.GetDevicePropertyByName(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDevicePropertyByName: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


getDevicePropertyList

get device properties


/device/devices/{deviceId}/properties

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/properties?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

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

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            PropertyPaginationResponse result = apiInstance.getDevicePropertyList(deviceId, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getDevicePropertyList");
            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; // 
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get device properties
[apiInstance getDevicePropertyListWith:deviceId
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(PropertyPaginationResponse 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.DevicesApi()

var deviceId = 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.getDevicePropertyList(deviceId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDevicePropertyListExample
    {
        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 DevicesApi();
            var deviceId = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get device properties
                PropertyPaginationResponse result = apiInstance.getDevicePropertyList(deviceId, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getDevicePropertyList: " + 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\Api\DevicesApi();
$deviceId = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DevicesApi->new();
my $deviceId = 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->getDevicePropertyList(deviceId => $deviceId, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getDevicePropertyList: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device properties api_response = api_instance.get_device_property_list(deviceId, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getDevicePropertyList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDevicePropertyListParams()
    
// get device properties resp, err := client.LM.GetDevicePropertyList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDevicePropertyList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
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


getNetflowFlowList

get netflow flows


/device/devices/{id}/flows

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{id}/flows?start=&end=&netflowFilter=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            FlowRecordPaginationResponse result = apiInstance.getNetflowFlowList(id, start, end, netflowFilter, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getNetflowFlowList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            FlowRecordPaginationResponse result = apiInstance.getNetflowFlowList(id, start, end, netflowFilter, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getNetflowFlowList");
            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 *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get netflow flows
[apiInstance getNetflowFlowListWith:id
    start:start
    end:end
    netflowFilter:netflowFilter
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(FlowRecordPaginationResponse 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.DevicesApi()

var id = 56; // {Integer} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_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.getNetflowFlowList(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getNetflowFlowListExample
    {
        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 DevicesApi();
            var id = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get netflow flows
                FlowRecordPaginationResponse result = apiInstance.getNetflowFlowList(id, start, end, netflowFilter, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getNetflowFlowList: " + 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\Api\DevicesApi();
$id = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DevicesApi->new();
my $id = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_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->getNetflowFlowList(id => $id, start => $start, end => $end, netflowFilter => $netflowFilter, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getNetflowFlowList: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get netflow flows api_response = api_instance.get_netflow_flow_list(id, , , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getNetflowFlowList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetNetflowFlowListParams()
    
// get netflow flows resp, err := client.LM.GetNetflowFlowList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetNetflowFlowList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getSDTHistoryByDeviceDataSourceId

get SDT history for the device dataSource


/device/devices/{deviceId}/devicedatasources/{id}/historysdts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources/{id}/historysdts?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

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

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceDataSourceSDTHistoryPaginationResponse result = apiInstance.getSDTHistoryByDeviceDataSourceId(deviceId, id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getSDTHistoryByDeviceDataSourceId");
            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 *id = 56; // 
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get SDT history for the device dataSource
[apiInstance getSDTHistoryByDeviceDataSourceIdWith:deviceId
    id:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceDataSourceSDTHistoryPaginationResponse 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.DevicesApi()

var deviceId = 56; // {Integer} 

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.getSDTHistoryByDeviceDataSourceId(deviceId, id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getSDTHistoryByDeviceDataSourceIdExample
    {
        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 DevicesApi();
            var deviceId = 56;  // Integer | 
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get SDT history for the device dataSource
                DeviceDataSourceSDTHistoryPaginationResponse result = apiInstance.getSDTHistoryByDeviceDataSourceId(deviceId, id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getSDTHistoryByDeviceDataSourceId: " + 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\Api\DevicesApi();
$deviceId = 56; // Integer | 
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DevicesApi->new();
my $deviceId = 56; # Integer | 
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->getSDTHistoryByDeviceDataSourceId(deviceId => $deviceId, id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getSDTHistoryByDeviceDataSourceId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get SDT history for the device dataSource api_response = api_instance.get_sdt_history_by_device_data_source_id(deviceId, id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getSDTHistoryByDeviceDataSourceId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetSDTHistoryByDeviceDataSourceIDParams()
    
// get SDT history for the device dataSource resp, err := client.LM.GetSDTHistoryByDeviceDataSourceID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetSDTHistoryByDeviceDataSourceID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
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


getSDTHistoryByDeviceId

get SDT history for the device


/device/devices/{id}/historysdts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{id}/historysdts?start=&end=&netflowFilter=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceSDTHistoryPaginationResponse result = apiInstance.getSDTHistoryByDeviceId(id, start, end, netflowFilter, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getSDTHistoryByDeviceId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            DeviceSDTHistoryPaginationResponse result = apiInstance.getSDTHistoryByDeviceId(id, start, end, netflowFilter, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getSDTHistoryByDeviceId");
            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 *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get SDT history for the device
[apiInstance getSDTHistoryByDeviceIdWith:id
    start:start
    end:end
    netflowFilter:netflowFilter
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(DeviceSDTHistoryPaginationResponse 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.DevicesApi()

var id = 56; // {Integer} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_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.getSDTHistoryByDeviceId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getSDTHistoryByDeviceIdExample
    {
        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 DevicesApi();
            var id = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get SDT history for the device
                DeviceSDTHistoryPaginationResponse result = apiInstance.getSDTHistoryByDeviceId(id, start, end, netflowFilter, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getSDTHistoryByDeviceId: " + 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\Api\DevicesApi();
$id = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DevicesApi->new();
my $id = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_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->getSDTHistoryByDeviceId(id => $id, start => $start, end => $end, netflowFilter => $netflowFilter, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getSDTHistoryByDeviceId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get SDT history for the device api_response = api_instance.get_sdt_history_by_device_id(id, , , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getSDTHistoryByDeviceId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetSDTHistoryByDeviceIDParams()
    
// get SDT history for the device resp, err := client.LM.GetSDTHistoryByDeviceID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetSDTHistoryByDeviceID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getTopTalkersGraph

get top talkers graph


/device/devices/{id}/topTalkersGraph

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{id}/topTalkersGraph?start=&end=&netflowFilter=&format=&keyword="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String format = format_example; // String | 
        String keyword = keyword_example; // String | 
        try {
            GraphPlot result = apiInstance.getTopTalkersGraph(id, start, end, netflowFilter, format, keyword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getTopTalkersGraph");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String format = format_example; // String | 
        String keyword = keyword_example; // String | 
        try {
            GraphPlot result = apiInstance.getTopTalkersGraph(id, start, end, netflowFilter, format, keyword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getTopTalkersGraph");
            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 *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
String *format = format_example; //  (optional)
String *keyword = keyword_example; //  (optional)

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

// get top talkers graph
[apiInstance getTopTalkersGraphWith:id
    start:start
    end:end
    netflowFilter:netflowFilter
    format:format
    keyword:keyword
              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.DevicesApi()

var id = 56; // {Integer} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_example, // {String} 
  'format': format_example, // {String} 
  'keyword': keyword_example // {String} 
};

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

namespace Example
{
    public class getTopTalkersGraphExample
    {
        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 DevicesApi();
            var id = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var format = format_example;  // String |  (optional) 
            var keyword = keyword_example;  // String |  (optional) 

            try
            {
                // get top talkers graph
                GraphPlot result = apiInstance.getTopTalkersGraph(id, start, end, netflowFilter, format, keyword);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getTopTalkersGraph: " + 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\Api\DevicesApi();
$id = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$format = format_example; // String | 
$keyword = keyword_example; // String | 

try {
    $result = $api_instance->getTopTalkersGraph($id, $start, $end, $netflowFilter, $format, $keyword);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DevicesApi->getTopTalkersGraph: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::DevicesApi;

# 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::DevicesApi->new();
my $id = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_example; # String | 
my $format = format_example; # String | 
my $keyword = keyword_example; # String | 

eval { 
    my $result = $api_instance->getTopTalkersGraph(id => $id, start => $start, end => $end, netflowFilter => $netflowFilter, format => $format, keyword => $keyword);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling DevicesApi->getTopTalkersGraph: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get top talkers graph api_response = api_instance.get_top_talkers_graph(id, , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getTopTalkersGraph: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetTopTalkersGraphParams()
    
// get top talkers graph resp, err := client.LM.GetTopTalkersGraph(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetTopTalkersGraph: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
format
String
keyword
String

Responses

Status: 200 - successful operation

Status: default - Error


getUnmonitoredDeviceList

get unmonitored device list


/device/unmonitoreddevices

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/unmonitoreddevices?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

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

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            UnmonitoredDevicePaginationResponse result = apiInstance.getUnmonitoredDeviceList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#getUnmonitoredDeviceList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get unmonitored device list
[apiInstance getUnmonitoredDeviceListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(UnmonitoredDevicePaginationResponse 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.DevicesApi()

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.getUnmonitoredDeviceList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getUnmonitoredDeviceListExample
    {
        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 DevicesApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get unmonitored device list
                UnmonitoredDevicePaginationResponse result = apiInstance.getUnmonitoredDeviceList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.getUnmonitoredDeviceList: " + 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\Api\DevicesApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::DevicesApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get unmonitored device list api_response = api_instance.get_unmonitored_device_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->getUnmonitoredDeviceList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetUnmonitoredDeviceListParams()
    
// get unmonitored device list resp, err := client.LM.GetUnmonitoredDeviceList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetUnmonitoredDeviceList: %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


patchDevice

update a device


/device/devices/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{id}?start=&end=&netflowFilter=&opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Device body = ; // Device | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String opType = opType_example; // String | 
        try {
            Device result = apiInstance.patchDevice(id, body, start, end, netflowFilter, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#patchDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Device body = ; // Device | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String opType = opType_example; // String | 
        try {
            Device result = apiInstance.patchDevice(id, body, start, end, netflowFilter, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#patchDevice");
            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; // 
Device *body = ; // 
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
String *opType = opType_example; //  (optional) (default to refresh)

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

// update a device
[apiInstance patchDeviceWith:id
    body:body
    start:start
    end:end
    netflowFilter:netflowFilter
    opType:opType
              completionHandler: ^(Device 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.DevicesApi()

var id = 56; // {Integer} 

var body = ; // {Device} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_example, // {String} 
  '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.patchDevice(id, body, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchDeviceExample
    {
        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 DevicesApi();
            var id = 56;  // Integer | 
            var body = new Device(); // Device | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            try
            {
                // update a device
                Device result = apiInstance.patchDevice(id, body, start, end, netflowFilter, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.patchDevice: " + 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\Api\DevicesApi();
$id = 56; // Integer | 
$body = ; // Device | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$opType = opType_example; // String | 

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

# 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::DevicesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Device->new(); # Device | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_example; # String | 
my $opType = opType_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update a device api_response = api_instance.patch_device(id, body, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->patchDevice: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDeviceParams()
    
// update a device resp, err := client.LM.PatchDevice(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchDevice: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
opType
String

Responses

Status: 200 - successful operation

Status: default - Error


patchDevicePropertyByName

update device property


/device/devices/{deviceId}/properties/{name}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/properties/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        String name = name_example; // String | 
        EntityProperty body = ; // EntityProperty | 
        try {
            EntityProperty result = apiInstance.patchDevicePropertyByName(deviceId, name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#patchDevicePropertyByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        String name = name_example; // String | 
        EntityProperty body = ; // EntityProperty | 
        try {
            EntityProperty result = apiInstance.patchDevicePropertyByName(deviceId, name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#patchDevicePropertyByName");
            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; // 
String *name = name_example; // 
EntityProperty *body = ; // 

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

// update device property
[apiInstance patchDevicePropertyByNameWith:deviceId
    name:name
    body:body
              completionHandler: ^(EntityProperty 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.DevicesApi()

var deviceId = 56; // {Integer} 

var name = name_example; // {String} 

var body = ; // {EntityProperty} 


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

namespace Example
{
    public class patchDevicePropertyByNameExample
    {
        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 DevicesApi();
            var deviceId = 56;  // Integer | 
            var name = name_example;  // String | 
            var body = new EntityProperty(); // EntityProperty | 

            try
            {
                // update device property
                EntityProperty result = apiInstance.patchDevicePropertyByName(deviceId, name, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.patchDevicePropertyByName: " + 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\Api\DevicesApi();
$deviceId = 56; // Integer | 
$name = name_example; // String | 
$body = ; // EntityProperty | 

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

# 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::DevicesApi->new();
my $deviceId = 56; # Integer | 
my $name = name_example; # String | 
my $body = WWW::SwaggerClient::Object::EntityProperty->new(); # EntityProperty | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device property api_response = api_instance.patch_device_property_by_name(deviceId, name, body) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->patchDevicePropertyByName: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDevicePropertyByNameParams()
    
// update device property resp, err := client.LM.PatchDevicePropertyByName(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchDevicePropertyByName: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
name*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


scheduleAutoDiscoveryByDeviceId

schedule active discovery for a device


/device/devices/{id}/scheduleAutoDiscovery

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{id}/scheduleAutoDiscovery?start=&end=&netflowFilter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        try {
            Object result = apiInstance.scheduleAutoDiscoveryByDeviceId(id, start, end, netflowFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#scheduleAutoDiscoveryByDeviceId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        try {
            Object result = apiInstance.scheduleAutoDiscoveryByDeviceId(id, start, end, netflowFilter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#scheduleAutoDiscoveryByDeviceId");
            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 *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)

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

// schedule active discovery for a device
[apiInstance scheduleAutoDiscoveryByDeviceIdWith:id
    start:start
    end:end
    netflowFilter:netflowFilter
              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.DevicesApi()

var id = 56; // {Integer} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_example // {String} 
};

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

namespace Example
{
    public class scheduleAutoDiscoveryByDeviceIdExample
    {
        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 DevicesApi();
            var id = 56;  // Integer | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 

            try
            {
                // schedule active discovery for a device
                Object result = apiInstance.scheduleAutoDiscoveryByDeviceId(id, start, end, netflowFilter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.scheduleAutoDiscoveryByDeviceId: " + 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\Api\DevicesApi();
$id = 56; // Integer | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 

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

# 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::DevicesApi->new();
my $id = 56; # Integer | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # schedule active discovery for a device api_response = api_instance.schedule_auto_discovery_by_device_id(id, , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->scheduleAutoDiscoveryByDeviceId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewScheduleAutoDiscoveryByDeviceIDParams()
    
// schedule active discovery for a device resp, err := client.LM.ScheduleAutoDiscoveryByDeviceID(params) if err != nil { fmt.Printf("Exception when calling client.LM.ScheduleAutoDiscoveryByDeviceID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String

Responses

Status: 200 - successful operation

Status: default - Error


updateDevice

update a device


/device/devices/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{id}?start=&end=&netflowFilter=&opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Device body = ; // Device | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String opType = opType_example; // String | 
        try {
            Device result = apiInstance.updateDevice(id, body, start, end, netflowFilter, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#updateDevice");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer id = 56; // Integer | 
        Device body = ; // Device | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String netflowFilter = netflowFilter_example; // String | 
        String opType = opType_example; // String | 
        try {
            Device result = apiInstance.updateDevice(id, body, start, end, netflowFilter, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#updateDevice");
            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; // 
Device *body = ; // 
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *netflowFilter = netflowFilter_example; //  (optional)
String *opType = opType_example; //  (optional) (default to refresh)

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

// update a device
[apiInstance updateDeviceWith:id
    body:body
    start:start
    end:end
    netflowFilter:netflowFilter
    opType:opType
              completionHandler: ^(Device 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.DevicesApi()

var id = 56; // {Integer} 

var body = ; // {Device} 

var opts = { 
  'start': 789, // {Long} 
  'end': 789, // {Long} 
  'netflowFilter': netflowFilter_example, // {String} 
  '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.updateDevice(id, body, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateDeviceExample
    {
        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 DevicesApi();
            var id = 56;  // Integer | 
            var body = new Device(); // Device | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var netflowFilter = netflowFilter_example;  // String |  (optional) 
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            try
            {
                // update a device
                Device result = apiInstance.updateDevice(id, body, start, end, netflowFilter, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.updateDevice: " + 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\Api\DevicesApi();
$id = 56; // Integer | 
$body = ; // Device | 
$start = 789; // Long | 
$end = 789; // Long | 
$netflowFilter = netflowFilter_example; // String | 
$opType = opType_example; // String | 

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

# 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::DevicesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Device->new(); # Device | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $netflowFilter = netflowFilter_example; # String | 
my $opType = opType_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update a device api_response = api_instance.update_device(id, body, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->updateDevice: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDeviceParams()
    
// update a device resp, err := client.LM.UpdateDevice(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateDevice: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Body parameters
Name Description
body *
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
netflowFilter
String
opType
String

Responses

Status: 200 - successful operation

Status: default - Error


updateDevicePropertyByName

update device property


/device/devices/{deviceId}/properties/{name}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/properties/{name}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.DevicesApi;

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

public class DevicesApiExample {

    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");

        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        String name = name_example; // String | 
        EntityProperty body = ; // EntityProperty | 
        try {
            EntityProperty result = apiInstance.updateDevicePropertyByName(deviceId, name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#updateDevicePropertyByName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.DevicesApi;

public class DevicesApiExample {

    public static void main(String[] args) {
        DevicesApi apiInstance = new DevicesApi();
        Integer deviceId = 56; // Integer | 
        String name = name_example; // String | 
        EntityProperty body = ; // EntityProperty | 
        try {
            EntityProperty result = apiInstance.updateDevicePropertyByName(deviceId, name, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling DevicesApi#updateDevicePropertyByName");
            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; // 
String *name = name_example; // 
EntityProperty *body = ; // 

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

// update device property
[apiInstance updateDevicePropertyByNameWith:deviceId
    name:name
    body:body
              completionHandler: ^(EntityProperty 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.DevicesApi()

var deviceId = 56; // {Integer} 

var name = name_example; // {String} 

var body = ; // {EntityProperty} 


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

namespace Example
{
    public class updateDevicePropertyByNameExample
    {
        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 DevicesApi();
            var deviceId = 56;  // Integer | 
            var name = name_example;  // String | 
            var body = new EntityProperty(); // EntityProperty | 

            try
            {
                // update device property
                EntityProperty result = apiInstance.updateDevicePropertyByName(deviceId, name, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DevicesApi.updateDevicePropertyByName: " + 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\Api\DevicesApi();
$deviceId = 56; // Integer | 
$name = name_example; // String | 
$body = ; // EntityProperty | 

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

# 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::DevicesApi->new();
my $deviceId = 56; # Integer | 
my $name = name_example; # String | 
my $body = WWW::SwaggerClient::Object::EntityProperty->new(); # EntityProperty | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device property api_response = api_instance.update_device_property_by_name(deviceId, name, body) pprint(api_response) except ApiException as e: print("Exception when calling DevicesApi->updateDevicePropertyByName: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDevicePropertyByNameParams()
    
// update device property resp, err := client.LM.UpdateDevicePropertyByName(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateDevicePropertyByName: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
name*
String
Required
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


EscalationChains

addEscalationChain

add escalation chain


/setting/alert/chains

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/alert/chains"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EscalationChainsApi;

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

public class EscalationChainsApiExample {

    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");

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

public class EscalationChainsApiExample {

    public static void main(String[] args) {
        EscalationChainsApi apiInstance = new EscalationChainsApi();
        EscalatingChain body = ; // EscalatingChain | 
        try {
            EscalatingChain result = apiInstance.addEscalationChain(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EscalationChainsApi#addEscalationChain");
            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"];

EscalatingChain *body = ; // 

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

// add escalation chain
[apiInstance addEscalationChainWith:body
              completionHandler: ^(EscalatingChain 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.EscalationChainsApi()

var body = ; // {EscalatingChain} 


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

namespace Example
{
    public class addEscalationChainExample
    {
        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 EscalationChainsApi();
            var body = new EscalatingChain(); // EscalatingChain | 

            try
            {
                // add escalation chain
                EscalatingChain result = apiInstance.addEscalationChain(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EscalationChainsApi.addEscalationChain: " + 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\Api\EscalationChainsApi();
$body = ; // EscalatingChain | 

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

# 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::EscalationChainsApi->new();
my $body = WWW::SwaggerClient::Object::EscalatingChain->new(); # EscalatingChain | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add escalation chain api_response = api_instance.add_escalation_chain(body) pprint(api_response) except ApiException as e: print("Exception when calling EscalationChainsApi->addEscalationChain: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddEscalationChainParams()
    
// add escalation chain resp, err := client.LM.AddEscalationChain(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddEscalationChain: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


getEscalationChainById

get escalation chain by id


/setting/alert/chains/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/alert/chains/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EscalationChainsApi;

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

public class EscalationChainsApiExample {

    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");

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

public class EscalationChainsApiExample {

    public static void main(String[] args) {
        EscalationChainsApi apiInstance = new EscalationChainsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            EscalatingChain result = apiInstance.getEscalationChainById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EscalationChainsApi#getEscalationChainById");
            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)

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

// get escalation chain by id
[apiInstance getEscalationChainByIdWith:id
    fields:fields
              completionHandler: ^(EscalatingChain 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.EscalationChainsApi()

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.getEscalationChainById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getEscalationChainByIdExample
    {
        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 EscalationChainsApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get escalation chain by id
                EscalatingChain result = apiInstance.getEscalationChainById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EscalationChainsApi.getEscalationChainById: " + 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\Api\EscalationChainsApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 

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

# 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::EscalationChainsApi->new();
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get escalation chain by id api_response = api_instance.get_escalation_chain_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling EscalationChainsApi->getEscalationChainById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetEscalationChainByIDParams()
    
// get escalation chain by id resp, err := client.LM.GetEscalationChainByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetEscalationChainByID: %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


getEscalationChainList

get escalation chain list


/setting/alert/chains

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/alert/chains?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EscalationChainsApi;

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

public class EscalationChainsApiExample {

    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");

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

public class EscalationChainsApiExample {

    public static void main(String[] args) {
        EscalationChainsApi apiInstance = new EscalationChainsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            EscalationChainPaginationResponse result = apiInstance.getEscalationChainList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EscalationChainsApi#getEscalationChainList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get escalation chain list
[apiInstance getEscalationChainListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(EscalationChainPaginationResponse 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.EscalationChainsApi()

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.getEscalationChainList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getEscalationChainListExample
    {
        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 EscalationChainsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get escalation chain list
                EscalationChainPaginationResponse result = apiInstance.getEscalationChainList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EscalationChainsApi.getEscalationChainList: " + 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\Api\EscalationChainsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::EscalationChainsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get escalation chain list api_response = api_instance.get_escalation_chain_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling EscalationChainsApi->getEscalationChainList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetEscalationChainListParams()
    
// get escalation chain list resp, err := client.LM.GetEscalationChainList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetEscalationChainList: %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


patchEscalationChainById

update escalation chain


/setting/alert/chains/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/alert/chains/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EscalationChainsApi;

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

public class EscalationChainsApiExample {

    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");

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

public class EscalationChainsApiExample {

    public static void main(String[] args) {
        EscalationChainsApi apiInstance = new EscalationChainsApi();
        Integer id = 56; // Integer | 
        EscalatingChain body = ; // EscalatingChain | 
        try {
            EscalatingChain result = apiInstance.patchEscalationChainById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EscalationChainsApi#patchEscalationChainById");
            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; // 
EscalatingChain *body = ; // 

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

// update escalation chain
[apiInstance patchEscalationChainByIdWith:id
    body:body
              completionHandler: ^(EscalatingChain 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.EscalationChainsApi()

var id = 56; // {Integer} 

var body = ; // {EscalatingChain} 


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

namespace Example
{
    public class patchEscalationChainByIdExample
    {
        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 EscalationChainsApi();
            var id = 56;  // Integer | 
            var body = new EscalatingChain(); // EscalatingChain | 

            try
            {
                // update escalation chain
                EscalatingChain result = apiInstance.patchEscalationChainById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EscalationChainsApi.patchEscalationChainById: " + 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\Api\EscalationChainsApi();
$id = 56; // Integer | 
$body = ; // EscalatingChain | 

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

# 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::EscalationChainsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::EscalatingChain->new(); # EscalatingChain | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update escalation chain api_response = api_instance.patch_escalation_chain_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling EscalationChainsApi->patchEscalationChainById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchEscalationChainByIDParams()
    
// update escalation chain resp, err := client.LM.PatchEscalationChainByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchEscalationChainByID: %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


updateEscalationChainById

update escalation chain


/setting/alert/chains/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/alert/chains/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EscalationChainsApi;

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

public class EscalationChainsApiExample {

    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");

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

public class EscalationChainsApiExample {

    public static void main(String[] args) {
        EscalationChainsApi apiInstance = new EscalationChainsApi();
        Integer id = 56; // Integer | 
        EscalatingChain body = ; // EscalatingChain | 
        try {
            EscalatingChain result = apiInstance.updateEscalationChainById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EscalationChainsApi#updateEscalationChainById");
            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; // 
EscalatingChain *body = ; // 

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

// update escalation chain
[apiInstance updateEscalationChainByIdWith:id
    body:body
              completionHandler: ^(EscalatingChain 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.EscalationChainsApi()

var id = 56; // {Integer} 

var body = ; // {EscalatingChain} 


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

namespace Example
{
    public class updateEscalationChainByIdExample
    {
        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 EscalationChainsApi();
            var id = 56;  // Integer | 
            var body = new EscalatingChain(); // EscalatingChain | 

            try
            {
                // update escalation chain
                EscalatingChain result = apiInstance.updateEscalationChainById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EscalationChainsApi.updateEscalationChainById: " + 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\Api\EscalationChainsApi();
$id = 56; // Integer | 
$body = ; // EscalatingChain | 

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

# 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::EscalationChainsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::EscalatingChain->new(); # EscalatingChain | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update escalation chain api_response = api_instance.update_escalation_chain_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling EscalationChainsApi->updateEscalationChainById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateEscalationChainByIDParams()
    
// update escalation chain resp, err := client.LM.UpdateEscalationChainByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateEscalationChainByID: %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


EventSources

addEventsourceAuditVersion

add audit version


/setting/eventsources/{id}/audit

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/eventsources/{id}/audit"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventSourcesApi;

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

public class EventSourcesApiExample {

    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");

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

public class EventSourcesApiExample {

    public static void main(String[] args) {
        EventSourcesApi apiInstance = new EventSourcesApi();
        Integer id = 56; // Integer | 
        Audit body = ; // Audit | 
        try {
            EventSource result = apiInstance.addEventsourceAuditVersion(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventSourcesApi#addEventsourceAuditVersion");
            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; // 
Audit *body = ; //  (optional)

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

// add audit version
[apiInstance addEventsourceAuditVersionWith:id
    body:body
              completionHandler: ^(EventSource 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.EventSourcesApi()

var id = 56; // {Integer} 

var opts = { 
  'body':  // {Audit} 
};

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

namespace Example
{
    public class addEventsourceAuditVersionExample
    {
        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 EventSourcesApi();
            var id = 56;  // Integer | 
            var body = new Audit(); // Audit |  (optional) 

            try
            {
                // add audit version
                EventSource result = apiInstance.addEventsourceAuditVersion(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventSourcesApi.addEventsourceAuditVersion: " + 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\Api\EventSourcesApi();
$id = 56; // Integer | 
$body = ; // Audit | 

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

# 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::EventSourcesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Audit->new(); # Audit | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add audit version api_response = api_instance.add_eventsource_audit_version(id, ) pprint(api_response) except ApiException as e: print("Exception when calling EventSourcesApi->addEventsourceAuditVersion: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddEventsourceAuditVersionParams()
    
// add audit version resp, err := client.LM.AddEventsourceAuditVersion(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddEventsourceAuditVersion: %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


getEventSourceList

get eventSource list


/setting/eventsources

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/eventsources?format=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.EventSourcesApi;

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

public class EventSourcesApiExample {

    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");

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

public class EventSourcesApiExample {

    public static void main(String[] args) {
        EventSourcesApi apiInstance = new EventSourcesApi();
        String format = format_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            EventSourcePaginationResponse result = apiInstance.getEventSourceList(format, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling EventSourcesApi#getEventSourceList");
            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) (default to json)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get eventSource list
[apiInstance getEventSourceListWith:format
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(EventSourcePaginationResponse 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.EventSourcesApi()

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.getEventSourceList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getEventSourceListExample
    {
        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 EventSourcesApi();
            var format = format_example;  // String |  (optional)  (default to json)
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get eventSource list
                EventSourcePaginationResponse result = apiInstance.getEventSourceList(format, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling EventSourcesApi.getEventSourceList: " + 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\Api\EventSourcesApi();
$format = format_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::EventSourcesApi->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->getEventSourceList(format => $format, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling EventSourcesApi->getEventSourceList: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get eventSource list api_response = api_instance.get_event_source_list(, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling EventSourcesApi->getEventSourceList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetEventSourceListParams()
    
// get eventSource list resp, err := client.LM.GetEventSourceList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetEventSourceList: %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 - successful operation

Status: default - Error


IntegrationAuditLogs

getIntegrationAuditLogs

get integration audit logs list


/setting/integrations/auditlogs

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/integrations/auditlogs"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.IntegrationAuditLogsApi;

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

public class IntegrationAuditLogsApiExample {

    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");

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

public class IntegrationAuditLogsApiExample {

    public static void main(String[] args) {
        IntegrationAuditLogsApi apiInstance = new IntegrationAuditLogsApi();
        try {
            IntegrationAuditLogPaginationResponse result = apiInstance.getIntegrationAuditLogs();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling IntegrationAuditLogsApi#getIntegrationAuditLogs");
            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"];


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

// get integration audit logs list
[apiInstance getIntegrationAuditLogsWithCompletionHandler: 
              ^(IntegrationAuditLogPaginationResponse 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.IntegrationAuditLogsApi()

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

namespace Example
{
    public class getIntegrationAuditLogsExample
    {
        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 IntegrationAuditLogsApi();

            try
            {
                // get integration audit logs list
                IntegrationAuditLogPaginationResponse result = apiInstance.getIntegrationAuditLogs();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling IntegrationAuditLogsApi.getIntegrationAuditLogs: " + 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\Api\IntegrationAuditLogsApi();

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

# 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::IntegrationAuditLogsApi->new();

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
try:
    # get integration audit logs list
    api_response = api_instance.get_integration_audit_logs()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling IntegrationAuditLogsApi->getIntegrationAuditLogs: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetIntegrationAuditLogsParams()
// get integration audit logs list
resp, err := client.LM.GetIntegrationAuditLogs(params)
if err != nil {
fmt.Printf("Exception when calling client.LM.GetIntegrationAuditLogs: %v", err.Error())
}
fmt.Print(resp)
}

Parameters

Responses

Status: 200 - successful operation

Status: default - Error


Metrics

getMetricsUsage

get metrics usage


/metrics/usage

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/metrics/usage"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.MetricsApi;

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

public class MetricsApiExample {

    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");

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

public class MetricsApiExample {

    public static void main(String[] args) {
        MetricsApi apiInstance = new MetricsApi();
        try {
            Usage result = apiInstance.getMetricsUsage();
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling MetricsApi#getMetricsUsage");
            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"];


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

// get metrics usage
[apiInstance getMetricsUsageWithCompletionHandler: 
              ^(Usage 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.MetricsApi()

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

namespace Example
{
    public class getMetricsUsageExample
    {
        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 MetricsApi();

            try
            {
                // get metrics usage
                Usage result = apiInstance.getMetricsUsage();
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MetricsApi.getMetricsUsage: " + 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\Api\MetricsApi();

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

# 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::MetricsApi->new();

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
try:
    # get metrics usage
    api_response = api_instance.get_metrics_usage()
    pprint(api_response)
except ApiException as e:
    print("Exception when calling MetricsApi->getMetricsUsage: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetMetricsUsageParams()
// get metrics usage
resp, err := client.LM.GetMetricsUsage(params)
if err != nil {
fmt.Printf("Exception when calling client.LM.GetMetricsUsage: %v", err.Error())
}
fmt.Print(resp)
}

Parameters

Responses

Status: 200 - successful operation

Status: default - Error


Netscans

addNetscan

add a new netscan


/setting/netscans

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/netscans"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NetscansApi;

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

public class NetscansApiExample {

    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");

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

public class NetscansApiExample {

    public static void main(String[] args) {
        NetscansApi apiInstance = new NetscansApi();
        Netscan body = ; // Netscan | 
        try {
            Netscan result = apiInstance.addNetscan(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetscansApi#addNetscan");
            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"];

Netscan *body = ; //  (optional)

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

// add a new netscan
[apiInstance addNetscanWith:body
              completionHandler: ^(Netscan 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.NetscansApi()

var opts = { 
  'body':  // {Netscan} 
};

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

namespace Example
{
    public class addNetscanExample
    {
        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 NetscansApi();
            var body = new Netscan(); // Netscan |  (optional) 

            try
            {
                // add a new netscan
                Netscan result = apiInstance.addNetscan(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetscansApi.addNetscan: " + 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\Api\NetscansApi();
$body = ; // Netscan | 

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

# 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::NetscansApi->new();
my $body = WWW::SwaggerClient::Object::Netscan->new(); # Netscan | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add a new netscan api_response = api_instance.add_netscan() pprint(api_response) except ApiException as e: print("Exception when calling NetscansApi->addNetscan: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddNetscanParams()
    
// add a new netscan resp, err := client.LM.AddNetscan(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddNetscan: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body

Responses

Status: 200 - successful operation

Status: default - Error


getNetscanById

get netscan by id


/setting/netscans/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/netscans/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NetscansApi;

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

public class NetscansApiExample {

    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");

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

public class NetscansApiExample {

    public static void main(String[] args) {
        NetscansApi apiInstance = new NetscansApi();
        Integer id = 56; // Integer | 
        try {
            Netscan result = apiInstance.getNetscanById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetscansApi#getNetscanById");
            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; // 

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

// get netscan by id
[apiInstance getNetscanByIdWith:id
              completionHandler: ^(Netscan 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.NetscansApi()

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.getNetscanById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getNetscanByIdExample
    {
        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 NetscansApi();
            var id = 56;  // Integer | 

            try
            {
                // get netscan by id
                Netscan result = apiInstance.getNetscanById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetscansApi.getNetscanById: " + 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\Api\NetscansApi();
$id = 56; // Integer | 

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

# 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::NetscansApi->new();
my $id = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get netscan by id api_response = api_instance.get_netscan_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling NetscansApi->getNetscanById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetNetscanByIDParams()
    
// get netscan by id resp, err := client.LM.GetNetscanByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetNetscanByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


getNetscanList

get netscan list


/setting/netscans

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/netscans?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.NetscansApi;

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

public class NetscansApiExample {

    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");

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

public class NetscansApiExample {

    public static void main(String[] args) {
        NetscansApi apiInstance = new NetscansApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            NetscanPaginationResponse result = apiInstance.getNetscanList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling NetscansApi#getNetscanList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get netscan list
[apiInstance getNetscanListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(NetscanPaginationResponse 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.NetscansApi()

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.getNetscanList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getNetscanListExample
    {
        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 NetscansApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get netscan list
                NetscanPaginationResponse result = apiInstance.getNetscanList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling NetscansApi.getNetscanList: " + 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\Api\NetscansApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::NetscansApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get netscan list api_response = api_instance.get_netscan_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling NetscansApi->getNetscanList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetNetscanListParams()
    
// get netscan list resp, err := client.LM.GetNetscanList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetNetscanList: %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


OpsNotes

addOpsNote

add opsnote


/setting/opsnotes

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/opsnotes"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OpsNotesApi;

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

public class OpsNotesApiExample {

    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");

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

public class OpsNotesApiExample {

    public static void main(String[] args) {
        OpsNotesApi apiInstance = new OpsNotesApi();
        OpsNote body = ; // OpsNote | 
        try {
            OpsNote result = apiInstance.addOpsNote(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OpsNotesApi#addOpsNote");
            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"];

OpsNote *body = ; // 

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

// add opsnote
[apiInstance addOpsNoteWith:body
              completionHandler: ^(OpsNote 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.OpsNotesApi()

var body = ; // {OpsNote} 


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

namespace Example
{
    public class addOpsNoteExample
    {
        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 OpsNotesApi();
            var body = new OpsNote(); // OpsNote | 

            try
            {
                // add opsnote
                OpsNote result = apiInstance.addOpsNote(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OpsNotesApi.addOpsNote: " + 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\Api\OpsNotesApi();
$body = ; // OpsNote | 

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

# 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::OpsNotesApi->new();
my $body = WWW::SwaggerClient::Object::OpsNote->new(); # OpsNote | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add opsnote api_response = api_instance.add_ops_note(body) pprint(api_response) except ApiException as e: print("Exception when calling OpsNotesApi->addOpsNote: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddOpsNoteParams()
    
// add opsnote resp, err := client.LM.AddOpsNote(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddOpsNote: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


getOpsNoteList

get opsnote list


/setting/opsnotes

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/opsnotes?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.OpsNotesApi;

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

public class OpsNotesApiExample {

    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");

        OpsNotesApi apiInstance = new OpsNotesApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | Filter the response based on tags, createdBy, happenedOn, monitorObjectGroups, monitorObjectNames, or _all field values
        try {
            OpsNotePaginationResponse result = apiInstance.getOpsNoteList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OpsNotesApi#getOpsNoteList");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.OpsNotesApi;

public class OpsNotesApiExample {

    public static void main(String[] args) {
        OpsNotesApi apiInstance = new OpsNotesApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | Filter the response based on tags, createdBy, happenedOn, monitorObjectGroups, monitorObjectNames, or _all field values
        try {
            OpsNotePaginationResponse result = apiInstance.getOpsNoteList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling OpsNotesApi#getOpsNoteList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; // Filter the response based on tags, createdBy, happenedOn, monitorObjectGroups, monitorObjectNames, or _all field values (optional)

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

// get opsnote list
[apiInstance getOpsNoteListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(OpsNotePaginationResponse 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.OpsNotesApi()

var opts = { 
  'fields': fields_example, // {String} 
  'size': 56, // {Integer} 
  'offset': 56, // {Integer} 
  'filter': filter_example // {String} Filter the response based on tags, createdBy, happenedOn, monitorObjectGroups, monitorObjectNames, or _all field values
};

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

namespace Example
{
    public class getOpsNoteListExample
    {
        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 OpsNotesApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String | Filter the response based on tags, createdBy, happenedOn, monitorObjectGroups, monitorObjectNames, or _all field values (optional) 

            try
            {
                // get opsnote list
                OpsNotePaginationResponse result = apiInstance.getOpsNoteList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OpsNotesApi.getOpsNoteList: " + 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\Api\OpsNotesApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | Filter the response based on tags, createdBy, happenedOn, monitorObjectGroups, monitorObjectNames, or _all field values

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

# 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::OpsNotesApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | Filter the response based on tags, createdBy, happenedOn, monitorObjectGroups, monitorObjectNames, or _all field values

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get opsnote list api_response = api_instance.get_ops_note_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling OpsNotesApi->getOpsNoteList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetOpsNoteListParams()
    
// get opsnote list resp, err := client.LM.GetOpsNoteList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetOpsNoteList: %v", err.Error()) } fmt.Print(resp) }

Parameters

Query parameters
Name Description
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String
Filter the response based on tags, createdBy, happenedOn, monitorObjectGroups, monitorObjectNames, or _all field values

Responses

Status: 200 - successful operation

Status: default - Error


PropertySources

addPropertysourceAuditVersion

add audit version


/setting/propertyrules/{id}/audit

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/propertyrules/{id}/audit"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.PropertySourcesApi;

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

public class PropertySourcesApiExample {

    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");

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

public class PropertySourcesApiExample {

    public static void main(String[] args) {
        PropertySourcesApi apiInstance = new PropertySourcesApi();
        Integer id = 56; // Integer | 
        Audit body = ; // Audit | 
        try {
            PropertyRule result = apiInstance.addPropertysourceAuditVersion(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling PropertySourcesApi#addPropertysourceAuditVersion");
            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; // 
Audit *body = ; //  (optional)

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

// add audit version
[apiInstance addPropertysourceAuditVersionWith:id
    body:body
              completionHandler: ^(PropertyRule 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.PropertySourcesApi()

var id = 56; // {Integer} 

var opts = { 
  'body':  // {Audit} 
};

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

namespace Example
{
    public class addPropertysourceAuditVersionExample
    {
        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 PropertySourcesApi();
            var id = 56;  // Integer | 
            var body = new Audit(); // Audit |  (optional) 

            try
            {
                // add audit version
                PropertyRule result = apiInstance.addPropertysourceAuditVersion(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling PropertySourcesApi.addPropertysourceAuditVersion: " + 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\Api\PropertySourcesApi();
$id = 56; // Integer | 
$body = ; // Audit | 

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

# 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::PropertySourcesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Audit->new(); # Audit | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add audit version api_response = api_instance.add_propertysource_audit_version(id, ) pprint(api_response) except ApiException as e: print("Exception when calling PropertySourcesApi->addPropertysourceAuditVersion: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddPropertysourceAuditVersionParams()
    
// add audit version resp, err := client.LM.AddPropertysourceAuditVersion(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddPropertysourceAuditVersion: %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


RecipientGroups

addRecipientGroup

add recipient group


/setting/recipientgroups

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/recipientgroups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RecipientGroupsApi;

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

public class RecipientGroupsApiExample {

    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");

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

public class RecipientGroupsApiExample {

    public static void main(String[] args) {
        RecipientGroupsApi apiInstance = new RecipientGroupsApi();
        RecipientGroup body = ; // RecipientGroup | 
        try {
            RecipientGroup result = apiInstance.addRecipientGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecipientGroupsApi#addRecipientGroup");
            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"];

RecipientGroup *body = ; // 

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

// add recipient group
[apiInstance addRecipientGroupWith:body
              completionHandler: ^(RecipientGroup 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.RecipientGroupsApi()

var body = ; // {RecipientGroup} 


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

namespace Example
{
    public class addRecipientGroupExample
    {
        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 RecipientGroupsApi();
            var body = new RecipientGroup(); // RecipientGroup | 

            try
            {
                // add recipient group
                RecipientGroup result = apiInstance.addRecipientGroup(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecipientGroupsApi.addRecipientGroup: " + 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\Api\RecipientGroupsApi();
$body = ; // RecipientGroup | 

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

# 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::RecipientGroupsApi->new();
my $body = WWW::SwaggerClient::Object::RecipientGroup->new(); # RecipientGroup | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add recipient group api_response = api_instance.add_recipient_group(body) pprint(api_response) except ApiException as e: print("Exception when calling RecipientGroupsApi->addRecipientGroup: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddRecipientGroupParams()
    
// add recipient group resp, err := client.LM.AddRecipientGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddRecipientGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


getRecipientGroupById

get recipient group by id


/setting/recipientgroups/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/recipientgroups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RecipientGroupsApi;

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

public class RecipientGroupsApiExample {

    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");

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

public class RecipientGroupsApiExample {

    public static void main(String[] args) {
        RecipientGroupsApi apiInstance = new RecipientGroupsApi();
        Integer id = 56; // Integer | 
        try {
            RecipientGroup result = apiInstance.getRecipientGroupById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecipientGroupsApi#getRecipientGroupById");
            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; // 

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

// get recipient group by id
[apiInstance getRecipientGroupByIdWith:id
              completionHandler: ^(RecipientGroup 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.RecipientGroupsApi()

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.getRecipientGroupById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getRecipientGroupByIdExample
    {
        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 RecipientGroupsApi();
            var id = 56;  // Integer | 

            try
            {
                // get recipient group by id
                RecipientGroup result = apiInstance.getRecipientGroupById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecipientGroupsApi.getRecipientGroupById: " + 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\Api\RecipientGroupsApi();
$id = 56; // Integer | 

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

# 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::RecipientGroupsApi->new();
my $id = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get recipient group by id api_response = api_instance.get_recipient_group_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling RecipientGroupsApi->getRecipientGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetRecipientGroupByIDParams()
    
// get recipient group by id resp, err := client.LM.GetRecipientGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetRecipientGroupByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


getRecipientGroupList

get recipient group List


/setting/recipientgroups

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/recipientgroups?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RecipientGroupsApi;

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

public class RecipientGroupsApiExample {

    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");

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

public class RecipientGroupsApiExample {

    public static void main(String[] args) {
        RecipientGroupsApi apiInstance = new RecipientGroupsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            RecipientGroupPaginationResponse result = apiInstance.getRecipientGroupList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecipientGroupsApi#getRecipientGroupList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get recipient group List
[apiInstance getRecipientGroupListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(RecipientGroupPaginationResponse 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.RecipientGroupsApi()

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.getRecipientGroupList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getRecipientGroupListExample
    {
        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 RecipientGroupsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get recipient group List
                RecipientGroupPaginationResponse result = apiInstance.getRecipientGroupList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecipientGroupsApi.getRecipientGroupList: " + 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\Api\RecipientGroupsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::RecipientGroupsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get recipient group List api_response = api_instance.get_recipient_group_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling RecipientGroupsApi->getRecipientGroupList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetRecipientGroupListParams()
    
// get recipient group List resp, err := client.LM.GetRecipientGroupList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetRecipientGroupList: %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


patchRecipientGroupById

update recipient group


/setting/recipientgroups/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/recipientgroups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RecipientGroupsApi;

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

public class RecipientGroupsApiExample {

    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");

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

public class RecipientGroupsApiExample {

    public static void main(String[] args) {
        RecipientGroupsApi apiInstance = new RecipientGroupsApi();
        Integer id = 56; // Integer | 
        RecipientGroup body = ; // RecipientGroup | 
        try {
            RecipientGroup result = apiInstance.patchRecipientGroupById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecipientGroupsApi#patchRecipientGroupById");
            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; // 
RecipientGroup *body = ; // 

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

// update recipient group
[apiInstance patchRecipientGroupByIdWith:id
    body:body
              completionHandler: ^(RecipientGroup 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.RecipientGroupsApi()

var id = 56; // {Integer} 

var body = ; // {RecipientGroup} 


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

namespace Example
{
    public class patchRecipientGroupByIdExample
    {
        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 RecipientGroupsApi();
            var id = 56;  // Integer | 
            var body = new RecipientGroup(); // RecipientGroup | 

            try
            {
                // update recipient group
                RecipientGroup result = apiInstance.patchRecipientGroupById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecipientGroupsApi.patchRecipientGroupById: " + 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\Api\RecipientGroupsApi();
$id = 56; // Integer | 
$body = ; // RecipientGroup | 

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

# 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::RecipientGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::RecipientGroup->new(); # RecipientGroup | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update recipient group api_response = api_instance.patch_recipient_group_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling RecipientGroupsApi->patchRecipientGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchRecipientGroupByIDParams()
    
// update recipient group resp, err := client.LM.PatchRecipientGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchRecipientGroupByID: %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


updateRecipientGroupById

update recipient group


/setting/recipientgroups/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/recipientgroups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RecipientGroupsApi;

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

public class RecipientGroupsApiExample {

    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");

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

public class RecipientGroupsApiExample {

    public static void main(String[] args) {
        RecipientGroupsApi apiInstance = new RecipientGroupsApi();
        Integer id = 56; // Integer | 
        RecipientGroup body = ; // RecipientGroup | 
        try {
            RecipientGroup result = apiInstance.updateRecipientGroupById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RecipientGroupsApi#updateRecipientGroupById");
            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; // 
RecipientGroup *body = ; // 

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

// update recipient group
[apiInstance updateRecipientGroupByIdWith:id
    body:body
              completionHandler: ^(RecipientGroup 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.RecipientGroupsApi()

var id = 56; // {Integer} 

var body = ; // {RecipientGroup} 


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

namespace Example
{
    public class updateRecipientGroupByIdExample
    {
        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 RecipientGroupsApi();
            var id = 56;  // Integer | 
            var body = new RecipientGroup(); // RecipientGroup | 

            try
            {
                // update recipient group
                RecipientGroup result = apiInstance.updateRecipientGroupById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RecipientGroupsApi.updateRecipientGroupById: " + 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\Api\RecipientGroupsApi();
$id = 56; // Integer | 
$body = ; // RecipientGroup | 

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

# 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::RecipientGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::RecipientGroup->new(); # RecipientGroup | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update recipient group api_response = api_instance.update_recipient_group_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling RecipientGroupsApi->updateRecipientGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateRecipientGroupByIDParams()
    
// update recipient group resp, err := client.LM.UpdateRecipientGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateRecipientGroupByID: %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


Report

addReport

add report


/report/reports

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/reports"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

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

public class ReportApiExample {

    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");

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

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        ReportBase body = ; // ReportBase | 
        try {
            ReportBase result = apiInstance.addReport(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#addReport");
            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"];

ReportBase *body = ; // 

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

// add report
[apiInstance addReportWith:body
              completionHandler: ^(ReportBase 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.ReportApi()

var body = ; // {ReportBase} 


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

namespace Example
{
    public class addReportExample
    {
        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 ReportApi();
            var body = new ReportBase(); // ReportBase | 

            try
            {
                // add report
                ReportBase result = apiInstance.addReport(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.addReport: " + 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\Api\ReportApi();
$body = ; // ReportBase | 

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

# 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::ReportApi->new();
my $body = WWW::SwaggerClient::Object::ReportBase->new(); # ReportBase | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add report api_response = api_instance.add_report(body) pprint(api_response) except ApiException as e: print("Exception when calling ReportApi->addReport: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddReportParams()
    
// add report resp, err := client.LM.AddReport(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddReport: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


deleteReportById

delete report


/report/reports/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/reports/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

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

public class ReportApiExample {

    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");

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

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteReportById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#deleteReportById");
            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; // 

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

// delete report
[apiInstance deleteReportByIdWith: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.ReportApi()

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.deleteReportById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteReportByIdExample
    {
        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 ReportApi();
            var id = 56;  // Integer | 

            try
            {
                // delete report
                Object result = apiInstance.deleteReportById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.deleteReportById: " + 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\Api\ReportApi();
$id = 56; // Integer | 

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

# 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::ReportApi->new();
my $id = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete report api_response = api_instance.delete_report_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling ReportApi->deleteReportById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteReportByIDParams()
    
// delete report resp, err := client.LM.DeleteReportByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteReportByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


generateReportById

run a report


/report/reports/{id}/executions

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/reports/{id}/executions"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

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

public class ReportApiExample {

    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");

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

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        Integer id = 56; // Integer | 
        GenerateReportRequest body = ; // GenerateReportRequest | 
        try {
            GenerateReportResult result = apiInstance.generateReportById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#generateReportById");
            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; // 
GenerateReportRequest *body = ; //  (optional)

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

// run a report
[apiInstance generateReportByIdWith:id
    body:body
              completionHandler: ^(GenerateReportResult 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.ReportApi()

var id = 56; // {Integer} 

var opts = { 
  'body':  // {GenerateReportRequest} 
};

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

namespace Example
{
    public class generateReportByIdExample
    {
        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 ReportApi();
            var id = 56;  // Integer | 
            var body = new GenerateReportRequest(); // GenerateReportRequest |  (optional) 

            try
            {
                // run a report
                GenerateReportResult result = apiInstance.generateReportById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.generateReportById: " + 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\Api\ReportApi();
$id = 56; // Integer | 
$body = ; // GenerateReportRequest | 

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

# 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::ReportApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::GenerateReportRequest->new(); # GenerateReportRequest | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # run a report api_response = api_instance.generate_report_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling ReportApi->generateReportById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGenerateReportByIDParams()
    
// run a report resp, err := client.LM.GenerateReportByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GenerateReportByID: %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


getReportById

get report by id


/report/reports/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/reports/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

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

public class ReportApiExample {

    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");

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

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            ReportBase result = apiInstance.getReportById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getReportById");
            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)

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

// get report by id
[apiInstance getReportByIdWith:id
    fields:fields
              completionHandler: ^(ReportBase 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.ReportApi()

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.getReportById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getReportByIdExample
    {
        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 ReportApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get report by id
                ReportBase result = apiInstance.getReportById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getReportById: " + 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\Api\ReportApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 

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

# 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::ReportApi->new();
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get report by id api_response = api_instance.get_report_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling ReportApi->getReportById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetReportByIDParams()
    
// get report by id resp, err := client.LM.GetReportByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetReportByID: %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


getReportList

get report list


/report/reports

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/reports?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

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

public class ReportApiExample {

    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");

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

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            ReportPaginationResponse result = apiInstance.getReportList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#getReportList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get report list
[apiInstance getReportListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(ReportPaginationResponse 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.ReportApi()

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.getReportList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getReportListExample
    {
        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 ReportApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get report list
                ReportPaginationResponse result = apiInstance.getReportList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.getReportList: " + 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\Api\ReportApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::ReportApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get report list api_response = api_instance.get_report_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling ReportApi->getReportList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetReportListParams()
    
// get report list resp, err := client.LM.GetReportList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetReportList: %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


patchReportById

update report


/report/reports/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/reports/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

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

public class ReportApiExample {

    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");

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

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        Integer id = 56; // Integer | 
        ReportBase body = ; // ReportBase | 
        try {
            ReportBase result = apiInstance.patchReportById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#patchReportById");
            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; // 
ReportBase *body = ; // 

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

// update report
[apiInstance patchReportByIdWith:id
    body:body
              completionHandler: ^(ReportBase 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.ReportApi()

var id = 56; // {Integer} 

var body = ; // {ReportBase} 


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

namespace Example
{
    public class patchReportByIdExample
    {
        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 ReportApi();
            var id = 56;  // Integer | 
            var body = new ReportBase(); // ReportBase | 

            try
            {
                // update report
                ReportBase result = apiInstance.patchReportById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.patchReportById: " + 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\Api\ReportApi();
$id = 56; // Integer | 
$body = ; // ReportBase | 

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

# 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::ReportApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::ReportBase->new(); # ReportBase | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update report api_response = api_instance.patch_report_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling ReportApi->patchReportById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchReportByIDParams()
    
// update report resp, err := client.LM.PatchReportByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchReportByID: %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


updateReportById

update report


/report/reports/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/reports/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportApi;

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

public class ReportApiExample {

    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");

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

public class ReportApiExample {

    public static void main(String[] args) {
        ReportApi apiInstance = new ReportApi();
        Integer id = 56; // Integer | 
        ReportBase body = ; // ReportBase | 
        try {
            ReportBase result = apiInstance.updateReportById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportApi#updateReportById");
            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; // 
ReportBase *body = ; // 

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

// update report
[apiInstance updateReportByIdWith:id
    body:body
              completionHandler: ^(ReportBase 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.ReportApi()

var id = 56; // {Integer} 

var body = ; // {ReportBase} 


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

namespace Example
{
    public class updateReportByIdExample
    {
        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 ReportApi();
            var id = 56;  // Integer | 
            var body = new ReportBase(); // ReportBase | 

            try
            {
                // update report
                ReportBase result = apiInstance.updateReportById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportApi.updateReportById: " + 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\Api\ReportApi();
$id = 56; // Integer | 
$body = ; // ReportBase | 

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

# 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::ReportApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::ReportBase->new(); # ReportBase | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update report api_response = api_instance.update_report_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling ReportApi->updateReportById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateReportByIDParams()
    
// update report resp, err := client.LM.UpdateReportByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateReportByID: %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


ReportGroups

addReportGroup

add report group


/report/groups

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportGroupsApi;

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

public class ReportGroupsApiExample {

    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");

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

public class ReportGroupsApiExample {

    public static void main(String[] args) {
        ReportGroupsApi apiInstance = new ReportGroupsApi();
        ReportGroup body = ; // ReportGroup | 
        try {
            ReportGroup result = apiInstance.addReportGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportGroupsApi#addReportGroup");
            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"];

ReportGroup *body = ; // 

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

// add report group
[apiInstance addReportGroupWith:body
              completionHandler: ^(ReportGroup 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.ReportGroupsApi()

var body = ; // {ReportGroup} 


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

namespace Example
{
    public class addReportGroupExample
    {
        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 ReportGroupsApi();
            var body = new ReportGroup(); // ReportGroup | 

            try
            {
                // add report group
                ReportGroup result = apiInstance.addReportGroup(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportGroupsApi.addReportGroup: " + 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\Api\ReportGroupsApi();
$body = ; // ReportGroup | 

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

# 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::ReportGroupsApi->new();
my $body = WWW::SwaggerClient::Object::ReportGroup->new(); # ReportGroup | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add report group api_response = api_instance.add_report_group(body) pprint(api_response) except ApiException as e: print("Exception when calling ReportGroupsApi->addReportGroup: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddReportGroupParams()
    
// add report group resp, err := client.LM.AddReportGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddReportGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


deleteReportGroupById

delete report group


/report/groups/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportGroupsApi;

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

public class ReportGroupsApiExample {

    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");

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

public class ReportGroupsApiExample {

    public static void main(String[] args) {
        ReportGroupsApi apiInstance = new ReportGroupsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteReportGroupById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportGroupsApi#deleteReportGroupById");
            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; // 

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

// delete report group
[apiInstance deleteReportGroupByIdWith: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.ReportGroupsApi()

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.deleteReportGroupById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteReportGroupByIdExample
    {
        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 ReportGroupsApi();
            var id = 56;  // Integer | 

            try
            {
                // delete report group
                Object result = apiInstance.deleteReportGroupById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportGroupsApi.deleteReportGroupById: " + 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\Api\ReportGroupsApi();
$id = 56; // Integer | 

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

# 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::ReportGroupsApi->new();
my $id = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete report group api_response = api_instance.delete_report_group_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling ReportGroupsApi->deleteReportGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteReportGroupByIDParams()
    
// delete report group resp, err := client.LM.DeleteReportGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteReportGroupByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


getReportGroupById

get report group by id


/report/groups/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportGroupsApi;

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

public class ReportGroupsApiExample {

    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");

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

public class ReportGroupsApiExample {

    public static void main(String[] args) {
        ReportGroupsApi apiInstance = new ReportGroupsApi();
        Integer id = 56; // Integer | 
        try {
            ReportGroup result = apiInstance.getReportGroupById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportGroupsApi#getReportGroupById");
            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; // 

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

// get report group by id
[apiInstance getReportGroupByIdWith:id
              completionHandler: ^(ReportGroup 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.ReportGroupsApi()

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.getReportGroupById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getReportGroupByIdExample
    {
        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 ReportGroupsApi();
            var id = 56;  // Integer | 

            try
            {
                // get report group by id
                ReportGroup result = apiInstance.getReportGroupById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportGroupsApi.getReportGroupById: " + 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\Api\ReportGroupsApi();
$id = 56; // Integer | 

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

# 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::ReportGroupsApi->new();
my $id = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get report group by id api_response = api_instance.get_report_group_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling ReportGroupsApi->getReportGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetReportGroupByIDParams()
    
// get report group by id resp, err := client.LM.GetReportGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetReportGroupByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


getReportGroupList

get report group list


/report/groups

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/groups?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportGroupsApi;

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

public class ReportGroupsApiExample {

    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");

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

public class ReportGroupsApiExample {

    public static void main(String[] args) {
        ReportGroupsApi apiInstance = new ReportGroupsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            ReportGroupPaginationResponse result = apiInstance.getReportGroupList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportGroupsApi#getReportGroupList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get report group list
[apiInstance getReportGroupListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(ReportGroupPaginationResponse 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.ReportGroupsApi()

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.getReportGroupList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getReportGroupListExample
    {
        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 ReportGroupsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get report group list
                ReportGroupPaginationResponse result = apiInstance.getReportGroupList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportGroupsApi.getReportGroupList: " + 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\Api\ReportGroupsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::ReportGroupsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get report group list api_response = api_instance.get_report_group_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling ReportGroupsApi->getReportGroupList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetReportGroupListParams()
    
// get report group list resp, err := client.LM.GetReportGroupList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetReportGroupList: %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


patchReportGroupById

update report group


/report/groups/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportGroupsApi;

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

public class ReportGroupsApiExample {

    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");

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

public class ReportGroupsApiExample {

    public static void main(String[] args) {
        ReportGroupsApi apiInstance = new ReportGroupsApi();
        Integer id = 56; // Integer | 
        ReportGroup body = ; // ReportGroup | 
        try {
            ReportGroup result = apiInstance.patchReportGroupById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportGroupsApi#patchReportGroupById");
            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; // 
ReportGroup *body = ; // 

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

// update report group
[apiInstance patchReportGroupByIdWith:id
    body:body
              completionHandler: ^(ReportGroup 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.ReportGroupsApi()

var id = 56; // {Integer} 

var body = ; // {ReportGroup} 


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

namespace Example
{
    public class patchReportGroupByIdExample
    {
        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 ReportGroupsApi();
            var id = 56;  // Integer | 
            var body = new ReportGroup(); // ReportGroup | 

            try
            {
                // update report group
                ReportGroup result = apiInstance.patchReportGroupById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportGroupsApi.patchReportGroupById: " + 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\Api\ReportGroupsApi();
$id = 56; // Integer | 
$body = ; // ReportGroup | 

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

# 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::ReportGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::ReportGroup->new(); # ReportGroup | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update report group api_response = api_instance.patch_report_group_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling ReportGroupsApi->patchReportGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchReportGroupByIDParams()
    
// update report group resp, err := client.LM.PatchReportGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchReportGroupByID: %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


updateReportGroupById

update report group


/report/groups/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/report/groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ReportGroupsApi;

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

public class ReportGroupsApiExample {

    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");

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

public class ReportGroupsApiExample {

    public static void main(String[] args) {
        ReportGroupsApi apiInstance = new ReportGroupsApi();
        Integer id = 56; // Integer | 
        ReportGroup body = ; // ReportGroup | 
        try {
            ReportGroup result = apiInstance.updateReportGroupById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ReportGroupsApi#updateReportGroupById");
            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; // 
ReportGroup *body = ; // 

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

// update report group
[apiInstance updateReportGroupByIdWith:id
    body:body
              completionHandler: ^(ReportGroup 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.ReportGroupsApi()

var id = 56; // {Integer} 

var body = ; // {ReportGroup} 


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

namespace Example
{
    public class updateReportGroupByIdExample
    {
        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 ReportGroupsApi();
            var id = 56;  // Integer | 
            var body = new ReportGroup(); // ReportGroup | 

            try
            {
                // update report group
                ReportGroup result = apiInstance.updateReportGroupById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ReportGroupsApi.updateReportGroupById: " + 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\Api\ReportGroupsApi();
$id = 56; // Integer | 
$body = ; // ReportGroup | 

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

# 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::ReportGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::ReportGroup->new(); # ReportGroup | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update report group api_response = api_instance.update_report_group_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling ReportGroupsApi->updateReportGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateReportGroupByIDParams()
    
// update report group resp, err := client.LM.UpdateReportGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateReportGroupByID: %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


Roles

addRole

add role


/setting/roles

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/roles"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RolesApi;

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

public class RolesApiExample {

    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");

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

public class RolesApiExample {

    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        Role body = ; // Role | 
        try {
            Role result = apiInstance.addRole(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#addRole");
            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"];

Role *body = ; // 

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

// add role
[apiInstance addRoleWith:body
              completionHandler: ^(Role 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.RolesApi()

var body = ; // {Role} 


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

namespace Example
{
    public class addRoleExample
    {
        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 RolesApi();
            var body = new Role(); // Role | 

            try
            {
                // add role
                Role result = apiInstance.addRole(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RolesApi.addRole: " + 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\Api\RolesApi();
$body = ; // Role | 

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

# 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::RolesApi->new();
my $body = WWW::SwaggerClient::Object::Role->new(); # Role | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add role api_response = api_instance.add_role(body) pprint(api_response) except ApiException as e: print("Exception when calling RolesApi->addRole: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddRoleParams()
    
// add role resp, err := client.LM.AddRole(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddRole: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


deleteRoleById

delete role


/setting/roles/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/roles/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RolesApi;

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

public class RolesApiExample {

    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");

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

public class RolesApiExample {

    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteRoleById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#deleteRoleById");
            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; // 

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

// delete role
[apiInstance deleteRoleByIdWith: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.RolesApi()

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.deleteRoleById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteRoleByIdExample
    {
        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 RolesApi();
            var id = 56;  // Integer | 

            try
            {
                // delete role
                Object result = apiInstance.deleteRoleById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RolesApi.deleteRoleById: " + 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\Api\RolesApi();
$id = 56; // Integer | 

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

# 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::RolesApi->new();
my $id = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete role api_response = api_instance.delete_role_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling RolesApi->deleteRoleById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteRoleByIDParams()
    
// delete role resp, err := client.LM.DeleteRoleByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteRoleByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


getRoleById

get role by id


/setting/roles/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/roles/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RolesApi;

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

public class RolesApiExample {

    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");

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

public class RolesApiExample {

    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            Role result = apiInstance.getRoleById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#getRoleById");
            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)

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

// get role by id
[apiInstance getRoleByIdWith:id
    fields:fields
              completionHandler: ^(Role 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.RolesApi()

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.getRoleById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getRoleByIdExample
    {
        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 RolesApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get role by id
                Role result = apiInstance.getRoleById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RolesApi.getRoleById: " + 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\Api\RolesApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 

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

# 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::RolesApi->new();
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get role by id api_response = api_instance.get_role_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling RolesApi->getRoleById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetRoleByIDParams()
    
// get role by id resp, err := client.LM.GetRoleByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetRoleByID: %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


getRoleList

get role list


/setting/roles

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/roles?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RolesApi;

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

public class RolesApiExample {

    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");

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

public class RolesApiExample {

    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            RolePaginationResponse result = apiInstance.getRoleList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#getRoleList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get role list
[apiInstance getRoleListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(RolePaginationResponse 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.RolesApi()

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.getRoleList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getRoleListExample
    {
        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 RolesApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get role list
                RolePaginationResponse result = apiInstance.getRoleList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RolesApi.getRoleList: " + 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\Api\RolesApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::RolesApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get role list api_response = api_instance.get_role_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling RolesApi->getRoleList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetRoleListParams()
    
// get role list resp, err := client.LM.GetRoleList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetRoleList: %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


patchRoleById

update role


/setting/roles/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/roles/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RolesApi;

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

public class RolesApiExample {

    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");

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

public class RolesApiExample {

    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        Integer id = 56; // Integer | 
        Role body = ; // Role | 
        try {
            Role result = apiInstance.patchRoleById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#patchRoleById");
            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; // 
Role *body = ; // 

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

// update role
[apiInstance patchRoleByIdWith:id
    body:body
              completionHandler: ^(Role 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.RolesApi()

var id = 56; // {Integer} 

var body = ; // {Role} 


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

namespace Example
{
    public class patchRoleByIdExample
    {
        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 RolesApi();
            var id = 56;  // Integer | 
            var body = new Role(); // Role | 

            try
            {
                // update role
                Role result = apiInstance.patchRoleById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RolesApi.patchRoleById: " + 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\Api\RolesApi();
$id = 56; // Integer | 
$body = ; // Role | 

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

# 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::RolesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Role->new(); # Role | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update role api_response = api_instance.patch_role_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling RolesApi->patchRoleById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchRoleByIDParams()
    
// update role resp, err := client.LM.PatchRoleByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchRoleByID: %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


updateRoleById

update role


/setting/roles/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/roles/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.RolesApi;

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

public class RolesApiExample {

    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");

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

public class RolesApiExample {

    public static void main(String[] args) {
        RolesApi apiInstance = new RolesApi();
        Integer id = 56; // Integer | 
        Role body = ; // Role | 
        try {
            Role result = apiInstance.updateRoleById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling RolesApi#updateRoleById");
            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; // 
Role *body = ; // 

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

// update role
[apiInstance updateRoleByIdWith:id
    body:body
              completionHandler: ^(Role 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.RolesApi()

var id = 56; // {Integer} 

var body = ; // {Role} 


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

namespace Example
{
    public class updateRoleByIdExample
    {
        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 RolesApi();
            var id = 56;  // Integer | 
            var body = new Role(); // Role | 

            try
            {
                // update role
                Role result = apiInstance.updateRoleById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling RolesApi.updateRoleById: " + 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\Api\RolesApi();
$id = 56; // Integer | 
$body = ; // Role | 

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

# 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::RolesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Role->new(); # Role | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update role api_response = api_instance.update_role_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling RolesApi->updateRoleById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateRoleByIDParams()
    
// update role resp, err := client.LM.UpdateRoleByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateRoleByID: %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


SDTs

addSDT

add SDT (Response may contain extra fields depending upon the type of SDT being added)


/sdt/sdts

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/sdt/sdts"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SDTsApi;

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

public class SDTsApiExample {

    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");

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

public class SDTsApiExample {

    public static void main(String[] args) {
        SDTsApi apiInstance = new SDTsApi();
        SDT body = ; // SDT | 
        try {
            SDT result = apiInstance.addSDT(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SDTsApi#addSDT");
            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"];

SDT *body = ; // 

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

// add SDT (Response may contain extra fields depending upon the type of SDT being added)
[apiInstance addSDTWith:body
              completionHandler: ^(SDT 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.SDTsApi()

var body = ; // {SDT} 


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

namespace Example
{
    public class addSDTExample
    {
        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 SDTsApi();
            var body = new SDT(); // SDT | 

            try
            {
                // add SDT (Response may contain extra fields depending upon the type of SDT being added)
                SDT result = apiInstance.addSDT(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SDTsApi.addSDT: " + 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\Api\SDTsApi();
$body = ; // SDT | 

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

# 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::SDTsApi->new();
my $body = WWW::SwaggerClient::Object::SDT->new(); # SDT | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add SDT (Response may contain extra fields depending upon the type of SDT being added) api_response = api_instance.add_sdt(body) pprint(api_response) except ApiException as e: print("Exception when calling SDTsApi->addSDT: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddSDTParams()
    
// add SDT (Response may contain extra fields depending upon the type of SDT being added) resp, err := client.LM.AddSDT(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddSDT: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


deleteSDTById

delete SDT


/sdt/sdts/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/sdt/sdts/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SDTsApi;

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

public class SDTsApiExample {

    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");

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

public class SDTsApiExample {

    public static void main(String[] args) {
        SDTsApi apiInstance = new SDTsApi();
        String id = id_example; // String | 
        try {
            Object result = apiInstance.deleteSDTById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SDTsApi#deleteSDTById");
            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; // 

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

// delete SDT
[apiInstance deleteSDTByIdWith: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.SDTsApi()

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.deleteSDTById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteSDTByIdExample
    {
        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 SDTsApi();
            var id = id_example;  // String | 

            try
            {
                // delete SDT
                Object result = apiInstance.deleteSDTById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SDTsApi.deleteSDTById: " + 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\Api\SDTsApi();
$id = id_example; // String | 

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

# 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::SDTsApi->new();
my $id = id_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete SDT api_response = api_instance.delete_sdt_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling SDTsApi->deleteSDTById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteSDTByIDParams()
    
// delete SDT resp, err := client.LM.DeleteSDTByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteSDTByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
String
Required

Responses

Status: 200 - successful operation

Status: default - Error


getSDTById

get SDT by id (Response may contain extra fields depending upon the type of SDT of given id)


/sdt/sdts/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/sdt/sdts/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SDTsApi;

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

public class SDTsApiExample {

    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");

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

public class SDTsApiExample {

    public static void main(String[] args) {
        SDTsApi apiInstance = new SDTsApi();
        String id = id_example; // String | 
        String fields = fields_example; // String | 
        try {
            SDT result = apiInstance.getSDTById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SDTsApi#getSDTById");
            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; // 
String *fields = fields_example; //  (optional)

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

// get SDT by id (Response may contain extra fields depending upon the type of SDT of given id)
[apiInstance getSDTByIdWith:id
    fields:fields
              completionHandler: ^(SDT 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.SDTsApi()

var id = id_example; // {String} 

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.getSDTById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getSDTByIdExample
    {
        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 SDTsApi();
            var id = id_example;  // String | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get SDT by id (Response may contain extra fields depending upon the type of SDT of given id)
                SDT result = apiInstance.getSDTById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SDTsApi.getSDTById: " + 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\Api\SDTsApi();
$id = id_example; // String | 
$fields = fields_example; // String | 

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

# 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::SDTsApi->new();
my $id = id_example; # String | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get SDT by id (Response may contain extra fields depending upon the type of SDT of given id) api_response = api_instance.get_sdt_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling SDTsApi->getSDTById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetSDTByIDParams()
    
// get SDT by id (Response may contain extra fields depending upon the type of SDT of given id) resp, err := client.LM.GetSDTByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetSDTByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
String
Required
Query parameters
Name Description
fields
String

Responses

Status: 200 - successful operation

Status: default - Error


getSDTList

get SDT list


/sdt/sdts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/sdt/sdts?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SDTsApi;

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

public class SDTsApiExample {

    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");

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

public class SDTsApiExample {

    public static void main(String[] args) {
        SDTsApi apiInstance = new SDTsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            SDTPaginationResponse result = apiInstance.getSDTList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SDTsApi#getSDTList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get SDT list
[apiInstance getSDTListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(SDTPaginationResponse 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.SDTsApi()

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.getSDTList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getSDTListExample
    {
        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 SDTsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get SDT list
                SDTPaginationResponse result = apiInstance.getSDTList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SDTsApi.getSDTList: " + 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\Api\SDTsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::SDTsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get SDT list api_response = api_instance.get_sdt_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling SDTsApi->getSDTList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetSDTListParams()
    
// get SDT list resp, err := client.LM.GetSDTList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetSDTList: %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


patchSDTById

update SDT (Response may contain extra fields depending upon the type of SDT being updated)


/sdt/sdts/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/sdt/sdts/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SDTsApi;

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

public class SDTsApiExample {

    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");

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

public class SDTsApiExample {

    public static void main(String[] args) {
        SDTsApi apiInstance = new SDTsApi();
        String id = id_example; // String | 
        SDT body = ; // SDT | 
        try {
            SDT result = apiInstance.patchSDTById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SDTsApi#patchSDTById");
            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; // 
SDT *body = ; // 

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

// update SDT (Response may contain extra fields depending upon the type of SDT being updated)
[apiInstance patchSDTByIdWith:id
    body:body
              completionHandler: ^(SDT 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.SDTsApi()

var id = id_example; // {String} 

var body = ; // {SDT} 


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

namespace Example
{
    public class patchSDTByIdExample
    {
        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 SDTsApi();
            var id = id_example;  // String | 
            var body = new SDT(); // SDT | 

            try
            {
                // update SDT (Response may contain extra fields depending upon the type of SDT being updated)
                SDT result = apiInstance.patchSDTById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SDTsApi.patchSDTById: " + 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\Api\SDTsApi();
$id = id_example; // String | 
$body = ; // SDT | 

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

# 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::SDTsApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::SDT->new(); # SDT | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update SDT (Response may contain extra fields depending upon the type of SDT being updated) api_response = api_instance.patch_sdt_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling SDTsApi->patchSDTById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchSDTByIDParams()
    
// update SDT (Response may contain extra fields depending upon the type of SDT being updated) resp, err := client.LM.PatchSDTByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchSDTByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


updateSDTById

update SDT (Response may contain extra fields depending upon the type of SDT being updated)


/sdt/sdts/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/sdt/sdts/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.SDTsApi;

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

public class SDTsApiExample {

    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");

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

public class SDTsApiExample {

    public static void main(String[] args) {
        SDTsApi apiInstance = new SDTsApi();
        String id = id_example; // String | 
        SDT body = ; // SDT | 
        try {
            SDT result = apiInstance.updateSDTById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling SDTsApi#updateSDTById");
            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; // 
SDT *body = ; // 

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

// update SDT (Response may contain extra fields depending upon the type of SDT being updated)
[apiInstance updateSDTByIdWith:id
    body:body
              completionHandler: ^(SDT 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.SDTsApi()

var id = id_example; // {String} 

var body = ; // {SDT} 


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

namespace Example
{
    public class updateSDTByIdExample
    {
        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 SDTsApi();
            var id = id_example;  // String | 
            var body = new SDT(); // SDT | 

            try
            {
                // update SDT (Response may contain extra fields depending upon the type of SDT being updated)
                SDT result = apiInstance.updateSDTById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SDTsApi.updateSDTById: " + 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\Api\SDTsApi();
$id = id_example; // String | 
$body = ; // SDT | 

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

# 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::SDTsApi->new();
my $id = id_example; # String | 
my $body = WWW::SwaggerClient::Object::SDT->new(); # SDT | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update SDT (Response may contain extra fields depending upon the type of SDT being updated) api_response = api_instance.update_sdt_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling SDTsApi->updateSDTById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateSDTByIDParams()
    
// update SDT (Response may contain extra fields depending upon the type of SDT being updated) resp, err := client.LM.UpdateSDTByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateSDTByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


Thresholds

getDeviceDatasourceInstanceAlertSettingListOfDSI

get a list of alert settings for a device datasource instance


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/alertsettings

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/alertsettings?size=&offset="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThresholdsApi;

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

public class ThresholdsApiExample {

    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");

        ThresholdsApi apiInstance = new ThresholdsApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | Device-DataSource ID
        Integer instanceId = 56; // Integer | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        try {
            DeviceDataSourceInstanceAlertSettingPaginationResponse result = apiInstance.getDeviceDatasourceInstanceAlertSettingListOfDSI(deviceId, hdsId, instanceId, size, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThresholdsApi#getDeviceDatasourceInstanceAlertSettingListOfDSI");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ThresholdsApi;

public class ThresholdsApiExample {

    public static void main(String[] args) {
        ThresholdsApi apiInstance = new ThresholdsApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | Device-DataSource ID
        Integer instanceId = 56; // Integer | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        try {
            DeviceDataSourceInstanceAlertSettingPaginationResponse result = apiInstance.getDeviceDatasourceInstanceAlertSettingListOfDSI(deviceId, hdsId, instanceId, size, offset);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThresholdsApi#getDeviceDatasourceInstanceAlertSettingListOfDSI");
            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; // Device-DataSource ID
Integer *instanceId = 56; // 
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)

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

// get a list of alert settings for a device datasource instance
[apiInstance getDeviceDatasourceInstanceAlertSettingListOfDSIWith:deviceId
    hdsId:hdsId
    instanceId:instanceId
    size:size
    offset:offset
              completionHandler: ^(DeviceDataSourceInstanceAlertSettingPaginationResponse 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.ThresholdsApi()

var deviceId = 56; // {Integer} 

var hdsId = 56; // {Integer} Device-DataSource ID

var instanceId = 56; // {Integer} 

var opts = { 
  'size': 56, // {Integer} 
  'offset': 56 // {Integer} 
};

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

namespace Example
{
    public class getDeviceDatasourceInstanceAlertSettingListOfDSIExample
    {
        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 ThresholdsApi();
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | Device-DataSource ID
            var instanceId = 56;  // Integer | 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 

            try
            {
                // get a list of alert settings for a device datasource instance
                DeviceDataSourceInstanceAlertSettingPaginationResponse result = apiInstance.getDeviceDatasourceInstanceAlertSettingListOfDSI(deviceId, hdsId, instanceId, size, offset);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThresholdsApi.getDeviceDatasourceInstanceAlertSettingListOfDSI: " + 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\Api\ThresholdsApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | Device-DataSource ID
$instanceId = 56; // Integer | 
$size = 56; // Integer | 
$offset = 56; // Integer | 

try {
    $result = $api_instance->getDeviceDatasourceInstanceAlertSettingListOfDSI($deviceId, $hdsId, $instanceId, $size, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ThresholdsApi->getDeviceDatasourceInstanceAlertSettingListOfDSI: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ThresholdsApi;

# 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::ThresholdsApi->new();
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | Device-DataSource ID
my $instanceId = 56; # Integer | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 

eval { 
    my $result = $api_instance->getDeviceDatasourceInstanceAlertSettingListOfDSI(deviceId => $deviceId, hdsId => $hdsId, instanceId => $instanceId, size => $size, offset => $offset);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ThresholdsApi->getDeviceDatasourceInstanceAlertSettingListOfDSI: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get a list of alert settings for a device datasource instance api_response = api_instance.get_device_datasource_instance_alert_setting_list_of_dsi(deviceId, hdsId, instanceId, , ) pprint(api_response) except ApiException as e: print("Exception when calling ThresholdsApi->getDeviceDatasourceInstanceAlertSettingListOfDSI: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceDatasourceInstanceAlertSettingListOfDSIParams()
    
// get a list of alert settings for a device datasource instance resp, err := client.LM.GetDeviceDatasourceInstanceAlertSettingListOfDSI(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceDatasourceInstanceAlertSettingListOfDSI: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
Device-DataSource ID
Required
instanceId*
Integer (int32)
Required
Query parameters
Name Description
size
Integer (int32)
offset
Integer (int32)

Responses

Status: 200 - successful operation

Status: default - Error


getDeviceGroupDatasourceAlertSetting

get device group datasource alert setting


/device/groups/{deviceGroupId}/datasources/{dsId}/alertsettings

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{deviceGroupId}/datasources/{dsId}/alertsettings?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThresholdsApi;

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

public class ThresholdsApiExample {

    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");

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

public class ThresholdsApiExample {

    public static void main(String[] args) {
        ThresholdsApi apiInstance = new ThresholdsApi();
        Integer deviceGroupId = 56; // Integer | 
        Integer dsId = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            DeviceGroupDataSourceAlertConfig result = apiInstance.getDeviceGroupDatasourceAlertSetting(deviceGroupId, dsId, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThresholdsApi#getDeviceGroupDatasourceAlertSetting");
            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 *deviceGroupId = 56; // 
Integer *dsId = 56; // 
String *fields = fields_example; //  (optional)

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

// get device group datasource alert setting 
[apiInstance getDeviceGroupDatasourceAlertSettingWith:deviceGroupId
    dsId:dsId
    fields:fields
              completionHandler: ^(DeviceGroupDataSourceAlertConfig 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.ThresholdsApi()

var deviceGroupId = 56; // {Integer} 

var dsId = 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.getDeviceGroupDatasourceAlertSetting(deviceGroupId, dsId, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getDeviceGroupDatasourceAlertSettingExample
    {
        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 ThresholdsApi();
            var deviceGroupId = 56;  // Integer | 
            var dsId = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get device group datasource alert setting 
                DeviceGroupDataSourceAlertConfig result = apiInstance.getDeviceGroupDatasourceAlertSetting(deviceGroupId, dsId, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThresholdsApi.getDeviceGroupDatasourceAlertSetting: " + 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\Api\ThresholdsApi();
$deviceGroupId = 56; // Integer | 
$dsId = 56; // Integer | 
$fields = fields_example; // String | 

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

# 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::ThresholdsApi->new();
my $deviceGroupId = 56; # Integer | 
my $dsId = 56; # Integer | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get device group datasource alert setting api_response = api_instance.get_device_group_datasource_alert_setting(deviceGroupId, dsId, ) pprint(api_response) except ApiException as e: print("Exception when calling ThresholdsApi->getDeviceGroupDatasourceAlertSetting: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetDeviceGroupDatasourceAlertSettingParams()
    
// get device group datasource alert setting resp, err := client.LM.GetDeviceGroupDatasourceAlertSetting(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetDeviceGroupDatasourceAlertSetting: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


patchDeviceDatasourceInstanceAlertSettingById

update device instance alert setting


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/alertsettings/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/alertsettings/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThresholdsApi;

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

public class ThresholdsApiExample {

    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");

        ThresholdsApi apiInstance = new ThresholdsApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | Device-DataSource ID
        Integer instanceId = 56; // Integer | 
        Integer id = 56; // Integer | 
        DeviceDataSourceInstanceAlertSetting body = ; // DeviceDataSourceInstanceAlertSetting | 
        try {
            DeviceDataSourceInstanceAlertSetting result = apiInstance.patchDeviceDatasourceInstanceAlertSettingById(deviceId, hdsId, instanceId, id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThresholdsApi#patchDeviceDatasourceInstanceAlertSettingById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ThresholdsApi;

public class ThresholdsApiExample {

    public static void main(String[] args) {
        ThresholdsApi apiInstance = new ThresholdsApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | Device-DataSource ID
        Integer instanceId = 56; // Integer | 
        Integer id = 56; // Integer | 
        DeviceDataSourceInstanceAlertSetting body = ; // DeviceDataSourceInstanceAlertSetting | 
        try {
            DeviceDataSourceInstanceAlertSetting result = apiInstance.patchDeviceDatasourceInstanceAlertSettingById(deviceId, hdsId, instanceId, id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThresholdsApi#patchDeviceDatasourceInstanceAlertSettingById");
            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; // Device-DataSource ID
Integer *instanceId = 56; // 
Integer *id = 56; // 
DeviceDataSourceInstanceAlertSetting *body = ; // 

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

// update device instance alert setting
[apiInstance patchDeviceDatasourceInstanceAlertSettingByIdWith:deviceId
    hdsId:hdsId
    instanceId:instanceId
    id:id
    body:body
              completionHandler: ^(DeviceDataSourceInstanceAlertSetting 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.ThresholdsApi()

var deviceId = 56; // {Integer} 

var hdsId = 56; // {Integer} Device-DataSource ID

var instanceId = 56; // {Integer} 

var id = 56; // {Integer} 

var body = ; // {DeviceDataSourceInstanceAlertSetting} 


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

namespace Example
{
    public class patchDeviceDatasourceInstanceAlertSettingByIdExample
    {
        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 ThresholdsApi();
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | Device-DataSource ID
            var instanceId = 56;  // Integer | 
            var id = 56;  // Integer | 
            var body = new DeviceDataSourceInstanceAlertSetting(); // DeviceDataSourceInstanceAlertSetting | 

            try
            {
                // update device instance alert setting
                DeviceDataSourceInstanceAlertSetting result = apiInstance.patchDeviceDatasourceInstanceAlertSettingById(deviceId, hdsId, instanceId, id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThresholdsApi.patchDeviceDatasourceInstanceAlertSettingById: " + 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\Api\ThresholdsApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | Device-DataSource ID
$instanceId = 56; // Integer | 
$id = 56; // Integer | 
$body = ; // DeviceDataSourceInstanceAlertSetting | 

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

# 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::ThresholdsApi->new();
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | Device-DataSource ID
my $instanceId = 56; # Integer | 
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DeviceDataSourceInstanceAlertSetting->new(); # DeviceDataSourceInstanceAlertSetting | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device instance alert setting api_response = api_instance.patch_device_datasource_instance_alert_setting_by_id(deviceId, hdsId, instanceId, id, body) pprint(api_response) except ApiException as e: print("Exception when calling ThresholdsApi->patchDeviceDatasourceInstanceAlertSettingById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDeviceDatasourceInstanceAlertSettingByIDParams()
    
// update device instance alert setting resp, err := client.LM.PatchDeviceDatasourceInstanceAlertSettingByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchDeviceDatasourceInstanceAlertSettingByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
Device-DataSource ID
Required
instanceId*
Integer (int32)
Required
id*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


patchDeviceGroupDatasourceAlertSetting

update device group datasource alert setting


/device/groups/{deviceGroupId}/datasources/{dsId}/alertsettings

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{deviceGroupId}/datasources/{dsId}/alertsettings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThresholdsApi;

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

public class ThresholdsApiExample {

    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");

        ThresholdsApi apiInstance = new ThresholdsApi();
        Integer deviceGroupId = 56; // Integer | 
        Integer dsId = 56; // Integer | 
        DeviceGroupDataSourceAlertConfig body = ; // DeviceGroupDataSourceAlertConfig | 
        try {
            DeviceGroupDataSourceAlertConfig result = apiInstance.patchDeviceGroupDatasourceAlertSetting(deviceGroupId, dsId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThresholdsApi#patchDeviceGroupDatasourceAlertSetting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ThresholdsApi;

public class ThresholdsApiExample {

    public static void main(String[] args) {
        ThresholdsApi apiInstance = new ThresholdsApi();
        Integer deviceGroupId = 56; // Integer | 
        Integer dsId = 56; // Integer | 
        DeviceGroupDataSourceAlertConfig body = ; // DeviceGroupDataSourceAlertConfig | 
        try {
            DeviceGroupDataSourceAlertConfig result = apiInstance.patchDeviceGroupDatasourceAlertSetting(deviceGroupId, dsId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThresholdsApi#patchDeviceGroupDatasourceAlertSetting");
            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 *deviceGroupId = 56; // 
Integer *dsId = 56; // 
DeviceGroupDataSourceAlertConfig *body = ; // 

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

// update device group datasource alert setting
[apiInstance patchDeviceGroupDatasourceAlertSettingWith:deviceGroupId
    dsId:dsId
    body:body
              completionHandler: ^(DeviceGroupDataSourceAlertConfig 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.ThresholdsApi()

var deviceGroupId = 56; // {Integer} 

var dsId = 56; // {Integer} 

var body = ; // {DeviceGroupDataSourceAlertConfig} 


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

namespace Example
{
    public class patchDeviceGroupDatasourceAlertSettingExample
    {
        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 ThresholdsApi();
            var deviceGroupId = 56;  // Integer | 
            var dsId = 56;  // Integer | 
            var body = new DeviceGroupDataSourceAlertConfig(); // DeviceGroupDataSourceAlertConfig | 

            try
            {
                // update device group datasource alert setting
                DeviceGroupDataSourceAlertConfig result = apiInstance.patchDeviceGroupDatasourceAlertSetting(deviceGroupId, dsId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThresholdsApi.patchDeviceGroupDatasourceAlertSetting: " + 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\Api\ThresholdsApi();
$deviceGroupId = 56; // Integer | 
$dsId = 56; // Integer | 
$body = ; // DeviceGroupDataSourceAlertConfig | 

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

# 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::ThresholdsApi->new();
my $deviceGroupId = 56; # Integer | 
my $dsId = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DeviceGroupDataSourceAlertConfig->new(); # DeviceGroupDataSourceAlertConfig | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device group datasource alert setting api_response = api_instance.patch_device_group_datasource_alert_setting(deviceGroupId, dsId, body) pprint(api_response) except ApiException as e: print("Exception when calling ThresholdsApi->patchDeviceGroupDatasourceAlertSetting: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchDeviceGroupDatasourceAlertSettingParams()
    
// update device group datasource alert setting resp, err := client.LM.PatchDeviceGroupDatasourceAlertSetting(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchDeviceGroupDatasourceAlertSetting: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


updateDeviceDatasourceInstanceAlertSettingById

update device instance alert setting


/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/alertsettings/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/devices/{deviceId}/devicedatasources/{hdsId}/instances/{instanceId}/alertsettings/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThresholdsApi;

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

public class ThresholdsApiExample {

    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");

        ThresholdsApi apiInstance = new ThresholdsApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | Device-DataSource ID
        Integer instanceId = 56; // Integer | 
        Integer id = 56; // Integer | 
        DeviceDataSourceInstanceAlertSetting body = ; // DeviceDataSourceInstanceAlertSetting | 
        try {
            DeviceDataSourceInstanceAlertSetting result = apiInstance.updateDeviceDatasourceInstanceAlertSettingById(deviceId, hdsId, instanceId, id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThresholdsApi#updateDeviceDatasourceInstanceAlertSettingById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ThresholdsApi;

public class ThresholdsApiExample {

    public static void main(String[] args) {
        ThresholdsApi apiInstance = new ThresholdsApi();
        Integer deviceId = 56; // Integer | 
        Integer hdsId = 56; // Integer | Device-DataSource ID
        Integer instanceId = 56; // Integer | 
        Integer id = 56; // Integer | 
        DeviceDataSourceInstanceAlertSetting body = ; // DeviceDataSourceInstanceAlertSetting | 
        try {
            DeviceDataSourceInstanceAlertSetting result = apiInstance.updateDeviceDatasourceInstanceAlertSettingById(deviceId, hdsId, instanceId, id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThresholdsApi#updateDeviceDatasourceInstanceAlertSettingById");
            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; // Device-DataSource ID
Integer *instanceId = 56; // 
Integer *id = 56; // 
DeviceDataSourceInstanceAlertSetting *body = ; // 

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

// update device instance alert setting
[apiInstance updateDeviceDatasourceInstanceAlertSettingByIdWith:deviceId
    hdsId:hdsId
    instanceId:instanceId
    id:id
    body:body
              completionHandler: ^(DeviceDataSourceInstanceAlertSetting 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.ThresholdsApi()

var deviceId = 56; // {Integer} 

var hdsId = 56; // {Integer} Device-DataSource ID

var instanceId = 56; // {Integer} 

var id = 56; // {Integer} 

var body = ; // {DeviceDataSourceInstanceAlertSetting} 


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

namespace Example
{
    public class updateDeviceDatasourceInstanceAlertSettingByIdExample
    {
        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 ThresholdsApi();
            var deviceId = 56;  // Integer | 
            var hdsId = 56;  // Integer | Device-DataSource ID
            var instanceId = 56;  // Integer | 
            var id = 56;  // Integer | 
            var body = new DeviceDataSourceInstanceAlertSetting(); // DeviceDataSourceInstanceAlertSetting | 

            try
            {
                // update device instance alert setting
                DeviceDataSourceInstanceAlertSetting result = apiInstance.updateDeviceDatasourceInstanceAlertSettingById(deviceId, hdsId, instanceId, id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThresholdsApi.updateDeviceDatasourceInstanceAlertSettingById: " + 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\Api\ThresholdsApi();
$deviceId = 56; // Integer | 
$hdsId = 56; // Integer | Device-DataSource ID
$instanceId = 56; // Integer | 
$id = 56; // Integer | 
$body = ; // DeviceDataSourceInstanceAlertSetting | 

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

# 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::ThresholdsApi->new();
my $deviceId = 56; # Integer | 
my $hdsId = 56; # Integer | Device-DataSource ID
my $instanceId = 56; # Integer | 
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DeviceDataSourceInstanceAlertSetting->new(); # DeviceDataSourceInstanceAlertSetting | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device instance alert setting api_response = api_instance.update_device_datasource_instance_alert_setting_by_id(deviceId, hdsId, instanceId, id, body) pprint(api_response) except ApiException as e: print("Exception when calling ThresholdsApi->updateDeviceDatasourceInstanceAlertSettingById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDeviceDatasourceInstanceAlertSettingByIDParams()
    
// update device instance alert setting resp, err := client.LM.UpdateDeviceDatasourceInstanceAlertSettingByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateDeviceDatasourceInstanceAlertSettingByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
deviceId*
Integer (int32)
Required
hdsId*
Integer (int32)
Device-DataSource ID
Required
instanceId*
Integer (int32)
Required
id*
Integer (int32)
Required
Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


updateDeviceGroupDatasourceAlertSetting

update device group datasource alert setting


/device/groups/{deviceGroupId}/datasources/{dsId}/alertsettings

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/device/groups/{deviceGroupId}/datasources/{dsId}/alertsettings"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ThresholdsApi;

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

public class ThresholdsApiExample {

    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");

        ThresholdsApi apiInstance = new ThresholdsApi();
        Integer deviceGroupId = 56; // Integer | 
        Integer dsId = 56; // Integer | 
        DeviceGroupDataSourceAlertConfig body = ; // DeviceGroupDataSourceAlertConfig | 
        try {
            DeviceGroupDataSourceAlertConfig result = apiInstance.updateDeviceGroupDatasourceAlertSetting(deviceGroupId, dsId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThresholdsApi#updateDeviceGroupDatasourceAlertSetting");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ThresholdsApi;

public class ThresholdsApiExample {

    public static void main(String[] args) {
        ThresholdsApi apiInstance = new ThresholdsApi();
        Integer deviceGroupId = 56; // Integer | 
        Integer dsId = 56; // Integer | 
        DeviceGroupDataSourceAlertConfig body = ; // DeviceGroupDataSourceAlertConfig | 
        try {
            DeviceGroupDataSourceAlertConfig result = apiInstance.updateDeviceGroupDatasourceAlertSetting(deviceGroupId, dsId, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ThresholdsApi#updateDeviceGroupDatasourceAlertSetting");
            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 *deviceGroupId = 56; // 
Integer *dsId = 56; // 
DeviceGroupDataSourceAlertConfig *body = ; // 

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

// update device group datasource alert setting
[apiInstance updateDeviceGroupDatasourceAlertSettingWith:deviceGroupId
    dsId:dsId
    body:body
              completionHandler: ^(DeviceGroupDataSourceAlertConfig 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.ThresholdsApi()

var deviceGroupId = 56; // {Integer} 

var dsId = 56; // {Integer} 

var body = ; // {DeviceGroupDataSourceAlertConfig} 


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

namespace Example
{
    public class updateDeviceGroupDatasourceAlertSettingExample
    {
        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 ThresholdsApi();
            var deviceGroupId = 56;  // Integer | 
            var dsId = 56;  // Integer | 
            var body = new DeviceGroupDataSourceAlertConfig(); // DeviceGroupDataSourceAlertConfig | 

            try
            {
                // update device group datasource alert setting
                DeviceGroupDataSourceAlertConfig result = apiInstance.updateDeviceGroupDatasourceAlertSetting(deviceGroupId, dsId, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ThresholdsApi.updateDeviceGroupDatasourceAlertSetting: " + 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\Api\ThresholdsApi();
$deviceGroupId = 56; // Integer | 
$dsId = 56; // Integer | 
$body = ; // DeviceGroupDataSourceAlertConfig | 

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

# 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::ThresholdsApi->new();
my $deviceGroupId = 56; # Integer | 
my $dsId = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::DeviceGroupDataSourceAlertConfig->new(); # DeviceGroupDataSourceAlertConfig | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update device group datasource alert setting api_response = api_instance.update_device_group_datasource_alert_setting(deviceGroupId, dsId, body) pprint(api_response) except ApiException as e: print("Exception when calling ThresholdsApi->updateDeviceGroupDatasourceAlertSetting: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateDeviceGroupDatasourceAlertSettingParams()
    
// update device group datasource alert setting resp, err := client.LM.UpdateDeviceGroupDatasourceAlertSetting(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateDeviceGroupDatasourceAlertSetting: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


Users

addAdmin

add user


/setting/admins

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/admins"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    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");

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

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Admin body = ; // Admin | 
        try {
            Admin result = apiInstance.addAdmin(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#addAdmin");
            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"];

Admin *body = ; // 

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

// add user
[apiInstance addAdminWith:body
              completionHandler: ^(Admin 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.UsersApi()

var body = ; // {Admin} 


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

namespace Example
{
    public class addAdminExample
    {
        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 UsersApi();
            var body = new Admin(); // Admin | 

            try
            {
                // add user
                Admin result = apiInstance.addAdmin(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.addAdmin: " + 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\Api\UsersApi();
$body = ; // Admin | 

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

# 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::UsersApi->new();
my $body = WWW::SwaggerClient::Object::Admin->new(); # Admin | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add user api_response = api_instance.add_admin(body) pprint(api_response) except ApiException as e: print("Exception when calling UsersApi->addAdmin: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddAdminParams()
    
// add user resp, err := client.LM.AddAdmin(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddAdmin: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


deleteAdminById

delete user


/setting/admins/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/admins/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    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");

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

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteAdminById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#deleteAdminById");
            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; // 

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

// delete user
[apiInstance deleteAdminByIdWith: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.UsersApi()

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.deleteAdminById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteAdminByIdExample
    {
        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 UsersApi();
            var id = 56;  // Integer | 

            try
            {
                // delete user
                Object result = apiInstance.deleteAdminById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.deleteAdminById: " + 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\Api\UsersApi();
$id = 56; // Integer | 

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

# 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::UsersApi->new();
my $id = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete user api_response = api_instance.delete_admin_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling UsersApi->deleteAdminById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteAdminByIDParams()
    
// delete user resp, err := client.LM.DeleteAdminByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteAdminByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


getAdminById

get user


/setting/admins/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/admins/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    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");

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

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            Admin result = apiInstance.getAdminById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getAdminById");
            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)

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

// get user
[apiInstance getAdminByIdWith:id
    fields:fields
              completionHandler: ^(Admin 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.UsersApi()

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.getAdminById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAdminByIdExample
    {
        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 UsersApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get user
                Admin result = apiInstance.getAdminById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getAdminById: " + 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\Api\UsersApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 

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

# 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::UsersApi->new();
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get user api_response = api_instance.get_admin_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling UsersApi->getAdminById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAdminByIDParams()
    
// get user resp, err := client.LM.GetAdminByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAdminByID: %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


getAdminList

get user list


/setting/admins

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/admins?type=&permission=&filterGroupString=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    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");

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

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        String type = type_example; // String | 
        String permission = permission_example; // String | 
        String filterGroupString = filterGroupString_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AdminPaginationResponse result = apiInstance.getAdminList(type, permission, filterGroupString, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getAdminList");
            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 *filterGroupString = filterGroupString_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get user list
[apiInstance getAdminListWith:type
    permission:permission
    filterGroupString:filterGroupString
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(AdminPaginationResponse 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.UsersApi()

var opts = { 
  'type': type_example, // {String} 
  'permission': permission_example, // {String} 
  'filterGroupString': filterGroupString_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.getAdminList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAdminListExample
    {
        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 UsersApi();
            var type = type_example;  // String |  (optional) 
            var permission = permission_example;  // String |  (optional) 
            var filterGroupString = filterGroupString_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get user list
                AdminPaginationResponse result = apiInstance.getAdminList(type, permission, filterGroupString, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.getAdminList: " + 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\Api\UsersApi();
$type = type_example; // String | 
$permission = permission_example; // String | 
$filterGroupString = filterGroupString_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::UsersApi->new();
my $type = type_example; # String | 
my $permission = permission_example; # String | 
my $filterGroupString = filterGroupString_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->getAdminList(type => $type, permission => $permission, filterGroupString => $filterGroupString, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling UsersApi->getAdminList: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get user list api_response = api_instance.get_admin_list(, , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling UsersApi->getAdminList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAdminListParams()
    
// get user list resp, err := client.LM.GetAdminList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAdminList: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


patchAdminById

update user


/setting/admins/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/admins/{id}?changePassword="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    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");

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

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | 
        Admin body = ; // Admin | 
        Boolean changePassword = true; // Boolean | 
        try {
            Admin result = apiInstance.patchAdminById(id, body, changePassword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#patchAdminById");
            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; // 
Admin *body = ; // 
Boolean *changePassword = true; //  (optional) (default to false)

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

// update user
[apiInstance patchAdminByIdWith:id
    body:body
    changePassword:changePassword
              completionHandler: ^(Admin 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.UsersApi()

var id = 56; // {Integer} 

var body = ; // {Admin} 

var opts = { 
  'changePassword': true // {Boolean} 
};

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

namespace Example
{
    public class patchAdminByIdExample
    {
        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 UsersApi();
            var id = 56;  // Integer | 
            var body = new Admin(); // Admin | 
            var changePassword = true;  // Boolean |  (optional)  (default to false)

            try
            {
                // update user
                Admin result = apiInstance.patchAdminById(id, body, changePassword);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.patchAdminById: " + 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\Api\UsersApi();
$id = 56; // Integer | 
$body = ; // Admin | 
$changePassword = true; // Boolean | 

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

# 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::UsersApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Admin->new(); # Admin | 
my $changePassword = true; # Boolean | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update user api_response = api_instance.patch_admin_by_id(id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling UsersApi->patchAdminById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchAdminByIDParams()
    
// update user resp, err := client.LM.PatchAdminByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchAdminByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


updateAdminById

update user


/setting/admins/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/setting/admins/{id}?changePassword="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.UsersApi;

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

public class UsersApiExample {

    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");

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

public class UsersApiExample {

    public static void main(String[] args) {
        UsersApi apiInstance = new UsersApi();
        Integer id = 56; // Integer | 
        Admin body = ; // Admin | 
        Boolean changePassword = true; // Boolean | 
        try {
            Admin result = apiInstance.updateAdminById(id, body, changePassword);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#updateAdminById");
            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; // 
Admin *body = ; // 
Boolean *changePassword = true; //  (optional) (default to false)

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

// update user
[apiInstance updateAdminByIdWith:id
    body:body
    changePassword:changePassword
              completionHandler: ^(Admin 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.UsersApi()

var id = 56; // {Integer} 

var body = ; // {Admin} 

var opts = { 
  'changePassword': true // {Boolean} 
};

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

namespace Example
{
    public class updateAdminByIdExample
    {
        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 UsersApi();
            var id = 56;  // Integer | 
            var body = new Admin(); // Admin | 
            var changePassword = true;  // Boolean |  (optional)  (default to false)

            try
            {
                // update user
                Admin result = apiInstance.updateAdminById(id, body, changePassword);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling UsersApi.updateAdminById: " + 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\Api\UsersApi();
$id = 56; // Integer | 
$body = ; // Admin | 
$changePassword = true; // Boolean | 

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

# 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::UsersApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Admin->new(); # Admin | 
my $changePassword = true; # Boolean | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update user api_response = api_instance.update_admin_by_id(id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling UsersApi->updateAdminById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateAdminByIDParams()
    
// update user resp, err := client.LM.UpdateAdminByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateAdminByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


WebsiteGroups

addWebsiteGroup

add website group


/website/groups

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/groups"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsiteGroupsApi;

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

public class WebsiteGroupsApiExample {

    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");

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

public class WebsiteGroupsApiExample {

    public static void main(String[] args) {
        WebsiteGroupsApi apiInstance = new WebsiteGroupsApi();
        WebsiteGroup body = ; // WebsiteGroup | 
        try {
            WebsiteGroup result = apiInstance.addWebsiteGroup(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsiteGroupsApi#addWebsiteGroup");
            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"];

WebsiteGroup *body = ; // 

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

// add website group
[apiInstance addWebsiteGroupWith:body
              completionHandler: ^(WebsiteGroup 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.WebsiteGroupsApi()

var body = ; // {WebsiteGroup} 


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

namespace Example
{
    public class addWebsiteGroupExample
    {
        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 WebsiteGroupsApi();
            var body = new WebsiteGroup(); // WebsiteGroup | 

            try
            {
                // add website group
                WebsiteGroup result = apiInstance.addWebsiteGroup(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteGroupsApi.addWebsiteGroup: " + 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\Api\WebsiteGroupsApi();
$body = ; // WebsiteGroup | 

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

# 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::WebsiteGroupsApi->new();
my $body = WWW::SwaggerClient::Object::WebsiteGroup->new(); # WebsiteGroup | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add website group api_response = api_instance.add_website_group(body) pprint(api_response) except ApiException as e: print("Exception when calling WebsiteGroupsApi->addWebsiteGroup: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddWebsiteGroupParams()
    
// add website group resp, err := client.LM.AddWebsiteGroup(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddWebsiteGroup: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


deleteWebsiteGroupById

delete website group


/website/groups/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/groups/{id}?deleteChildren="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsiteGroupsApi;

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

public class WebsiteGroupsApiExample {

    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");

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

public class WebsiteGroupsApiExample {

    public static void main(String[] args) {
        WebsiteGroupsApi apiInstance = new WebsiteGroupsApi();
        Integer id = 56; // Integer | 
        Integer deleteChildren = 56; // Integer | 
        try {
            Object result = apiInstance.deleteWebsiteGroupById(id, deleteChildren);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsiteGroupsApi#deleteWebsiteGroupById");
            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; // 
Integer *deleteChildren = 56; //  (optional)

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

// delete website group
[apiInstance deleteWebsiteGroupByIdWith:id
    deleteChildren:deleteChildren
              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.WebsiteGroupsApi()

var id = 56; // {Integer} 

var opts = { 
  'deleteChildren': 56 // {Integer} 
};

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

namespace Example
{
    public class deleteWebsiteGroupByIdExample
    {
        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 WebsiteGroupsApi();
            var id = 56;  // Integer | 
            var deleteChildren = 56;  // Integer |  (optional) 

            try
            {
                // delete website group
                Object result = apiInstance.deleteWebsiteGroupById(id, deleteChildren);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteGroupsApi.deleteWebsiteGroupById: " + 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\Api\WebsiteGroupsApi();
$id = 56; // Integer | 
$deleteChildren = 56; // Integer | 

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

# 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::WebsiteGroupsApi->new();
my $id = 56; # Integer | 
my $deleteChildren = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete website group api_response = api_instance.delete_website_group_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling WebsiteGroupsApi->deleteWebsiteGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteWebsiteGroupByIDParams()
    
// delete website group resp, err := client.LM.DeleteWebsiteGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteWebsiteGroupByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


getAllSDTListByWebsiteGroupId

get a list of SDTs for a website group (Response may contain extra fields depending upon the type of SDT)


/website/groups/{id}/sdts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/groups/{id}/sdts?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsiteGroupsApi;

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

public class WebsiteGroupsApiExample {

    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");

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

public class WebsiteGroupsApiExample {

    public static void main(String[] args) {
        WebsiteGroupsApi apiInstance = new WebsiteGroupsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            SDTPaginationResponse result = apiInstance.getAllSDTListByWebsiteGroupId(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsiteGroupsApi#getAllSDTListByWebsiteGroupId");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get a list of SDTs for a website group (Response may contain extra fields depending upon the type of SDT)
[apiInstance getAllSDTListByWebsiteGroupIdWith:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(SDTPaginationResponse 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.WebsiteGroupsApi()

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.getAllSDTListByWebsiteGroupId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getAllSDTListByWebsiteGroupIdExample
    {
        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 WebsiteGroupsApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get a list of SDTs for a website group (Response may contain extra fields depending upon the type of SDT)
                SDTPaginationResponse result = apiInstance.getAllSDTListByWebsiteGroupId(id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteGroupsApi.getAllSDTListByWebsiteGroupId: " + 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\Api\WebsiteGroupsApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::WebsiteGroupsApi->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->getAllSDTListByWebsiteGroupId(id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebsiteGroupsApi->getAllSDTListByWebsiteGroupId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get a list of SDTs for a website group (Response may contain extra fields depending upon the type of SDT) api_response = api_instance.get_all_sdt_list_by_website_group_id(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling WebsiteGroupsApi->getAllSDTListByWebsiteGroupId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetAllSDTListByWebsiteGroupIDParams()
    
// get a list of SDTs for a website group (Response may contain extra fields depending upon the type of SDT) resp, err := client.LM.GetAllSDTListByWebsiteGroupID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetAllSDTListByWebsiteGroupID: %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


getImmediateWebsiteListByWebsiteGroupId

get a list of websites for a group (Response may contain extra fields depending upon the type of check { PingCheck | WebCheck} being added)


/website/groups/{id}/websites

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/groups/{id}/websites?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsiteGroupsApi;

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

public class WebsiteGroupsApiExample {

    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");

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

public class WebsiteGroupsApiExample {

    public static void main(String[] args) {
        WebsiteGroupsApi apiInstance = new WebsiteGroupsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            WebsitePaginationResponse result = apiInstance.getImmediateWebsiteListByWebsiteGroupId(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsiteGroupsApi#getImmediateWebsiteListByWebsiteGroupId");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get a list of websites for a group (Response may contain extra fields depending upon the type of check { PingCheck | WebCheck} being added)
[apiInstance getImmediateWebsiteListByWebsiteGroupIdWith:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(WebsitePaginationResponse 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.WebsiteGroupsApi()

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.getImmediateWebsiteListByWebsiteGroupId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getImmediateWebsiteListByWebsiteGroupIdExample
    {
        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 WebsiteGroupsApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get a list of websites for a group (Response may contain extra fields depending upon the type of check { PingCheck | WebCheck} being added)
                WebsitePaginationResponse result = apiInstance.getImmediateWebsiteListByWebsiteGroupId(id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteGroupsApi.getImmediateWebsiteListByWebsiteGroupId: " + 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\Api\WebsiteGroupsApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::WebsiteGroupsApi->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->getImmediateWebsiteListByWebsiteGroupId(id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebsiteGroupsApi->getImmediateWebsiteListByWebsiteGroupId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get a list of websites for a group (Response may contain extra fields depending upon the type of check { PingCheck | WebCheck} being added) api_response = api_instance.get_immediate_website_list_by_website_group_id(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling WebsiteGroupsApi->getImmediateWebsiteListByWebsiteGroupId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetImmediateWebsiteListByWebsiteGroupIDParams()
    
// get a list of websites for a group (Response may contain extra fields depending upon the type of check { PingCheck | WebCheck} being added) resp, err := client.LM.GetImmediateWebsiteListByWebsiteGroupID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetImmediateWebsiteListByWebsiteGroupID: %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


getWebsiteGroupById

get website group


/website/groups/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/groups/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsiteGroupsApi;

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

public class WebsiteGroupsApiExample {

    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");

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

public class WebsiteGroupsApiExample {

    public static void main(String[] args) {
        WebsiteGroupsApi apiInstance = new WebsiteGroupsApi();
        Integer id = 56; // Integer | 
        try {
            WebsiteGroup result = apiInstance.getWebsiteGroupById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsiteGroupsApi#getWebsiteGroupById");
            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; // 

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

// get website group
[apiInstance getWebsiteGroupByIdWith:id
              completionHandler: ^(WebsiteGroup 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.WebsiteGroupsApi()

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.getWebsiteGroupById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWebsiteGroupByIdExample
    {
        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 WebsiteGroupsApi();
            var id = 56;  // Integer | 

            try
            {
                // get website group
                WebsiteGroup result = apiInstance.getWebsiteGroupById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteGroupsApi.getWebsiteGroupById: " + 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\Api\WebsiteGroupsApi();
$id = 56; // Integer | 

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

# 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::WebsiteGroupsApi->new();
my $id = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get website group api_response = api_instance.get_website_group_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling WebsiteGroupsApi->getWebsiteGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsiteGroupByIDParams()
    
// get website group resp, err := client.LM.GetWebsiteGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWebsiteGroupByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


getWebsiteGroupList

get website group list


/website/groups

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/groups?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsiteGroupsApi;

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

public class WebsiteGroupsApiExample {

    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");

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

public class WebsiteGroupsApiExample {

    public static void main(String[] args) {
        WebsiteGroupsApi apiInstance = new WebsiteGroupsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            WebsiteGroupPaginationResponse result = apiInstance.getWebsiteGroupList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsiteGroupsApi#getWebsiteGroupList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get website group list
[apiInstance getWebsiteGroupListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(WebsiteGroupPaginationResponse 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.WebsiteGroupsApi()

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.getWebsiteGroupList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWebsiteGroupListExample
    {
        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 WebsiteGroupsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get website group list
                WebsiteGroupPaginationResponse result = apiInstance.getWebsiteGroupList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteGroupsApi.getWebsiteGroupList: " + 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\Api\WebsiteGroupsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::WebsiteGroupsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get website group list api_response = api_instance.get_website_group_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling WebsiteGroupsApi->getWebsiteGroupList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsiteGroupListParams()
    
// get website group list resp, err := client.LM.GetWebsiteGroupList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWebsiteGroupList: %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


patchWebsiteGroupById

update website group


/website/groups/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/groups/{id}?opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsiteGroupsApi;

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

public class WebsiteGroupsApiExample {

    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");

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

public class WebsiteGroupsApiExample {

    public static void main(String[] args) {
        WebsiteGroupsApi apiInstance = new WebsiteGroupsApi();
        Integer id = 56; // Integer | 
        WebsiteGroup body = ; // WebsiteGroup | 
        String opType = opType_example; // String | 
        try {
            WebsiteGroup result = apiInstance.patchWebsiteGroupById(id, body, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsiteGroupsApi#patchWebsiteGroupById");
            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; // 
WebsiteGroup *body = ; // 
String *opType = opType_example; //  (optional) (default to refresh)

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

// update website group
[apiInstance patchWebsiteGroupByIdWith:id
    body:body
    opType:opType
              completionHandler: ^(WebsiteGroup 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.WebsiteGroupsApi()

var id = 56; // {Integer} 

var body = ; // {WebsiteGroup} 

var opts = { 
  '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.patchWebsiteGroupById(id, body, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchWebsiteGroupByIdExample
    {
        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 WebsiteGroupsApi();
            var id = 56;  // Integer | 
            var body = new WebsiteGroup(); // WebsiteGroup | 
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            try
            {
                // update website group
                WebsiteGroup result = apiInstance.patchWebsiteGroupById(id, body, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteGroupsApi.patchWebsiteGroupById: " + 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\Api\WebsiteGroupsApi();
$id = 56; // Integer | 
$body = ; // WebsiteGroup | 
$opType = opType_example; // String | 

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

# 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::WebsiteGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::WebsiteGroup->new(); # WebsiteGroup | 
my $opType = opType_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update website group api_response = api_instance.patch_website_group_by_id(id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling WebsiteGroupsApi->patchWebsiteGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchWebsiteGroupByIDParams()
    
// update website group resp, err := client.LM.PatchWebsiteGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchWebsiteGroupByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


updateWebsiteGroupById

update website group


/website/groups/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/groups/{id}?opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsiteGroupsApi;

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

public class WebsiteGroupsApiExample {

    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");

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

public class WebsiteGroupsApiExample {

    public static void main(String[] args) {
        WebsiteGroupsApi apiInstance = new WebsiteGroupsApi();
        Integer id = 56; // Integer | 
        WebsiteGroup body = ; // WebsiteGroup | 
        String opType = opType_example; // String | 
        try {
            WebsiteGroup result = apiInstance.updateWebsiteGroupById(id, body, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsiteGroupsApi#updateWebsiteGroupById");
            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; // 
WebsiteGroup *body = ; // 
String *opType = opType_example; //  (optional) (default to refresh)

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

// update website group
[apiInstance updateWebsiteGroupByIdWith:id
    body:body
    opType:opType
              completionHandler: ^(WebsiteGroup 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.WebsiteGroupsApi()

var id = 56; // {Integer} 

var body = ; // {WebsiteGroup} 

var opts = { 
  '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.updateWebsiteGroupById(id, body, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateWebsiteGroupByIdExample
    {
        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 WebsiteGroupsApi();
            var id = 56;  // Integer | 
            var body = new WebsiteGroup(); // WebsiteGroup | 
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            try
            {
                // update website group
                WebsiteGroup result = apiInstance.updateWebsiteGroupById(id, body, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsiteGroupsApi.updateWebsiteGroupById: " + 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\Api\WebsiteGroupsApi();
$id = 56; // Integer | 
$body = ; // WebsiteGroup | 
$opType = opType_example; // String | 

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

# 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::WebsiteGroupsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::WebsiteGroup->new(); # WebsiteGroup | 
my $opType = opType_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update website group api_response = api_instance.update_website_group_by_id(id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling WebsiteGroupsApi->updateWebsiteGroupById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateWebsiteGroupByIDParams()
    
// update website group resp, err := client.LM.UpdateWebsiteGroupByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateWebsiteGroupByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


Websites

addWebsite

add website


/website/websites

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

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

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        Website body = ; // Website | 
        try {
            Website result = apiInstance.addWebsite(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#addWebsite");
            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"];

Website *body = ; // 

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

// add website
[apiInstance addWebsiteWith:body
              completionHandler: ^(Website 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.WebsitesApi()

var body = ; // {Website} 


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

namespace Example
{
    public class addWebsiteExample
    {
        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 WebsitesApi();
            var body = new Website(); // Website | 

            try
            {
                // add website
                Website result = apiInstance.addWebsite(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.addWebsite: " + 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\Api\WebsitesApi();
$body = ; // Website | 

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

# 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::WebsitesApi->new();
my $body = WWW::SwaggerClient::Object::Website->new(); # Website | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add website api_response = api_instance.add_website(body) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->addWebsite: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddWebsiteParams()
    
// add website resp, err := client.LM.AddWebsite(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddWebsite: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


deleteWebsiteById

delete website


/website/websites/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

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

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteWebsiteById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#deleteWebsiteById");
            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; // 

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

// delete website
[apiInstance deleteWebsiteByIdWith: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.WebsitesApi()

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.deleteWebsiteById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteWebsiteByIdExample
    {
        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 WebsitesApi();
            var id = 56;  // Integer | 

            try
            {
                // delete website
                Object result = apiInstance.deleteWebsiteById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.deleteWebsiteById: " + 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\Api\WebsitesApi();
$id = 56; // Integer | 

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

# 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::WebsitesApi->new();
my $id = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete website api_response = api_instance.delete_website_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->deleteWebsiteById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteWebsiteByIDParams()
    
// delete website resp, err := client.LM.DeleteWebsiteByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteWebsiteByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


getSDTHistoryByWebsiteId

get SDT history for the website (Response may contain extra fields depending upon the type of SDT)


/website/websites/{id}/historysdts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites/{id}/historysdts?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

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

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            WebsiteSDTHistoryPaginationResponse result = apiInstance.getSDTHistoryByWebsiteId(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#getSDTHistoryByWebsiteId");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get SDT history for the website (Response may contain extra fields depending upon the type of SDT)
[apiInstance getSDTHistoryByWebsiteIdWith:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(WebsiteSDTHistoryPaginationResponse 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.WebsitesApi()

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.getSDTHistoryByWebsiteId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getSDTHistoryByWebsiteIdExample
    {
        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 WebsitesApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get SDT history for the website (Response may contain extra fields depending upon the type of SDT)
                WebsiteSDTHistoryPaginationResponse result = apiInstance.getSDTHistoryByWebsiteId(id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.getSDTHistoryByWebsiteId: " + 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\Api\WebsitesApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::WebsitesApi->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->getSDTHistoryByWebsiteId(id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebsitesApi->getSDTHistoryByWebsiteId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get SDT history for the website (Response may contain extra fields depending upon the type of SDT) api_response = api_instance.get_sdt_history_by_website_id(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->getSDTHistoryByWebsiteId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetSDTHistoryByWebsiteIDParams()
    
// get SDT history for the website (Response may contain extra fields depending upon the type of SDT) resp, err := client.LM.GetSDTHistoryByWebsiteID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetSDTHistoryByWebsiteID: %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


getSiteMonitorCheckPointList

get website checkpoint list


/website/smcheckpoints

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/smcheckpoints?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

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

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            SiteMonitorCheckPointPaginationResponse result = apiInstance.getSiteMonitorCheckPointList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#getSiteMonitorCheckPointList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get website checkpoint list
[apiInstance getSiteMonitorCheckPointListWith:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(SiteMonitorCheckPointPaginationResponse 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.WebsitesApi()

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.getSiteMonitorCheckPointList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getSiteMonitorCheckPointListExample
    {
        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 WebsitesApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get website checkpoint list
                SiteMonitorCheckPointPaginationResponse result = apiInstance.getSiteMonitorCheckPointList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.getSiteMonitorCheckPointList: " + 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\Api\WebsitesApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::WebsitesApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get website checkpoint list api_response = api_instance.get_site_monitor_check_point_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->getSiteMonitorCheckPointList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetSiteMonitorCheckPointListParams()
    
// get website checkpoint list resp, err := client.LM.GetSiteMonitorCheckPointList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetSiteMonitorCheckPointList: %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


getWebsiteAlertListByWebsiteId

get alerts for a website


/website/websites/{id}/alerts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites/{id}/alerts?needMessage=&customColumns=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        Boolean needMessage = true; // Boolean | 
        String customColumns = customColumns_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertPaginationResponse result = apiInstance.getWebsiteAlertListByWebsiteId(id, needMessage, customColumns, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#getWebsiteAlertListByWebsiteId");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebsitesApi;

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        Boolean needMessage = true; // Boolean | 
        String customColumns = customColumns_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            AlertPaginationResponse result = apiInstance.getWebsiteAlertListByWebsiteId(id, needMessage, customColumns, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#getWebsiteAlertListByWebsiteId");
            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 *needMessage = true; //  (optional) (default to false)
String *customColumns = customColumns_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get alerts for a website
[apiInstance getWebsiteAlertListByWebsiteIdWith:id
    needMessage:needMessage
    customColumns:customColumns
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(AlertPaginationResponse 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.WebsitesApi()

var id = 56; // {Integer} 

var opts = { 
  'needMessage': true, // {Boolean} 
  'customColumns': customColumns_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.getWebsiteAlertListByWebsiteId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWebsiteAlertListByWebsiteIdExample
    {
        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 WebsitesApi();
            var id = 56;  // Integer | 
            var needMessage = true;  // Boolean |  (optional)  (default to false)
            var customColumns = customColumns_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get alerts for a website
                AlertPaginationResponse result = apiInstance.getWebsiteAlertListByWebsiteId(id, needMessage, customColumns, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.getWebsiteAlertListByWebsiteId: " + 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\Api\WebsitesApi();
$id = 56; // Integer | 
$needMessage = true; // Boolean | 
$customColumns = customColumns_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::WebsitesApi->new();
my $id = 56; # Integer | 
my $needMessage = true; # Boolean | 
my $customColumns = customColumns_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->getWebsiteAlertListByWebsiteId(id => $id, needMessage => $needMessage, customColumns => $customColumns, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebsitesApi->getWebsiteAlertListByWebsiteId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get alerts for a website api_response = api_instance.get_website_alert_list_by_website_id(id, , , , , , ) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->getWebsiteAlertListByWebsiteId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsiteAlertListByWebsiteIDParams()
    
// get alerts for a website resp, err := client.LM.GetWebsiteAlertListByWebsiteID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWebsiteAlertListByWebsiteID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
Query parameters
Name Description
needMessage
Boolean
customColumns
String
fields
String
size
Integer (int32)
offset
Integer (int32)
filter
String

Responses

Status: 200 - successful operation

Status: default - Error


getWebsiteById

get website by id


/website/websites/{id}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites/{id}?format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        String format = format_example; // String | 
        try {
            Website result = apiInstance.getWebsiteById(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#getWebsiteById");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebsitesApi;

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        String format = format_example; // String | 
        try {
            Website result = apiInstance.getWebsiteById(id, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#getWebsiteById");
            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) (default to json)

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

// get website by id
[apiInstance getWebsiteByIdWith:id
    format:format
              completionHandler: ^(Website 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.WebsitesApi()

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.getWebsiteById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWebsiteByIdExample
    {
        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 WebsitesApi();
            var id = 56;  // Integer | 
            var format = format_example;  // String |  (optional)  (default to json)

            try
            {
                // get website by id
                Website result = apiInstance.getWebsiteById(id, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.getWebsiteById: " + 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\Api\WebsitesApi();
$id = 56; // Integer | 
$format = format_example; // String | 

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

# 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::WebsitesApi->new();
my $id = 56; # Integer | 
my $format = format_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get website by id api_response = api_instance.get_website_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->getWebsiteById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsiteByIDParams()
    
// get website by id resp, err := client.LM.GetWebsiteByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWebsiteByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


getWebsiteDataByGraphName

get website data by graph name


/website/websites/{id}/graphs/{graphName}/data

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites/{id}/graphs/{graphName}/data?start=&end=&format="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        String graphName = graphName_example; // String | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getWebsiteDataByGraphName(id, graphName, start, end, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#getWebsiteDataByGraphName");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.WebsitesApi;

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        String graphName = graphName_example; // String | 
        Long start = 789; // Long | 
        Long end = 789; // Long | 
        String format = format_example; // String | 
        try {
            GraphPlot result = apiInstance.getWebsiteDataByGraphName(id, graphName, start, end, format);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#getWebsiteDataByGraphName");
            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 *graphName = graphName_example; // 
Long *start = 789; //  (optional)
Long *end = 789; //  (optional)
String *format = format_example; //  (optional)

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

// get website data by graph name
[apiInstance getWebsiteDataByGraphNameWith:id
    graphName:graphName
    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.WebsitesApi()

var id = 56; // {Integer} 

var graphName = graphName_example; // {String} 

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.getWebsiteDataByGraphName(id, graphName, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWebsiteDataByGraphNameExample
    {
        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 WebsitesApi();
            var id = 56;  // Integer | 
            var graphName = graphName_example;  // String | 
            var start = 789;  // Long |  (optional) 
            var end = 789;  // Long |  (optional) 
            var format = format_example;  // String |  (optional) 

            try
            {
                // get website data by graph name
                GraphPlot result = apiInstance.getWebsiteDataByGraphName(id, graphName, start, end, format);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.getWebsiteDataByGraphName: " + 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\Api\WebsitesApi();
$id = 56; // Integer | 
$graphName = graphName_example; // String | 
$start = 789; // Long | 
$end = 789; // Long | 
$format = format_example; // String | 

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

# 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::WebsitesApi->new();
my $id = 56; # Integer | 
my $graphName = graphName_example; # String | 
my $start = 789; # Long | 
my $end = 789; # Long | 
my $format = format_example; # String | 

eval { 
    my $result = $api_instance->getWebsiteDataByGraphName(id => $id, graphName => $graphName, start => $start, end => $end, format => $format);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebsitesApi->getWebsiteDataByGraphName: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get website data by graph name api_response = api_instance.get_website_data_by_graph_name(id, graphName, , , ) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->getWebsiteDataByGraphName: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsiteDataByGraphNameParams()
    
// get website data by graph name resp, err := client.LM.GetWebsiteDataByGraphName(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWebsiteDataByGraphName: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required
graphName*
String
Required
Query parameters
Name Description
start
Long (int64)
end
Long (int64)
format
String

Responses

Status: 200 - successful operation

Status: default - Error


getWebsiteList

get website list


/website/websites

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites?collectorIds=&fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

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

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        String collectorIds = collectorIds_example; // String | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            WebsitePaginationResponse result = apiInstance.getWebsiteList(collectorIds, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#getWebsiteList");
            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 *collectorIds = collectorIds_example; //  (optional)
String *fields = fields_example; //  (optional)
Integer *size = 56; //  (optional)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get website list
[apiInstance getWebsiteListWith:collectorIds
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(WebsitePaginationResponse 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.WebsitesApi()

var opts = { 
  'collectorIds': collectorIds_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.getWebsiteList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWebsiteListExample
    {
        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 WebsitesApi();
            var collectorIds = collectorIds_example;  // String |  (optional) 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get website list
                WebsitePaginationResponse result = apiInstance.getWebsiteList(collectorIds, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.getWebsiteList: " + 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\Api\WebsitesApi();
$collectorIds = collectorIds_example; // String | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::WebsitesApi->new();
my $collectorIds = collectorIds_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->getWebsiteList(collectorIds => $collectorIds, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebsitesApi->getWebsiteList: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get website list api_response = api_instance.get_website_list(, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->getWebsiteList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsiteListParams()
    
// get website list resp, err := client.LM.GetWebsiteList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWebsiteList: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


getWebsitePropertyListByWebsiteId

get a list of properties for a website


/website/websites/{id}/properties

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites/{id}/properties?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

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

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            PropertyPaginationResponse result = apiInstance.getWebsitePropertyListByWebsiteId(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#getWebsitePropertyListByWebsiteId");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get a list of properties for a website
[apiInstance getWebsitePropertyListByWebsiteIdWith:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(PropertyPaginationResponse 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.WebsitesApi()

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.getWebsitePropertyListByWebsiteId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWebsitePropertyListByWebsiteIdExample
    {
        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 WebsitesApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get a list of properties for a website
                PropertyPaginationResponse result = apiInstance.getWebsitePropertyListByWebsiteId(id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.getWebsitePropertyListByWebsiteId: " + 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\Api\WebsitesApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::WebsitesApi->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->getWebsitePropertyListByWebsiteId(id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebsitesApi->getWebsitePropertyListByWebsiteId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get a list of properties for a website api_response = api_instance.get_website_property_list_by_website_id(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->getWebsitePropertyListByWebsiteId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsitePropertyListByWebsiteIDParams()
    
// get a list of properties for a website resp, err := client.LM.GetWebsitePropertyListByWebsiteID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWebsitePropertyListByWebsiteID: %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


getWebsiteSDTListByWebsiteId

get a list of SDTs for a website


/website/websites/{id}/sdts

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites/{id}/sdts?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

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

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            SDTPaginationResponse result = apiInstance.getWebsiteSDTListByWebsiteId(id, fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#getWebsiteSDTListByWebsiteId");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get a list of SDTs for a website
[apiInstance getWebsiteSDTListByWebsiteIdWith:id
    fields:fields
    size:size
    offset:offset
    filter:filter
              completionHandler: ^(SDTPaginationResponse 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.WebsitesApi()

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.getWebsiteSDTListByWebsiteId(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWebsiteSDTListByWebsiteIdExample
    {
        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 WebsitesApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get a list of SDTs for a website
                SDTPaginationResponse result = apiInstance.getWebsiteSDTListByWebsiteId(id, fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.getWebsiteSDTListByWebsiteId: " + 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\Api\WebsitesApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::WebsitesApi->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->getWebsiteSDTListByWebsiteId(id => $id, fields => $fields, size => $size, offset => $offset, filter => $filter);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling WebsitesApi->getWebsiteSDTListByWebsiteId: $@\n";
}
from __future__ import print_function
import time
import logicmonitor_sdk
from logicmonitor_sdk.rest import ApiException
from pprint import pprint


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get a list of SDTs for a website api_response = api_instance.get_website_sdt_list_by_website_id(id, , , , ) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->getWebsiteSDTListByWebsiteId: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWebsiteSDTListByWebsiteIDParams()
    
// get a list of SDTs for a website resp, err := client.LM.GetWebsiteSDTListByWebsiteID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWebsiteSDTListByWebsiteID: %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


patchWebsiteById

update website


/website/websites/{id}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites/{id}?opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

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

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        Website body = ; // Website | 
        String opType = opType_example; // String | 
        try {
            Website result = apiInstance.patchWebsiteById(id, body, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#patchWebsiteById");
            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; // 
Website *body = ; // 
String *opType = opType_example; //  (optional) (default to refresh)

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

// update website
[apiInstance patchWebsiteByIdWith:id
    body:body
    opType:opType
              completionHandler: ^(Website 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.WebsitesApi()

var id = 56; // {Integer} 

var body = ; // {Website} 

var opts = { 
  '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.patchWebsiteById(id, body, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class patchWebsiteByIdExample
    {
        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 WebsitesApi();
            var id = 56;  // Integer | 
            var body = new Website(); // Website | 
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            try
            {
                // update website
                Website result = apiInstance.patchWebsiteById(id, body, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.patchWebsiteById: " + 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\Api\WebsitesApi();
$id = 56; // Integer | 
$body = ; // Website | 
$opType = opType_example; // String | 

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

# 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::WebsitesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Website->new(); # Website | 
my $opType = opType_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update website api_response = api_instance.patch_website_by_id(id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->patchWebsiteById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchWebsiteByIDParams()
    
// update website resp, err := client.LM.PatchWebsiteByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchWebsiteByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


updateWebsiteById

update website


/website/websites/{id}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/website/websites/{id}?opType="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WebsitesApi;

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

public class WebsitesApiExample {

    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");

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

public class WebsitesApiExample {

    public static void main(String[] args) {
        WebsitesApi apiInstance = new WebsitesApi();
        Integer id = 56; // Integer | 
        Website body = ; // Website | 
        String opType = opType_example; // String | 
        try {
            Website result = apiInstance.updateWebsiteById(id, body, opType);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WebsitesApi#updateWebsiteById");
            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; // 
Website *body = ; // 
String *opType = opType_example; //  (optional) (default to refresh)

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

// update website
[apiInstance updateWebsiteByIdWith:id
    body:body
    opType:opType
              completionHandler: ^(Website 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.WebsitesApi()

var id = 56; // {Integer} 

var body = ; // {Website} 

var opts = { 
  '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.updateWebsiteById(id, body, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class updateWebsiteByIdExample
    {
        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 WebsitesApi();
            var id = 56;  // Integer | 
            var body = new Website(); // Website | 
            var opType = opType_example;  // String |  (optional)  (default to refresh)

            try
            {
                // update website
                Website result = apiInstance.updateWebsiteById(id, body, opType);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WebsitesApi.updateWebsiteById: " + 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\Api\WebsitesApi();
$id = 56; // Integer | 
$body = ; // Website | 
$opType = opType_example; // String | 

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

# 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::WebsitesApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Website->new(); # Website | 
my $opType = opType_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update website api_response = api_instance.update_website_by_id(id, body, ) pprint(api_response) except ApiException as e: print("Exception when calling WebsitesApi->updateWebsiteById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateWebsiteByIDParams()
    
// update website resp, err := client.LM.UpdateWebsiteByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateWebsiteByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

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

Responses

Status: 200 - successful operation

Status: default - Error


Widgets

addWidget

add widget (Based upon widget type the request and 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

Usage and SDK Samples

curl -X POST -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/dashboard/widgets"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetsApi;

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

public class WidgetsApiExample {

    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");

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

public class WidgetsApiExample {

    public static void main(String[] args) {
        WidgetsApi apiInstance = new WidgetsApi();
        Widget body = ; // Widget | 
        try {
            Widget result = apiInstance.addWidget(body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetsApi#addWidget");
            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"];

Widget *body = ; // 

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

// add widget (Based upon widget type the request and response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes)
[apiInstance addWidgetWith:body
              completionHandler: ^(Widget 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.WidgetsApi()

var body = ; // {Widget} 


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

namespace Example
{
    public class addWidgetExample
    {
        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 WidgetsApi();
            var body = new Widget(); // Widget | 

            try
            {
                // add widget (Based upon widget type the request and response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes)
                Widget result = apiInstance.addWidget(body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetsApi.addWidget: " + 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\Api\WidgetsApi();
$body = ; // Widget | 

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

# 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::WidgetsApi->new();
my $body = WWW::SwaggerClient::Object::Widget->new(); # Widget | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # add widget (Based upon widget type the request and 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.add_widget(body) pprint(api_response) except ApiException as e: print("Exception when calling WidgetsApi->addWidget: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewAddWidgetParams()
    
// add widget (Based upon widget type the request and response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes) resp, err := client.LM.AddWidget(params) if err != nil { fmt.Printf("Exception when calling client.LM.AddWidget: %v", err.Error()) } fmt.Print(resp) }

Parameters

Body parameters
Name Description
body *

Responses

Status: 200 - successful operation

Status: default - Error


deleteWidgetById

delete widget


/dashboard/widgets/{id}

Usage and SDK Samples

curl -X DELETE -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/dashboard/widgets/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetsApi;

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

public class WidgetsApiExample {

    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");

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

public class WidgetsApiExample {

    public static void main(String[] args) {
        WidgetsApi apiInstance = new WidgetsApi();
        Integer id = 56; // Integer | 
        try {
            Object result = apiInstance.deleteWidgetById(id);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetsApi#deleteWidgetById");
            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; // 

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

// delete widget
[apiInstance deleteWidgetByIdWith: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.WidgetsApi()

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.deleteWidgetById(id, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class deleteWidgetByIdExample
    {
        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 WidgetsApi();
            var id = 56;  // Integer | 

            try
            {
                // delete widget
                Object result = apiInstance.deleteWidgetById(id);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetsApi.deleteWidgetById: " + 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\Api\WidgetsApi();
$id = 56; // Integer | 

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

# 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::WidgetsApi->new();
my $id = 56; # Integer | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # delete widget api_response = api_instance.delete_widget_by_id(id) pprint(api_response) except ApiException as e: print("Exception when calling WidgetsApi->deleteWidgetById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewDeleteWidgetByIDParams()
    
// delete widget resp, err := client.LM.DeleteWidgetByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.DeleteWidgetByID: %v", err.Error()) } fmt.Print(resp) }

Parameters

Path parameters
Name Description
id*
Integer (int32)
Required

Responses

Status: 200 - successful operation

Status: default - Error


getWidgetById

get widget by id (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}

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/dashboard/widgets/{id}?fields="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetsApi;

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

public class WidgetsApiExample {

    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");

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

public class WidgetsApiExample {

    public static void main(String[] args) {
        WidgetsApi apiInstance = new WidgetsApi();
        Integer id = 56; // Integer | 
        String fields = fields_example; // String | 
        try {
            Widget result = apiInstance.getWidgetById(id, fields);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetsApi#getWidgetById");
            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)

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

// get widget by id (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 getWidgetByIdWith:id
    fields:fields
              completionHandler: ^(Widget 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.WidgetsApi()

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.getWidgetById(id, opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWidgetByIdExample
    {
        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 WidgetsApi();
            var id = 56;  // Integer | 
            var fields = fields_example;  // String |  (optional) 

            try
            {
                // get widget by id (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)
                Widget result = apiInstance.getWidgetById(id, fields);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetsApi.getWidgetById: " + 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\Api\WidgetsApi();
$id = 56; // Integer | 
$fields = fields_example; // String | 

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

# 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::WidgetsApi->new();
my $id = 56; # Integer | 
my $fields = fields_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get widget by id (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_by_id(id, ) pprint(api_response) except ApiException as e: print("Exception when calling WidgetsApi->getWidgetById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWidgetByIDParams()
    
// get widget by id (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) resp, err := client.LM.GetWidgetByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWidgetByID: %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


getWidgetList

get widget list (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

Usage and SDK Samples

curl -X GET -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/dashboard/widgets?fields=&size=&offset=&filter="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetsApi;

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

public class WidgetsApiExample {

    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");

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

public class WidgetsApiExample {

    public static void main(String[] args) {
        WidgetsApi apiInstance = new WidgetsApi();
        String fields = fields_example; // String | 
        Integer size = 56; // Integer | 
        Integer offset = 56; // Integer | 
        String filter = filter_example; // String | 
        try {
            WidgetPaginationResponse result = apiInstance.getWidgetList(fields, size, offset, filter);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetsApi#getWidgetList");
            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)
Integer *offset = 56; //  (optional)
String *filter = filter_example; //  (optional)

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

// get widget list (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 getWidgetListWith: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.WidgetsApi()

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.getWidgetList(opts, callback);
using System;
using System.Diagnostics;
using logicmonitor_sdk.Api;
using logicmonitor_sdk.Client;
using logicmonitor_sdk.Model;

namespace Example
{
    public class getWidgetListExample
    {
        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 WidgetsApi();
            var fields = fields_example;  // String |  (optional) 
            var size = 56;  // Integer |  (optional) 
            var offset = 56;  // Integer |  (optional) 
            var filter = filter_example;  // String |  (optional) 

            try
            {
                // get widget list (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)
                WidgetPaginationResponse result = apiInstance.getWidgetList(fields, size, offset, filter);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetsApi.getWidgetList: " + 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\Api\WidgetsApi();
$fields = fields_example; // String | 
$size = 56; // Integer | 
$offset = 56; // Integer | 
$filter = filter_example; // String | 

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

# 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::WidgetsApi->new();
my $fields = fields_example; # String | 
my $size = 56; # Integer | 
my $offset = 56; # Integer | 
my $filter = filter_example; # String | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # get widget list (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_list(, , , ) pprint(api_response) except ApiException as e: print("Exception when calling WidgetsApi->getWidgetList: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewGetWidgetListParams()
    
// get widget list (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) resp, err := client.LM.GetWidgetList(params) if err != nil { fmt.Printf("Exception when calling client.LM.GetWidgetList: %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


patchWidgetById

update widget (Based upon widget type the request and 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}

Usage and SDK Samples

curl -X PATCH -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/dashboard/widgets/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetsApi;

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

public class WidgetsApiExample {

    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");

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

public class WidgetsApiExample {

    public static void main(String[] args) {
        WidgetsApi apiInstance = new WidgetsApi();
        Integer id = 56; // Integer | 
        Widget body = ; // Widget | 
        try {
            Widget result = apiInstance.patchWidgetById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetsApi#patchWidgetById");
            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; // 
Widget *body = ; // 

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

// update widget (Based upon widget type the request and response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes)
[apiInstance patchWidgetByIdWith:id
    body:body
              completionHandler: ^(Widget 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.WidgetsApi()

var id = 56; // {Integer} 

var body = ; // {Widget} 


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

namespace Example
{
    public class patchWidgetByIdExample
    {
        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 WidgetsApi();
            var id = 56;  // Integer | 
            var body = new Widget(); // Widget | 

            try
            {
                // update widget (Based upon widget type the request and response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes)
                Widget result = apiInstance.patchWidgetById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetsApi.patchWidgetById: " + 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\Api\WidgetsApi();
$id = 56; // Integer | 
$body = ; // Widget | 

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

# 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::WidgetsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Widget->new(); # Widget | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update widget (Based upon widget type the request and 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.patch_widget_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling WidgetsApi->patchWidgetById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewPatchWidgetByIDParams()
    
// update widget (Based upon widget type the request and response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes) resp, err := client.LM.PatchWidgetByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.PatchWidgetByID: %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


updateWidgetById

update widget (Based upon widget type the request and 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}

Usage and SDK Samples

curl -X PUT -H "Authorization: [[apiKey]]" "https://localhost/santaba/rest/dashboard/widgets/{id}"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.WidgetsApi;

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

public class WidgetsApiExample {

    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");

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

public class WidgetsApiExample {

    public static void main(String[] args) {
        WidgetsApi apiInstance = new WidgetsApi();
        Integer id = 56; // Integer | 
        Widget body = ; // Widget | 
        try {
            Widget result = apiInstance.updateWidgetById(id, body);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WidgetsApi#updateWidgetById");
            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; // 
Widget *body = ; // 

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

// update widget (Based upon widget type the request and response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes)
[apiInstance updateWidgetByIdWith:id
    body:body
              completionHandler: ^(Widget 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.WidgetsApi()

var id = 56; // {Integer} 

var body = ; // {Widget} 


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

namespace Example
{
    public class updateWidgetByIdExample
    {
        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 WidgetsApi();
            var id = 56;  // Integer | 
            var body = new Widget(); // Widget | 

            try
            {
                // update widget (Based upon widget type the request and response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes)
                Widget result = apiInstance.updateWidgetById(id, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling WidgetsApi.updateWidgetById: " + 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\Api\WidgetsApi();
$id = 56; // Integer | 
$body = ; // Widget | 

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

# 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::WidgetsApi->new();
my $id = 56; # Integer | 
my $body = WWW::SwaggerClient::Object::Widget->new(); # Widget | 

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


# Configure API key authorization: LMv1
configuration = logicmonitor_sdk.Configuration()
configuration.company = 'YOUR_COMPANY'
configuration.access_id = 'YOUR_ACCESS_ID'
configuration.access_key = 'YOUR_ACCESS_KEY'

# create an instance of the API class
api_instance = logicmonitor_sdk.LMApi(logicmonitor_sdk.ApiClient(configuration))
    
try: # update widget (Based upon widget type the request and 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.update_widget_by_id(id, body) pprint(api_response) except ApiException as e: print("Exception when calling WidgetsApi->updateWidgetById: %s\n" % e)
package main

import (
    "fmt"
    "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"
accessID := "YOUR_ACCESS_ID"
accessKey := "YOUR_ACCESS_KEY"

config := client.NewConfig()
config.SetAccountDomain(&domain)
config.SetAccessID(&accessID)
config.SetAccessKey(&accessKey)

// create an instance of the API class
client := client.New(config)
params := lm.NewUpdateWidgetByIDParams()
    
// update widget (Based upon widget type the request and response may contain additional attributes. Please refer models corresponding to specific widget type at the bottom of this page to check the attributes) resp, err := client.LM.UpdateWidgetByID(params) if err != nil { fmt.Printf("Exception when calling client.LM.UpdateWidgetByID: %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