REST API d’OpManager

OpManager propose des API REST pour ajouter et récupérer des données à partir de ce dernier. À l'aide de ces API, vous pouvez intégrer OpManager avec un logiciel de gestion informatique / centre de services tiers.

 

 

Comment fonctionnent les API REST d’OpManager ?

Les API fonctionnent avec une clé API. La clé API est unique pour chaque compte OpManager et doit être transmise en tant que paramètre dans chaque demande d'API effectuée. Tout d'abord, générez une clé API.

 

Générer une clé API

Pour générer une clé API, accédez à Paramètres > Paramètres de base > API REST dans le client Web OpManager et cliquez sur Régénérer la clé.

Liste des API

Nom d’APIFormat d’APIMéthodeDescription
Add UseraddUserpostAjoute un utilisateur dans OpManager.
Add DomainaddDomainpostAjoute un domaine dans OpManager.
Delete DomaindeleteDomainpostSupprime un domaine dans OpManager.
List CredentialslistCredentialsgetDonne la liste des informations d'identification créées dans OpManager.
List UserslistUsersgetRépertorie tous les utilisateurs créés dans OpManager.
Delete UserdeleteUserpostSupprime un utilisateur.
Change PasswordchangePasswordpostVous permet de changer le mot de passe d'un utilisateur.
Update user contact detailsupdateContactDetailspostVous permet de mettre à jour les coordonnées d'un utilisateur.
Add Downtime ScheduleaddDowntimeSchedulepostAjoute un nouveau programme d'indisponibilité
Update Downtime ScheduleupdateDowntimeSchedulepostMet à jour un calendrier d'indisponibilité spécifique
Get Downtime SchedulegetDowntimeSchedulegetUtilisé pour obtenir tous les détails sur un programme d'arrêt particulier
List Downtime ScheduleslistDownTimeSchedulesgetDonne la liste des programmes d'arrêt créés.
Delete Downtime SchedulesdeleteDownTimeSchedulespostRépertorie tous les modèles de périphérique créés dans OpManager.
List Device TemplateslistDeviceTemplatesgetRépertorie tous les profils de notification créés dans OpManager.
List Notification ProfileslistNotificationProfilesgetRépertorie tous les moniteurs de service créés.
List Syslog ruleslistSysLogRulesgetRépertorie toutes les règles syslog créées.
List Url monitorslistURLMonitorsgetRépertorie tous les moniteurs d'URL créés.
Trap ProcessorslistTrapProcessorsgetRépertorie tous les processeurs de trap créés.
Script MonitorslistScriptMonitorsgetRépertorie tous les moniteurs de script créés.
Get Proxy SettingsGetProxyServerSettingsgetFournit les détails des paramètres du serveur proxy.
Get SMS Server SettingsGetSMSServerSettingsgetFournit les détails des paramètres du serveur SMS.
Add SMS Server SettingsconfigureSMSServerSettingspostPermet de configurer les paramètres du serveur SMS.
List Alarm Escalation ruleslistAlarmEscalationRulesgetRépertorie toutes les règles d'escalade d'alarmes créées.
List ProbeslistProbesgetRépertorie toutes les sondes disponibles dans OpManager.
List Perfomance MonitorslistPerformanceMonitorsgetRépertorie tous les moniteurs de performances ajoutés.
List Interface TemplateslistInterfaceTemplatesgetRépertorie tous les modèles d'interface créés.
Get Mail Server SettingsGetMailServerSettingsgetFournit les détails des paramètres du serveur de messagerie.
Add deviceaddDevicepostAjouter un périphérique.
Delete DevicedeleteDevicepostSupprime un appareil.
Add device to BVaddDeviceToBVpostAjoute des appareils à une vue d'entreprise déjà créée.
Add device to Google MapaddDeviceToGMappostAjoute des appareils à Google map.
Add Business viewaddBusinessViewpostAjoute une nouvelle vue d'entreprise.
Get Infrastructure DetailsgetInfrastructureDetailsViewgetFournit les détails de l'infrastructure, c'est-à-dire les serveurs, les routeurs, etc. gérés par OpManager.
Get Infrastructure ViewsgetInfrastructureViewgetFournit les détails d'un type d'infrastructure particulier. ex : serveurs.
Get Down devicesgetDownDevicesgetFournit les détails des appareils en panne.
Search devicesearchDevicegetVous permet de rechercher un appareil.
All WAN MetricsgetAllWanMetricsgetRépertorie tous les moniteurs WAN créés.
All VOIP MetricsgetAllVoipMetricsgetRépertorie tous les moniteurs VoIP créés.
Re discover InterfacesreDiscoverInterfacespostRedécouvre les interfaces.
Discover InterfacediscoverInterfacepostDécouvre une interface.
Add Layer2MapaddLayer2MappostAjouter une nouvelle carte Layer2 dans OpManager
Discover Layer2mapdiscoverLayer2MappostDécouvrez une carte Layer2 existante
Delete Layer2MapdeleteLayer2MappostSupprimer une carte Layer2
Discover Layer2 devicesdiscoverLayer2DevicespostAjouter de nouveaux périphériques Layer2
Get Discovered Layer2 DevicesgetDiscoveredLayer2MapgetObtenez une liste des périphériques Layer2 déjà découverts
Add EventaddEventpostAjoute un événement.
Top Devices By EventsgetTopDevicesByEventsgetRépertorie les principaux appareils par nombre d'événements.
List AlarmslistAlarmsgetListe toutes les alarmes disponibles.
Acknowledge AlarmacknowledgeAlarmpostPermet d'acquitter une alarme.
Un Acknowledge AlarmunAcknowledgeAlarmpostPermet de ne pas reconnaître une alarme.
Clear an AlarmclearAlarmpostEfface une alarme.
Delete AlarmdeleteAlarmpostSupprime une alarme.
Add Notes to AlarmaddNotespostAjoute des notes à une alarme.
Get NotesgetAnnotationgetFournit les notes disponibles pour une alarme.
Get Alarm DetailsalarmPropertiesgetFournit les détails d'une alarme, par exemple : état, acquittement
Top Devices By AlarmsgetTopDevicesByAlarmsgetFournit la liste des principaux appareils par nombre d'alarmes.
Ping devicegetPingResponsegetPing un appareil et fournit la réponse.
Trace devicegetTraceResponsegetVous permet d'obtenir le traceroute vers un appareil.
List deviceslistDevicesgetRépertorie tous les périphériques ajoutés dans OpManager.
Device SummarygetDeviceSummarygetFournit les détails récapitulatifs d'un périphérique.
Associated Notification ProfilesgetNotificationProfilesgetFournit la liste des profils associés aux notifications d'un appareil.
Associated WorkflowsgetWorkFlowsgetFournit la liste des workflows associés à un périphérique.
Device NotesgetDeviceNotesgetFournit les détails des notes telles que le numéro d'étage et le nom du service ajouté à un appareil.
Associated MonitorsgetAssociatedMonitorsgetFournit la liste des moniteurs associés à un périphérique.
Update Device StatusupdateDeviceStatusgetEffectue un ping de l'appareil et met à jour l'état correct d'un appareil.
List InterfaceslistInterfacesgetRépertorie toutes les interfaces dans OpManager.
Get Interfaces of DevicegetInterfacesgetFournit la liste des interfaces dans un périphérique.
Probe URLgetProbeURLgetFournit l'URL de la sonde.
Add notes to DeviceaddNotesToDevicepostAjoute des notes à un appareil.
Interface SummarygetInterfaceSummarygetFournit les détails récapitulatifs d'une interface.
Availability graph datagetAvailabiltyGraphDatagetFournit les données utilisées pour calculer le graphique de disponibilité.
Interface notesgetInterfaceNotesgetFournit les détails des notes ajoutées à une interface.
Interface MonitorsgetInterfaceMonitorsgetFournit la liste des moniteurs associés à une interface.
Interface TypesgetInterfaceTypesgetFournit le type d'interface. par exemple : série, ethernet.
Workflow List for DevicegetWorkflowListgetRépertorie tous les workflows associés à un périphérique.
Trigger Workflow for DevicetriggerWorkflowpostPermet de déclencher un workflow sur un appareil.
Business view DetailsgetBusinessDetailsViewgetRépertorie tous les appareils disponibles dans une vue d'entreprise.
Business viewsgetBusinessViewgetRépertorie toutes les vues d'entreprise créées.
List RackslistRacksgetListe tous les racks créés.
List FloorslistFloorsgetRépertorie tous les étages créés.
Get Floor detailsgetFloorDetailsgetFournit les détails du sol. par exemple : la taille du sol, la taille des carreaux.
Get Layer2Map detailsgetLayer2MapsgetFournit tous les détails sur les cartes Layer2 spécifiées.
Get Polls per secondgetPollsPerSecgetFournit les interrogations actuelles par seconde d'OpManager.
System SettingsgetSystemSettingsDetailsgetFournit les détails des paramètres système d'OpManager.
Update System settingsupdateSystemSettingsDetailsgetPermet de mettre à jour les paramètres système.
Associate Notification ProfileassociateNotificationProfilespostPermet d'associer plusieurs profils de notification à plusieurs appareils
 

Critères

Identifiant des critères

Status Poll (L'appareil manque 1/3/5 polls)

#0000000000000000000000000000000

(# représente le nombre de sondages, il peut être remplacé par 1 ou 3 ou 5 ou a;

1 pour sélectionner 1 poll ou 3 pour sélectionner 3 polls ou 5 pour sélectionner 5 polls ou a pour sélectionner 1,3,5 polls)

Trap › received01000000000000000000000000000000
Interface -› problems00100000000000000000000000000000
Service › down00010000000000000000000000000000
Windows Service › down00001000000000000000000000000000
Event Log › generates alarm00000100000000000000000000000000
SysLog › generated alarm00000010000000000000000000000000
AdMonitor › down00000001000000000000000000000000
Exchange Monitor › down00000000100000000000000000000000
MSSQL Monitor › violated00000000010000000000000000000000
AdService › down00000000001000000000000000000000
Exchange Service › down00000000000100000000000000000000
MSSQL Service › down00000000000010000000000000000000
Threshold › violated00000000000001000000000000000000
Process Monitor › violated00000000000000100000000000000000
IPSLA Monitor › violated00000000000000010000000000000000
File Monitor › violated00000000000000001000000000000000
Folder Monitor › violated00000000000000000100000000000000
Printer Monitor › violated00000000000000000010000000000000
UPS Monitor › down00000000000000000001000000000000
URL › down00000000000000000000100000000000
Virtual Device Monitor › down00000000000000000000010000000000
Script Monitor › down00000000000000000000001000000000
Probe › down00000000000000000000000100000000
Agent › down00000000000000000000000010000000
Hardware monitor › down00000000000000000000000001000000
NCM Backup › Failed00000000000000000000000000100000
NCM Config › changes00000000000000000000000000010000
NFA Alarm › generates alarm00000000000000000000000000001000
UCS Fault received00000000000000000000000000000100
Storage Alarm00000000000000000000000000000010
Alarm › cleared00000000000000000000000000000001
 
Détails de l'API REST du Large Enterprise Edition :

 
Documentation de l'API REST d’OpManager
REST APIMéthodeDescriptionParamètresExemple d'URL
Module Admin
addSysLogForwarderPOSTAdd SysLog Forwarder
apiKey* - API Key to access your OpManager server.

destHost* - Destination Host.

destPort* - Destination Port(0 – 65536)
http://localhost:8060/api/json/admin/addSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-3&destPort=515
addSysLogRulePOSTAdd SysLog Rule

apiKey* - API Key to access your OpManager server.

ruleName* - Name of the rule

facilityName* - SysLog Facility

severityList* - SysLog Severity(Comma Separated)

alertSeverity* - OpManager Alert Severity

alarmMessage* - OpManager Alert Message

matchString - String matched with incoming syslog message

consecutiveTime* - consecutive time

timeInterval* - time interval
(if rearmFacilityName is selected then rearmSeverityList should be selected)

rearmFacilityName - facility name for rearm syslog

rearmSeverityList - severity list for rearm syslog

rearmMatchString - String matched with incoming syslog for rearm
http://localhost:8060/api/json/admin/addSysLogRule?apiKey=081c9ac51ba16ab061d5efee583dcd2f&alertSeverity=1&facilityName=auth&ruleName=test11&alarmMessage=test&severityList=alert
addTrapForwarderPOSTAdd Trap ForwarderapiKey* - API Key to access your OpManager server.

destHost* - Destination Host.

destPort* - Destination Port.
http://localhost:8060/api/json/admin/addTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-6&destPort=165
deleteCredentialPOSTDelete CredentialsapiKey* - API Key to access your OpManager server.

credentialName* - Name of the credential.

isSNMPV3 – true or false.
http://localhost:8060/api/json/admin/deleteCredential?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public
getCredentialDetailsGETGet Credential detailsapiKey* - API Key to access your OpManager server.

credentialName* - Name of the credential.

type* - Type of the device eg. Windows, Linux, SNMP v1/v2, SNMP v3 or Vmware.
http://localhost:8060/api/json/admin/getCredentialDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public&type=SNMP v1/v2
getFlowRateGETGet SysLog Flow RateapiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/getFlowRate?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getSystemSettingsDetailsGETProvides the details of OpManager System Settings.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/getSystemSettingsDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f
updateSystemSettingsDetailsGETAllows to update the system settings.apiKey* - API Key to access your OpManager server.

ALARMMESSAGELENGTH -
Any positive Integer.

CLILOG – false/true.

DATACOLLECTIONRATE -
true/false

DEBUGPRINTS - false/true

POLLPERSECOND - true/false

SCHEDULERRATE - false/true

SNMPLOG - false/true

SNMPV3LOG - false/true

ShowAds - true/false

WMILOG - false/true

benchmarkupload - enable/disable

metrackupload - enable/disable

quicklinks – enable/disable
http://localhost:8060/api/json/admin/updateSystemSettingsDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&SNMPV3LOG=false&ShowAds=true&ALARMMESSAGELENGTH=100&DATACOLLECTIONRATE=true&metrackupload=enable&quicklinks=enable&POLLPERSECOND=true&DEBUGPRINTS=false&WMILOG=false&SCHEDULERRATE=false&SNMPLOG=false&benchmarkupload=enable&CLILOG=false
listPluginEventsGETGet events raised by the installed plugin application
apiKey* - API Key to access your OpManager server.

pluginName* - Name of the plugin whose event is needed.

eventTime* - Period in which event generated (for all events, say All).
http://localhost:8060/api/json/alarm/listPluginEvents?apiKey=6d36ff8426cff396b81b248e5c458604&pluginName=All&eventTime=All
getPluginEventCountGETGet count of events raised by the installed plugin application
apiKey* - API Key to access your OpManager server.

fromTime* - Start time.

toTime* - End time.
http://localhost:8060/api/json/alarm/getPluginEventCount?apiKey=6d36ff8426cff396b81b248e5c458604&fromTime=2014-2-20 13:32:8&toTime=2014-2-20 14:2:8
getPluginDetailsGETFetches information of the installed plugins
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/getPluginDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f
upadateTrapParserPOSTUpdate trap parser
apiKey* - API Key to access your OpManager server.

version* - Version.

oid* - Device OID.

TrapParserName* - Name of the trap parser.
http://localhost:8060/api/json/admin/upadateTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&version=v2&oid='.2.2.2.2.2.'&trapParserName=testing
updateLanguageSettingsPOSTUpdate language settings
apiKey* - API Key to access your OpManager server.

languageSelected* - Selected language.
http://localhost:8060/api/json/admin/updateLanguageSettings?apiKey=6d36ff8426cff396b81b248e5c458604&languageSelected=fr_FR
getLanguageSettingsGETObtains language settings.
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/getLanguageSettings?apiKey=1d626117b2ac31145ce6bca49bb0458b
addDeviceToNProfile *API applicable from 123307POSTAdds devices to a notification profile that is already created.

apiKey* - API Key to access your OpManager server.

deviceName* - MO Name of the device to which the notification profile has to be associated.
MO Name of the device can be fetched using device displayName(Select Name,DisplayName from ManagedObject where DisplayName='<deviceDisplayName>')

profileName* - Name of the notification profile.

criteria* - There are 32 criteria. mentioned required criteriaid(**Refer the list mentioned at the end of this table.

selectedseverities - There are 4 severities.(1,2,3,4 for Critical,Trouble,Attention,ServiceDown or 1,3 for Critical,Attention and like ) Severities to be selected for which you want to trigger the notification profile. Add multiple severities by a comma. If param not given by default all severites will be selected.

performanceMonitors - List of monitors for which you want to trigger the notification profile when threshold is violated. Add multiple monitors separated by a comma.

probeName - [additional param- Only for Central] - name of the probe

 

http://localhost/api/json/discovery/addDeviceToNProfile?apiKey=ac130763a309fcb1613e0b8a551950a2&deviceName=localhost.testdomainin.com&profileName=TestNotify&criteria=31001100001010000000000110000011&performanceMonitors=DiskUtilization,Win-CPUUtilization
triggerWorkflowPOSTAllows to trigger a workflow on a device.apiKey* - API Key to access your OpManager server.

workflowName* - Name of the workflow that has to be executed.

deviceName* -
Name of the device on which the workflow has to be executed.
http://localhost:8060/api/json/workflow/triggerWorkflow?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&workflowName=Instant Device Check
deleteFailOverDetailsPOSTDeletes the fail-over server details
apiKey* - API Key to access your OpManager server.
http://localhost:8070/api/json/admin/deleteFailOverDetails?apiKey=6d36ff8426cff396b81b248e5c458604
updateFailOverDetailsPOSTUpdates fail-over server details
apiKey* - API Key to access your OpManager server.
http://localhost:8070/api/json/admin/updateFailOverDetails?apiKey=6d36ff8426cff396b81b248e5c458604
listFailOverDetailsGETLists the fail-over server details
apiKey* - API Key to access your OpManager server.

serviceName* - Failover device name.
http://localhost:8060/api/json/admin/listFailOverDetails?serviceName=DNS&apiKey=081c9ac51ba16ab061d5efee583dcd2f
registerLicensePOSTRegisters the license file
apiKey* - API Key to access your OpManager server.

fileName* - License File name.
http://localhost:8060/api/json/admin/registerLicense?apiKey=6d36ff8426cff396b81b248e5c458604
licenseDetailsGETFetches license details
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/licenseDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getCredentialMappedDevicesGETLists devices mapped to the given credential
apiKey* - API Key to access your OpManager server.

credentialName* - License File name.
http://localhost:8060/api/json/admin/getCredentialMappedDevices?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public
sendSIFPOSTSends support information file.
apiKey* - API Key to access your OpManager server.

customerName* - Customer name/email ID.

phone* - Contact number.

subject* - Mail subject.

userMessage* - Mail body message.

fromAddress* - From email address.

supportFile* - File name or zip file.
http://localhost:8060/api/json/admin/sendSIF?apiKey=6d36ff8426cff396b81b248e5c458604&customerName=administrator@opmanager.com&phone=7781&subject=OpmLogs&userMessage=opm logs for analyzing issue&fromAddress=mohamedthahir.n@testdomain.com&supportFile=OpMan_11200_Feb_20_2014_15_58_30.zip
createSIFGETCreates a support information zip file
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/createSIF?apiKey=081c9ac51ba16ab061d5efee583dcd2f
viewLogsGETLists all the OpManager logs
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/viewLogs?apiKey=081c9ac51ba16ab061d5efee583dcd2f
updateJvmHeapSizePOSTUpdates JVM Heap size
apiKey* - API Key to access your OpManager server.

jvmHeapSize* - New JVM Heap size
http://localhost:8060/api/json/admin/updateJvmHeapSize?apiKey=6d36ff8426cff396b81b248e5c458604&JvmHeapSize=5120
generateHeapDumpPOSTGenerates Heap dump file..
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/generateHeapDump?apiKey=081c9ac51ba16ab061d5efee583dcd2f
GetThreadDumpGETFetches thread dump.
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/GetThreadDump?apiKey=83155f195334a19df5e58a8a33a6f804
GetSystemInformationGETObtains System information.
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/GetSystemInformation?apiKey=081c9ac51ba16ab061d5efee583dcd2f
GetRebrandDetailsGETFetches the rebrand details.
apiKey* - API Key to access your OpManager server.

alarmscount* - Alarms count.

rawdata* - Raw data (number of days).

hourlydata* - Hourly data (number of days).
http://localhost:8060/api/json/admin/GetRebrandDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&alarmscount=10000&rawdata=7&hourlydata=30
rebrandOpManagerGETRebrands the product.
apiKey* - API Key to access your OpManager server.

productName* - Rebranded product name.
http://localhost:8060/api/json/admin/rebrandOpManager?apiKey=6d36ff8426cff396b81b248e5c458604&productName=ServerMonitoringTool
regenerateAPIKeyGETRegenerates API Key
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/regenerateAPIKey?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getActualScheduleRateGETGets actual schedule rateapiKey* - API Key to access your OpManager server.

fromTime* - Data collection From time

ToTime* – Data collected To time.
http://localhost:8060/api/json/diagnostics/getActualScheduleRate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&fromTime=2013-12-21 00:01:15&toTime=2013-12-21 23:59:15
deleteDomainPOSTDeletes the domain name.
apiKey* - API Key to access your OpManager server.

domainName* - Name of the domain.
http://localhost:8060/api/json/admin/deleteDomain?apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainName=ZOHOCORP
Alarm Escalation
addAlarmEscalationRulesPOSTAdd Alarm Escalation rulesapiKey* - API Key to access your OpManager server.

rulename* - Alarm escalation rule name.

interval* - interval for escalation.

alarmlife* - period of alarm.

units* - quantity/count.

severity* - severity of escalation.

category* - alarm escalation category.

notificationType* - Type of notification eg., SMS or EMAIL.

ackStatus – acknowledgement status eg. diable. Will be enabled by default.

if notificationType=SMS,
number – number to which sms is to be sent.
smsMessage – SMS message.

if notificationType=EMAIL,
fromemailid – Email id from which the escalate notification being sent.
toemailid – Email id to whom the notification has to be sent.
subject – Subject of escalate notification.
message – Alarm escalation message.
http://localhost:8060/api/json/admin/addAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&category=Server&emailNotify=true&alarmlife=1&severity=1&message=test&interval=5&fromemailid=rejoe@testdomain.com&period=1&server=smtp&portNumber=25&smsNotify=false&rulename=test2&units=un&alarmLifeUnit=1&toemailid=rejoe@testdomain.com&selectedBV=test&subject=test
deleteAlarmEscalationRulesPOSTDeletes alarm escalation rules.apiKey* - api key.
rulename* - Alarm escalation rule names. (comma-separated)
http://localhost:8060/api/json/admin/deleteAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&rulename=test2
showEscalationRulesGETProvides all Alarm Escalation rules available.apiKey* - api key.http://localhost:8060/api/json/admin/showEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f
updateAlarmEscalationRulesPOSTUpdates the Alarm Escalation Rule.apiKey* - api key.
rulename* - Alarm escalation rule name.
interval* - interval for escalation.
alarmlife* - period of alarm.
units* - quantity/count.
severity* - severity of escalation.
category* - alarm escalation category.
notificationType* - Type of notification eg., SMS or EMAIL.

if notificationType=SMS,
number – number to which sms is to be sent.

smsMessage – SMS message.

if notificationType=EMAIL,
fromemailid Email id from which the escalate notification being sent.

toemailid – Email id to whom the notification has to be sent.

subject – Subject of escalate notification.

message – Alarm escalation message.
http://localhost:8060/api/json/admin/updateAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&category=Server&emailNotify=true&alarmlife=1&severity=1&message=test&interval=5&fromemailid=rejoe@testdomain.com&period=1&notificationType=Email&portNumber=25&smsNotify=false&rulename=test2&units=un&alarmLifeUnit=1&server=smtp&selectedBV=test20&toemailid=rejoe@testdomain.com&subject=test
viewAlarmEscalationRulesGETProvides information about the Alarm Escalation ruleapiKey* - API Key to access your OpManager server.

rulename* - Alarm escalation rule name.
http://localhost:8060/api/json/admin/viewAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f&rulename=test2
Alerts
acknowledgeAlarmPOSTAllows to acknowledge an alarm.apiKey* - API Key to access your OpManager server.

entity - Entity of the alarm.
http://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
addEventPOSTAdds an event.apiKey* - API Key to access your OpManager server.

source* - Name of the source device of the event.

severity* - The severity of the event. Following are the severity levels and its ID:
Critical - 1
Trouble - 2
Attention - 3
Service Down - 4

message* - The message that is displayed when the event is generated.

alarmCode - Unique string used to trigger the event. Eg:-Threshold-DOWN

entity - Uniquely identifies the failure object within the source.Events will be correlated into alarms according to the entity field. Multiple events with the same entity will be grouped as a single alarm.

eventType - Description of the event type
http://localhost:80/api/json/events/addEvent?apiKey=3d4d1f45e4c445eb52b9f1c51bc7c1ca&source=Cisco2081_router&severity=1&message=DownStatus&alarmCode=Threshold-DOWN&entity=Cisco2081_router
addNotesPOSTAdds notes to an alarm.apiKey* - API Key to access your OpManager server.

entity* -Entity of the alarm.

notes* – Text that has to be added as notes to the alarm.
http://localhost:8060/api/json/alarm/addNotes?apiKey=081c9ac51ba16ab061d5efee583dcd2f&notes=test&entity=222222222
alarmPropertiesGETProvides the details of an alarm eg: status, acknowledgementapiKey* - API Key to access your OpManager server.

entity* - Entity of the alarm.
http://localhost:8060/api/json/alarm/alarmProperties?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
clearAlarmPOSTClears an alarm.apiKey* - API Key to access your OpManager server.

entity* - Entity of the alarm.
http://localhost:8060/api/json/alarm/clearAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
deleteAlarmPOSTDeletes an alarm.apiKey* - API Key to access your OpManager server.

entity* - Entity of the alarm.
http://localhost:8060/api/json/alarm/deleteAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
getAnnotationGETProvides the notes available for an alarm.apiKey* - API Key to access your OpManager server.

entity* - Entity of the alarm.
http://localhost:8060/api/json/alarm/getAnnotation?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
getTopDevicesByAlarmsGETProvides the list of top devices by alarms count.apiKey* - API Key to access your OpManager server.

eventType* - Type of the Event eg. Trap or Eventlog Alarm
http://localhost:8060/api/json/alarm/getTopDevicesByAlarms?apiKey=081c9ac51ba16ab061d5efee583dcd2f&eventType=THRESHOLD-DOWN
getTopDevicesByEventsGETLists the top devices by events count.apiKey* - API Key to access your OpManager server.

eventType* - Type of the Event eg. Trap or Eventlog Alarm
http://localhost:8060/api/json/events/getTopDevicesByEvents?apiKey=081c9ac51ba16ab061d5efee583dcd2f&eventType=THRESHOLD-DOWN
listAlarmEscalationRulesGETLists all the alarm escalation rules created.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/listAlarmEscalationRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listAlarmsGETList all the alarms available.apiKey* - API Key to access your OpManager server.

deviceName - Name of the device whose alarms alone has to be filtered

severity - The severity of the alarm.
Following are the severity levels and its ID:
Critical - 1
Trouble - 2
Attention - 3
Service Down - 4

Category - The category to which the device belongs to. Eg. Router

fromTime - The beginning time for the filter. It should be in yyyy-mm-dd hh:mm:ss format.

toTime - The end time for the filter. It should also be in yyyy-mm-dd hh:mm:ss format.
http://localhost:8060/api/json/alarm/listAlarms?apiKey=081c9ac51ba16ab061d5efee583dcd2f&Category=Server&deviceName=opman-k8r2s-64-3..testdomain.com&severity=1&toTime=2014-02-12 23:59:00&fromTime=2014-02-12 00:01:01
listNotificationProfilesGETLists all the notification profiles created in OpManager.apiKey* - API Key to access your OpManager server.
profileFilter- All - For Global profiles and for other type of profiles(Send+Email, Send+SMS, Send+Modem+SMS,
Run+System+Command,etc..)
isGlobal- false - for Device Specific Profiles Filter.
http://localhost:8060/api/json/admin/listNotificationProfiles?apiKey=641dc197c94dcabb6af38c64352e5954&isFluidic=true&profileFilter=All
associateNotificationProfilesPOSTAssociate Notification Profiles
apiKey* - API Key to access your OpManager server.

profiles* - ProfileID of the profiles to be associated.

deviceName* - Name of the devices to be associated
 
http://localhost:80/api/json/admin/associateNotificationProfiles?apiKey=9c6f010cad72bc32abc984143cc5d505&profiles=301,302&deviceName=opman-k8r2s-64-3.testdomain.com,opman-k8r2s-64-4.testdomain.com
unAcknowledgeAlarmPOSTAllows to unacknowledge an alarm.apiKey* - API Key to access your OpManager server.

entity - Entity of the alarm.
http://localhost:8060/api/json/alarm/unAcknowledgeAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity= 222222222
alarmPropertiesGETObtains information of the given alarm
apiKey* - API Key to access your OpManager server.

entity* - Entity (alarm ID)
http://localhost:8060/api/json/alarm/alarmProperties?apiKey=081c9ac51ba16ab061d5efee583dcd2f&entity=222222222
getAlarmListGETLists all the alarms irrespective of the device/category
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/alarm/getAlarmList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listEventsGETLists all generated events
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/events/listEvents?apiKey=6d36ff8426cff396b81b248e5c458604
Device discovery
addDevicePOSTAdd a device.apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device to be added.

netmask - Enter the netmask for discovering the device.

credentialName - Enter the appropriate credential.

type - Type of the device. Eg. Windows 2008 R2.

displayName - Name of the device that has to be displayed in OpManager.
http://localhost:8060/api/json/discovery/addDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-2.testdomain.com&displayName=opman-k8r2s-64-2.testdomain.com&credentialName=win&netmask=255.255.255.0&type=Windows 2008 R2
addDeviceToGMapPOSTAdds devices to Google map.apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device to be added in business view.

latitude* - Latitude of the location where the device is present.

longitude* - Longitude of the location where the device is present.
http://localhost:8060/api/json/discovery/addDeviceToGMap?apiKey=081c9ac51ba16ab061d5efee583dcd2f&latitude=38.625453&deviceName=opman-k8r2s-64-3.testdomain.com&longitude=120.145568
addDomainPOSTAdds a domain in OpManager.apiKey* - API Key to access your OpManager server.

domainName - Name of the domain that has to be added.

domainController - Name of the domain controller.

autoLogin - Enable or Disable are the values that has to be entered. Enable - Allow the AD user to login into OpManager even if he/she does not have an account in OpManager. Disable - Does not allow the AD user to login into OpManager if he/she does not have an account in OpManager

loginType** - All users - Allows all users from the AD in that domain.
Selected Groups - Allows selected user groups from the AD in that domain

privilege - Operators - Allows the users in that domain to have Read Only permission to OpManager.
Administrators - Allows the users in that domain to have Full Access permission to OpManager.

readOnlyGroups - Allows the users in that group to have Read Only permission to OpManager.

fullControlGroups - Allows the users in that group to have Full Access permission to OpManager.
http://localhost:8060/api/json/admin/addDomain?apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainController=win2k8master.testdomain.com&autoLogin=true&loginType=All Users&domainName=testdomain
deleteDevicePOSTDeletes a device.apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device to be deleted.
http://localhost:8060/api/json/discovery/deleteDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com
deleteDomainPOSTDeletes a domain in OpManager.apiKey* - API Key to access your OpManager server.

domainName - Name of the domain that has to be deleted.
http://localhost:8060/api/json/admin/deleteDomain?apiKey=081c9ac51ba16ab061d5efee583dcd2f&domainName=ZOHOCORP
listCredentialsGETGives the list of credentials created in OpManager.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/listCredentials?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listDownTimeSchedulesGETGives the list of downtime schedules created.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/listDownTimeSchedules?apiKey=83155f195334a19df5e58a8a33a6f804
RediscoverDevicePOSTRediscovers a device
apiKey* - API Key to access your OpManager server.

name* - Name of the device.

snmpCredentialNames* - SNMP Credentials.
http://localhost:8060/api/json/device/RediscoverDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&snmpCredentialNames=Public&name=opman-k8r2s-64-3.testdomain.com
reDiscoverInterfacesPOSTRediscovers the interfaces
apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device.
http://localhost:8060/api/json/discovery/reDiscoverInterfaces?deviceName=opman-k8r2s-64-3.testdomain.com&apiKey=081c9ac51ba16ab061d5efee583dcd2f
doSearchGETSearch a device/interface
apiKey* - API Key to access your OpManager server.

type* - Type of the device (DEVICE,INTERFACE, etc).

searchString* - Search string (device name, interface name etc).
http://localhost:8060/api/json/discovery/doSearch?apiKey=081c9ac51ba16ab061d5efee583dcd2f&type=DEVICE,INTERFACE&searchString=opman-k8r2s-64-3.testdomain.com
searchDeviceGETAllows you to search for a device.apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device whose route has to be traced
http://localhost:8060/api/json/discovery/searchDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com
Device Snapshot
addNotesToDevicePOSTAdds notes to a device.apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device to be added

FIELD_NAMES - List of fields to be added to the device. Eg.: Department=IT
http://localhost:8060/api/json/device/addNotesToDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&Cabinet=cubicle
associateServiceMonitorPOSTAssociate Service monitors to the specified deviceapiKey* - API Key to access your OpManager server.

deviceName* - Name of the device for which the service to be associated. Give the names by comma separated for bulk association

serviceName* - Name of the service in comma-separated format.
http://localhost:8060/api/json/admin/associateServiceMonitor?deviceName=ctestlab-w2012.testdomain.com&apiKey=6d36ff8426cff396b81b248e5c458604&serviceName=WebLogic,Web,Telnet,SMTP
getAssociatedMonitorsGETProvides the list of monitors associated to a device.apiKey* - API Key to access your OpManager server.

name - name of the device.
http://localhost:8060/api/json/device/getAssociatedMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
getAssociatedServiceMonitorsGETProvides the service monitors associated with the specified deviceapiKey* - API Key to access your OpManager server.

name* - Name of the device.
http://localhost:8060/api/json/device/getAssociatedServiceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
getDeviceNotesGETProvides the details of notes such as floor no. and department name added to a device.apiKey* - API Key to access your OpManager server.

name* - name of the device.
http://localhost:8060/api/json/device/getDeviceNotes?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
getDeviceSummaryGETProvides the summary details of a device.apiKey* - API Key to access your OpManager server.

name* - name of the device.
http://localhost:8060/api/json/device/getDeviceSummary?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
getNotificationProfilesGETProvides the list of notification profiles associated to a device.apiKey* - API Key to access your OpManager server.

name* - name of the device.
http://localhost:8060/api/json/device/getNotificationProfiles?apiKey=83155f195334a19df5e58a8a33a6f804&name=opman-k8r2s-64-3.testdomain.com
getWorkFlowsGETProvides the list of workflows associated to a device.apiKey* - API Key to access your OpManager server.

name* - name of the device.
http://localhost:8060/api/json/device/getWorkFlows?apiKey=83155f195334a19df5e58a8a33a6f804&name=opman-k8r2s-64-3.testdomain.com
getAssociatedCredentialsGETObtains information on the credentials associated to a device
apiKey* - API Key to access your OpManager server.

name* – Name of the device whose credentials need to be fetched.
http://localhost:8060/api/json/device/getAssociatedCredentials?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
getPerfomanceMonitorDetailsGETObtains information of the performance monitors for a device
apiKey* - API Key to access your OpManager server.

policyName* - Name of the performance monitor.

graphName* - Graph name of the performance monitor.

name* - Name of the device.

checkNumeric* - true or false.
http://localhost:8060/api/json/device/getPerfomanceMonitorDetails?apiKey=6d36ff8426cff396b81b248e5c458604&policyName=WMI-CPUUtilization&graphName=WMI-CPUUtilization&name=172.18.100.130&checkNumeric=true
EditPerfomanceMonitorPOSTEnables editing the configuration of a performance monitor
TroubleThresholdType* - Type of threshold.

TroubleThresholdValue* - Trouble threshold value.

RearmValue* - Trouble threshold rearm value.

Interval – monitoring Interval in mins.

TimeAvg – Average time.

ThresholdEnabled – true or false.

GraphName – Name of the performance monitor graph.

WarningThresholdValue – Warning threshold value.

Type – threshold type.

OidType – OID Type.

TroubleMessage – Message to be populated on violating threshold.

TroubleThresholdTextValue – Trouble threshold value.

TroubleThresholdTextualType – Trouble threshold textual type (equals, contains etc)

Oid – OID of the performance monitor.

SendClear – True or false.

ClrMessage – Message to be displayed when the threshold is cleared.

Name – Device name.

CriticalThresholdTextValue – Critical threshold text value.

CriticalMessage – Message to be displayed on violating critical threshold.

CriticalThresholdType – Type of critical threshold (max, min)

RearmTextValue – Rearm value of critical threshold.

CriticalThresholdValue – Threshold value of the critical alarm.

WarningMessage – Warning message.

YaxisText – Text representing the values in y-axis.

WarningThresholdTextualType – warning threshold text type.

FailureThreshold – Failure threshold value.

Vendor – Vendor of the device.

CriticalThresholdTextualType – Critical threshold textual type.

ThresholdName – name of the threshold.

WarningThresholdType – Type of the warning threshold.

CheckNumeric – True or False.

FirstTime – True or False.

PolicyName – Name of the performance monitor.

InstanceName – Name of the monitor instance.

RearmTextualType – Rearm Textual type.

ClearThresholdType – Clear threshold type.

DisplayName – Displayname of the performance monitor.

WarningThresholdTextValue – Warning threshold text value.
http://localhost:8060/api/json/device/EditPerfomanceMonitor?troubleThresholdType=max&troubleThresholdValue=25&rearmValue=23&interval=5&timeAvg=&thresholdEnabled=true&graphName=WMI-CPUUtilization&warningThresholdValue=&type=multiple&oidType=&apiKey=6d36ff8426cff396b81b248e5c458604&troubleMessage=$MONITOR is $CURRENTVALUE%, threshold value for this monitor is $THRESHOLDVALUE%&troubleThresholdTextValue=25&troubleThresholdTextualType=Contains&oid=CPU Utilization&sendClear=true&clrMessage=$MONITOR is now back to normal, current value is $CURRENTVALUE%&name=172.18.100.130&criticalThresholdTextValue=&criticalMessage=$MONITOR is $CURRENTVALUE%, threshold value for this monitor is $THRESHOLDVALUE%&criticalThresholdType=max&rearmTextValue=23&criticalThresholdValue=&warningMessage=$MONITOR is $CURRENTVALUE%, threshold value for this monitor is $THRESHOLDVALUE%&yaxisText=Percentage&warningThresholdTextualType=Contains&failureThreshold=1&vendor=&criticalThresholdTextualType=Contains&thresholdName=&warningThresholdType=max&checkNumeric=true&firstTime=false&policyName=WMI-CPUUtilization&instanceName=&rearmTextualType=Not Contains&clearThresholdType=min&displayName=CPU Utilization&warningThresholdTextValue=
addPerfomanceMonitorsPOSTAdds a new performance monitor for the given device
apiKey* - API Key to access your OpManager server.

name* - Name of the device.

selectedMonitors* - Name of the performance monitors.
 
http://localhost:8060/api/json/device/addPerfomanceMonitors?apiKey=6d36ff8426cff396b81b248e5c458604&name=172.18.100.130&selectedMonitors=693,692,203,204,205,304
getPerformanceMonitorsGETLists the performance monitors for the given device
apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device.

category* - Name of the performance monitors.

type* - Type of the device
http://localhost:8060/api/json/device/getPerformanceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&category=Server&deviceName=opman-k8r2s-64-3.testdomain.com&type=Windows 2008 R2
UpdateAdditionalFieldsPOSTUpdates the additional fields present in the device snapshot page
apiKey* - API Key to access your OpManager server.

firstTime* - true or false.

interfacename* - Name of the interface.

type* - Type of the device.

UDF1* - Field value.

UDF2 – Filed value.

UDF3 – Field value.

UDF4 – Field value.

UDF5 – Field value.
 
http://localhost:8060/api/json/device/UpdateAdditionalFields?UDF1=qq22&UDF2=&firstTime=true&UDF5=&UDF3=&UDF4=&interfacename=IF-192.168.50.130-399&type=Interface&apiKey=6d36ff8426cff396b81b248e5c458604
UpdateDeviceDetailsPOSTUpdates device details
apiKey* - API Key to access your OpManager server.

vendor* - Vendor of the device.

name* - Device name.

monitoring* - Monitoring interval.

netmask* - Netmask address.

displayName* - Displayname of the device.

ipAddress* - Device IP address.
http://localhost:8060/api/json/device/UpdateDeviceDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&vendor=Microsoft&name=opman-k8r2s-64-2.testdomain.com&Monitoring=60&Netmask=25.255.255.0&displayName=TEST11&ipAddress=172.18.155.78
GetCredentialsForDeviceGETObtains the credentials mapped to a device
apiKey* - API Key to access your OpManager server.

name* - Name of the device.
http://localhost:8060/api/json/device/GetCredentialsForDevice?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
GetMonitoringIntervalGETObtains the configured monitoring interval
apiKey* - API Key to access your OpManager server.

name* - Name of the device.
http://localhost:8060/api/json/device/GetMonitoringInterval?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
ConfigureMonitoringIntervalPOSTEnables configuration of the monitoring interval
apiKey* - API Key to access your OpManager server.

pollenabled* - on or off.

protocol* - protocol of the device.

name* - Device name.

interval* - Monitoring interval.
 
http://localhost:8060/api/json/device/ConfigureMonitoringInterval?apiKey=081c9ac51ba16ab061d5efee583dcd2f&pollenabled=on&protocol=SNMP&name=opman-k8r2s-64-3.testdomain.com&interval=15
GetSuppressAlarmDetailsGETObtains the suppress alarm details of a device
apiKey* - API Key to access your OpManager server.

name* - Name of the device.
http://localhost:8060/api/json/device/GetSuppressAlarmDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
ConfigureSuppressAlarmPOSTConfigures suppress alarm for a device
apiKey* - API Key to access your OpManager server.

name* - Name of the device.

suppressInterval* - Alarm suppress interval.
http://localhost:8060/api/json/device/ConfigureSuppressAlarm?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com&suppressInterval=3600000
setManagedPOSTEnables the device to be in managed state
apiKey* - API Key to access your OpManager server.

name* - Name of the device.

manage* - Set device in managed statue (true or false).
http://localhost:8060/api/json/device/setManaged?apiKey=081c9ac51ba16ab061d5efee583dcd2f&manage=false&name=opman-k8r2s-64-3.testdomain.com
deletePerfomanceMonitorsPOSTDeletes the performance monitor from the given device
apiKey* - API Key to access your OpManager server.

name* – Name of the device whose credentials need to be fetched.

policyName* - Name of the performance monitor.
http://localhost:8060/api/json/device/deletePerfomanceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&policyName=Win-CPUUtilization&name=opman-k8r2s-64-2.testdomain.com
getInterfaceGraphsGETShow graph values for a interface
apiKey* - API Key to access your OpManager server.

interfaceName* - Name of the interface.

graphName* - Graph name of the performance monitor.
http://localhost:8060/api/json/device/getInterfaceGraphs?interfaceName=IF-192.168.49.106-329&graphName=rxutilization&apiKey=6d36ff8426cff396b81b248e5c458604
fetchMonitorsListPOSTFetches all configured monitors of a device
apiKey* - API Key to access your OpManager server.

username* - Username.

category* - Device category.

deviceList* - List of devices.
http://localhost:8060/api/json/device/fetchMonitorsList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&username=admin&category=Server&deviceList=opman-k8r2s-64-3.testdomain.com
getInterfaceUtilizationGETGet utilization of the given interfaces
apiKey* - API Key to access your OpManager server.

period* - Period for which graph is required. (fourhours, twohours etc)

interfaceList* - List of interfaces.
http://localhost:8060/api/json/device/getInterfaceUtilization?interfaceList=IF-192.168.49.106-335,IF-192.168.49.101-497,IF-192.168.50.7-343,IF-192.168.50.7-338,IF-192.168.50.7-339,IF-192.168.49.101-503,IF-192.168.49.101-504,IF-192.168.49.101-495,IF-192.168.49.101-490,IF-192.168.49.101-494,IF-192.168.49.101-513,IF-192.168.49.101-502,IF-192.168.49.101-512,IF-192.168.49.101-492,IF-192.168.49.101-505,IF-192.168.49.101-498,IF-192.168.49.101-514,IF-cisco2081.testdomain.com-672,IF-192.168.50.7-337,IF-cisco2081.testdomain.com-563,IF-cisco2081.testdomain.com-667,IF-cisco2081.testdomain.com-670,IF-192.168.49.101-549,IF-192.168.49.101-547,IF-192.168.49.101-556,IF-192.168.49.101-558,IF-192.168.49.101-516,IF-192.168.49.101-511,IF-192.168.49.101-520,IF-192.168.49.101-519,IF-192.168.49.101-496,IF-192.168.49.106-330,IF-192.168.49.101-552,IF-192.168.49.101-515,IF-192.168.49.101-550,IF-cisco2081.testdomain.com-995,IF-192.168.49.106-331,IF-192.168.49.146-324,IF-192.168.49.146-322,IF-192.168.49.146-323,IF-192.168.49.106-329&period=twfourhours&apiKey=6d36ff8426cff396b81b248e5c458604
getGraphDataGETFetches graph value for the given monitors
apiKey* - API Key to access your OpManager server.

index* - Name of the performance monitor.

name* - Name of the device.

policyName* - Name of the performance monitor.
http://localhost:8060/api/json/device/getGraphData?index=WMI-CPUUtilization&policyName=WMI-CPUUtilization&name=172.18.99.60&apiKey=6d36ff8426cff396b81b248e5c458604
getGraphNamesGETObtains the name of all available graphs for the given device
apiKey* - API Key to access your OpManager server.

name* - Name of the device.
http://localhost:8060/api/json/device/getGraphNames?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
associateServiceMonitorPOSTAssociate service monitor to the device.
apiKey* - API Key to access your OpManager server.

deviceName* - Type of the device.

serviceName* - Name of the service monitors.
http://localhost:8060/api/json/admin/associateServiceMonitor?apiKey=6d36ff8426cff396b81b248e5c458604&deviceName=msp-k8r2e-64-1.testdomain.com&serviceName=SMTP(25),Web(80),DNS(53),LDAP(389),WebLogic(7001),Telnet(23)
getIPMIDetailsGETGets IPMI details for the specified deviceapiKey* - API Key to access your OpManager server.

deviceName* - Name of the device
http://localhost:8060/api/json/discovery/getIPMIDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=test
updateIPMIDetailsPOSTAllows you to update IPMI details of a deviceapiKey* - API Key to access your OpManager server.

deviceName* - Name of the device

ipmiIP* - IPMI IP address
http://localhost:8060/api/json/discovery/updateIPMIDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=test&ipmiIP=10.10.10.10
Interface discovery
discoverInterfacePOSTDiscovers an interface.apiKey* - API Key to access your OpManager server.

devicesList* - DeviceNames(moname) as comma separated

intftypes* - Intf types as numeric numbers(E.g: Ethernet=6)

adminStates* - Interface AdminStatus as numeric numbers(UP=1, DOWN=2)

operStates* - Interface OperStatus as numeric numbers(UP=1, DOWN=2)
http://localhost:8060/api/json/discovery/discoverInterface?apiKey=081c9ac51ba16ab061d5efee583dcd2f&adminStates=1&operStates=1&devicesList=opman-k8r2s-64-3.testdomain.com
getInterfacesGETProvides the list of interfaces in a device.apiKey* - API Key to access your OpManager server.

name* - name of the device.
http://localhost:8060/api/json/device/getInterfaces?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
getInterfaceSummaryGETProvides the summary details of an interface.apiKey* - API Key to access your OpManager server.

interfaceName - name of the interface
http://localhost:8060/api/json/device/getInterfaceSummary?apiKey=83155f195334a19df5e58a8a33a6f804&interfaceName=IF-opman-k8r2s-64-3.testdomain.com-4505
Inventory
getInterfaceTypesGETProvides the type of interface. eg: serial, ethernet.
apiKey* - API Key to access your OpManager server.
 
http://localhost:8060/api/json/device/getInterfaceTypes?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getProbeURLGETProvides the URL of the probe.apiKey* - API Key to access your OpManager server.

name - name of the device.
http://localhost/api/json/device/addNotesToDevice?apiKey=ac130763a309fcb1613e0b8a551950a2&name=localhost.testdomain.com
listVirtualDevicesGETLists all the available virtual devices
apiKey* - API Key to access your OpManager server.

virtualDeviceType* - Type of the virtual device.

 
http://localhost:8060/api/json/device/listVirtualDevices?virtualDeviceType=VM&apiKey=1d626117b2ac31145ce6bca49bb0458b
fetchInterfacesListGETFetches all interfaces of the given device and category
apiKey* - API Key to access your OpManager server.

username* – username.

category* – Device category.

deviceList* – Device name.
 
http://localhost:8060/api/json/device/fetchInterfacesList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&username=admin&category=Server&deviceList=opman-k8r2s-64-3.testdomain.com
fetchDevicesListGETFetches all devices available in the given category
apiKey* - API Key to access your OpManager server.

username* – username.

category* – Device category.
http://localhost:8060/api/json/device/fetchDevicesList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&username=admin&category=Server
listDevicesGETLists all the devices added in OpManager.apiKey* - API Key to access your OpManager server.

deviceName - Name of the device that has to be filtered

type - The device type which has to be filtered. Eg.Windows 7

Category - The category to which the device belongs to. Eg. Router
http://localhost:8060/api/json/device/listDevices?apiKey=081c9ac51ba16ab061d5efee583dcd2f&Category=Server&deviceName=opman-k8r2s-64-3.testdomain.com&type=Windows 2008 R2
listInterfacesGETLists all the interfaces in OpManager.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/device/listInterfaces?apiKey=83155f195334a19df5e58a8a33a6f804
getDevicePackageListGETLists device package
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/device/getDevicePackageList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getCategoryListGETLists all the available device categories
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/device/getCategoryList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getVendorListGETLists all the vendors
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/device/getVendorList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
Layer2 discovery
addLayer2MapPOSTAdds a Layer2 devices MapapiKey* - API Key to access your OpManager server.

mapName* - Name of the Map

seedDevice* - Seed Router Or L3 Switch Address

startAddr* - Start IpAddress of the network

endAddr* - End IpAddress of the network

subnetMask* - Subnet Mask for the network

credentialName* - Array of credentials existing in Opmanager in comma separated format

scheduleInterval* - Scheduling Interval (Number Of Days) default 5 days

discoverNow* - true/false. if true, Add the Layer2 Configuration and discover it. If false, add only the Layer2 Configuration and discover after the schedule period.
http://localhost:8060/api/json/discovery/addLayer2Map?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=Public&seedDevice=192.168.49.1&startAddr=192.168.49.1&mapName=Testmap&endAddr=192.168.50.130&discoverNow=true&scheduleInterval=5
deleteLayer2MapPOSTAllows to delete Layer2 map.apiKey* - API Key to access your OpManager server.

mapName* - Name Of the Map to be deleted
http://localhost:8060/api/json/discovery/deleteLayer2Map?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mapName=Testmap
discoverLayer2DevicesPOSTDiscovers Layer2 devicesapiKey* - API Key to access your OpManager server.

deviceNames* - Array Of Devices in comma-separated format
http://localhost/api/json/discovery/discoverLayer2Devices?apiKey=ac130763a309fcb1613e0b8a551950a2&deviceNames=192.168.49.1,192.168.50.130
discoverLayer2MapPOSTDiscovers Layer2 MapapiKey* - API Key to access your OpManager server.

mapName* - Name Of the Map to be discovered/updated
http://localhost:8060/api/json/discovery/discoverLayer2Map?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mapName=TestMap
getDiscoveredLayer2MapGETAllows you to view the discovered Layer2 MapapiKey* - API Key to access your OpManager server.

mapName* - Name Of the Map to be shown
http://localhost:8060/api/json/discovery/getDiscoveredLayer2Map?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mapName=TestMap
getLayer2ScanDetailsGETObtains information regarding the Layer 2 scans ran up-to-date
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/maps/getLayer2ScanDetails?apiKey=5022357be4231edff71ed25cf960457a
getLayer2MapsGETLists all the Layer2 Maps available in OpmanagerapiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/maps/getLayer2Maps?apiKey=081c9ac51ba16ab061d5efee583dcd2f
Mail Server Settings
GetMailServerSettingsGETProvides the details of mail server settings.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/GetMailServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getMailVariablesGETGet send mail parameters
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/admin/getMailVariables?apiKey=081c9ac51ba16ab061d5efee583dcd2f
Maps
addBusinessViewPOSTAdds a new business view.apiKey* - API Key to access your OpManager server.

bvName* - Name of the Business View.
http://localhost:8060/api/json/discovery/addBusinessView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&bvName=test
addDeviceToBVPOSTAdds devices to a Business View that is already created.apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device to be added in business view. Enter multiple device names separated by a comma.

bvName* - Name of the business view.
http://localhost:8060/api/json/discovery/addDeviceToBV?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&bvName=test
getBusinessDetailsViewGETLists all the devices available in a business view.apiKey* - API Key to access your OpManager server.

bvName* - Name of the business view.

viewLength - Length of the data. If not provided, default length 250 will be used.

startPoint - data from startPoint Example 1 means, fetch data from 1 - optional parameter
http://localhost:8060/api/json/businessview/getBusinessDetailsView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&viewLength=250&startPoint=1&bvName=test
getBusinessViewGETLists all the business views created.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/businessview/getBusinessView?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getFloorDetailsGETProvides the details of floor. eg, floor size, tile size.apiKey* - API Key to access your OpManager server.

floorId* - Floor ID obtained from listFloors
http://localhost:8060/api/json/maps/getFloorDetails?apiKey=83155f195334a19df5e58a8a33a6f804&floorId=1
getInfrastructureViewGETProvides the details of a particular infrastructure type. eg.: servers.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/discovery/getInfrastructureView?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listFloorsGETLists all the floors created.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/maps/listFloors?apiKey=1d626117b2ac31145ce6bca49bb0458b
listRacksGETLists all the racks created.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/maps/listRacks?apiKey=83155f195334a19df5e58a8a33a6f804
getUsersAssociatedToBVGETDisplays all the users associated to the given business view
apiKey* - API Key to access your OpManager server.

BvName* - Business view name.
http://localhost:8060/api/json/businessview/getUsersAssociatedToBV?apiKey=83155f195334a19df5e58a8a33a6f804&bvName=test
getBVDetailsGETFetches information of the given BusinessView
apiKey* - API Key to access your OpManager server.

BvName* - Business view name.

viewId* - Business view Id.
http://localhost:8060/api/json/businessview/getBVDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&viewId=1&bvName=test
Monitoring
deleteDownTimeSchedulesPOSTDeletes a particular downtime scheduler.apiKey* - API Key to access your OpManager server.

scheduleId* – ID of the schedule
http://localhost:8060/api/json/admin/deleteDownTimeSchedules?apiKey=83155f195334a19df5e58a8a33a6f804&scheduleId=1
addDowntimeSchedulePOSTUsed to add a new downtime schedule.apiKey* - API Key to access your OpManager server.

operation* - Add operation for adding a schedule (Add)
scheduleName* - name of the downtime scheduler
status* - status of the schedule (enabled by default)
scheduleDesc - Description about the downtime schedule
recurrence* - Downtime frequency (OnceOnly | Daily | Weekly | Monthly)
selectDevicesMethod* - filter by option (Category | BV | Device | URL | GROUP)


(Only one param will be sent from below 5 params based on the selected filter)

selectedCateg - selected category
selectedDevices - selected devices
selectedBV - selected Business view
selectedURL - selected URLs
selectedLogicalGroup - selected logical group

(Below two params will be used only for onceOnly downtime frequency)

once_startat - yyyy-mm-dd hh:mm (year-month-date hour:min)
once_endat - yyyy-mm-dd hh:mm (year-month-date hour:min)

(Below three params will be used only for Daily downtime frequency)

from_time - hh:mm (hour:min)
to_time - hh:mm (hour:min)
daily_effectfrom - yyyy-mm-dd (year-month-date)

(Below four params will be used only for Weekly downtime frequency)

startday - (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
endday - (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
from_time - hh:mm (hour:min)
to_time - hh:mm (hour:min)

(Below param will be used only for Monthly downtime frequency)

monthlyType - (monthlyDate|monthlyDay)

(Below params will be used for monthly date wise frequency)

startday -month date (32 for last date of every month)
endday - month date (32 for last date of every month)
from_mins - minutes 00 to 59
to_mins - minutes 00 to 59
from_hrs - hours 00 to 23
to_hrs - hours 00 to 23

(Below params will be used for monthly day wise frequency)

weekOfMonth - week of the month (monthlyDate | monthlyDay)
weekday - day (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
from_mins - minutes 00 to 59
to_mins - minutes 00 to 59
from_hrs - hours 00 to 23
to_hrs - hours 00 to 23
http://localhost/api/json/admin/addDowntimeSchedule?operation=Add&apiKey=83155f195334a19df5e58a8a33a6f804
updateDowntimeSchedulePOSTUsed to update a downtime schedule.apiKey* - API Key to access your OpManager server.

operation* - Edit operation for editing a schedule (Edit)
MS_INSTANCEID* - Downtime scheduler id
scheduleId* - Downtime scheduler id
scheduleName* - name of the downtime scheduler
status* - status of the schedule (enabled by default)
scheduleDesc* - Description about the downtime schedule
recurrence* - Downtime frequency (OnceOnly|Daily|Weekly|Monthly)
selectDevicesMethod* - filter by option (Category|BV|Device|URL|GROUP)


(Only one param will be sent from below 5 params based on the selected filter)

selectedCateg - selected category
selectedDevices - selected devices
selectedBV - selected Business view
selectedURL - selected URLs
selectedLogicalGroup - selected logical group

(Below two params will be used only for onceOnly downtime frequency)

once_startat - yyyy-mm-dd hh:mm (year-month-date hour:min)
once_endat - yyyy-mm-dd hh:mm (year-month-date hour:min)

(Below three params will be used only for Daily downtime frequency)

from_time - hh:mm (hour:min)
to_time - hh:mm (hour:min)
daily_effectfrom - yyyy-mm-dd (year-month-date)

(Below four params will be used only for Weekly downtime frequency)

startday - (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
endday - (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
from_time - hh:mm (hour:min)
to_time - hh:mm (hour:min)

(Below param will be used only for Monthly downtime frequency)

monthlyType - (monthlyDate | monthlyDay)

(Below params will be used for monthly date wise frequency)

startday -month date (32 for last date of every month)
endday - month date (32 for last date of every month)
from_mins - minutes 00 to 59
to_mins - minutes 00 to 59
from_hrs - hours 00 to 23
to_hrs - hours 00 to 23

(Below params will be used for monthly day wise frequency)

weekOfMonth - week of the month (monthlyDate | monthlyDay)
weekday - day (Sunday | Monday | Tuesday | Wednesday | Thursday | Friday | Saturday)
from_mins - minutes 00 to 59
to_mins - minutes 00 to 59
from_hrs - hours 00 to 23
to_hrs - hours 00 to 23
http://localhost/api/json/admin/updateDowntimeSchedule?operation=Edit&MS_INSTANCEID=14&scheduleId=14&apiKey=83155f195334a19df5e58a8a33a6f804
getDownTimeScheduleGETUsed to fetch details about a particular downtime scheduleapiKey* - API Key to access your OpManager server.

scheduleName* - Name of the downtime scheduler
http://localhost/api/json/admin/getDowntimeSchedule?scheduleName=test&apiKey=83155f195334a19df5e58a8a33a6f804
getAllVoipMetricsGETLists all the VoIP monitors created.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/discovery/getAllVoipMetrics?apiKey=83155f195334a19df5e58a8a33a6f804
getAllWanMetricsGETLists all the WAN monitors created.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/discovery/getAllWanMetrics?apiKey=83155f195334a19df5e58a8a33a6f804
getAvailabiltyGraphDataGETProvides the data used to calculate the availability graph.

apiKey* - API Key to access your OpManager server.

period* - period for which availability graph is required.

 

Parameters:

LAST_12_HOURS 
LAST_24_HOURS
TODAY
YESTERDAY
LAST_7_DAYS
LAST_30_DAYS
THIS_WEEK
LAST_WEEK
THIS_MONTH
LAST_MONTH


deviceName* - name of the device OR elementID* - MOID of the Interface.

http://localhost:8060/api/json/device/getAvailabiltyGraphData?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com&period=LAST_12_HOURS
getDownDevicesGETProvides the details of devices that are down.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/discovery/getDownDevices?apiKey=83155f195334a19df5e58a8a33a6f804
getInterfaceMonitorsGETProvides the list of monitors associated to an interface.apiKey* - API Key to access your OpManager server.

interfaceName - name of the interface.
http://localhost:8060/api/json/device/getInterfaceMonitors?apiKey=83155f195334a19df5e58a8a33a6f804&interfaceName=IF-opman-k8r2s-64-3.testdomain.com-4505
getInterfaceNotesGETProvides the details of the notes added to an interface.apiKey* - API Key to access your OpManager server.

interfaceName - name of the interface
http://localhost:8060/api/json/device/getInterfaceNotes?apiKey=83155f195334a19df5e58a8a33a6f804&interfaceName=IF-opman-k8r2s-64-3.testdomain.com-4505
getPingResponseGETPings a device and provides the response.apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device which has to be pinged.
http://localhost:8060/api/json/device/getPingResponse?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com
getPollsPerSecGETProvides the current polls per second value of OpManager.apiKey* - API Key to access your OpManager server.

graphType* – Type of graph required ie. Pollpersec.

fromTime* – date string in the format: yyyy-MM-dd HH:mm:ss

toTime* - date string in the format: yyyy-MM-dd HH:mm:ss
http://localhost:8060/api/json/diagnostics/getPollsPerSec?apiKey=081c9ac51ba16ab061d5efee583dcd2f&fromTime=2013-12-21 00:01:15&graphType=Pollpersec&toTime=2013-12-21 23:59:15
getTraceResponseGETAllows you to get the traceroute to a device.apiKey* - API Key to access your OpManager server.

deviceName* - Name of the device which has to be pinged.
http://localhost:8060/api/json/device/getTraceResponse?apiKey=081c9ac51ba16ab061d5efee583dcd2f&deviceName=opman-k8r2s-64-3.testdomain.com
listPerformanceMonitorsGETLists all the performance monitors added.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/listPerformanceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listScriptMonitorsGETLists all the script monitors created.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/listScriptMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listSysLogRulesGETLists all the syslog rules created.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/listSysLogRules?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listTrapProcessorsGETLists all the trap processor created.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/listTrapProcessors?apiKey=081c9ac51ba16ab061d5efee583dcd2f
listURLMonitorsGETLists all the URL monitors created.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/listURLMonitors?apiKey=5070623c57db770f93ca914dc7b598f8
listStatusPollDetailsGETList status poll details of particular interface type.
apiKey* - API Key to access your OpManager server.

typeName* - Type of the device/interface
http://localhost:8060/api/json/admin/listStatusPollDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeName=Ethernet
TestMonitorGETTest Monitor actionapiKey* - API Key to access your OpManager server.

name* - Name of the device.

policyName* - Policy name of the monitor.

graphName - Graph name.

instanceName – Instance name.
http://localhost:8060/api/json/device/TestMonitor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&policyName=Win-CPUUtilization&graphName=Win-CPUUtilization&name=opman-k8r2s-64-3.testdomain.com
updateDeviceStatusGETPings the device and updates the correct status of a device.apiKey* - API Key to access your OpManager server.

name* - name of the device.
http://localhost:8060/api/json/device/updateDeviceStatus?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
Proxy Server Settings
GetProxyServerSettingsGETProvides the details of proxy server settings.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/GetProxyServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f
SMS Server Settings
configureSMSServerSettingsPOSTAllows to configure the SMS server settings.apiKey* - API Key to access your OpManager server.

portno* - <Name of the Port(eg. COM1).

mobileno* - Mobile number from which the SMS to be sent
http://localhost:8060/api/json/admin/configureSMSServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f&mobileno=9840833757&portno=COM21
GetSMSServerSettingsGETProvides the details of SMS server settings.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/GetSMSServerSettings?apiKey=081c9ac51ba16ab061d5efee583dcd2f
SysLogs
deleteSysLogForwarderPOSTDelete SysLog ForwarderapiKey* - API Key to access your OpManager server.

destHost* - Destination Host.

destPort* - Destination Port.
http://localhost:8060/api/json/admin/deleteSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-2&destPort=516
deleteSysLogRulePOSTDelete SysLog RuleapiKey* - API Key to access your OpManager server.

ruleName* - Name of the rule
http://localhost:8060/api/json/admin/deleteSysLogRule?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ruleName=test11
getSysLogAlertSeverityMapGETList SysLog AlertSeverityMapapiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/getSysLogAlertSeverityMap?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getSysLogFacilityMapGETList SysLog FacilitiesMapapiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/getSysLogFacilityMap?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getSysLogForwardersGETList SysLog ForwardersapiKey* - API Key to access your OpManager server.

ruleName* - Sys Log Rule Name.
http://localhost:8060/api/json/admin/getSysLogForwarders?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getSysLogPortGETGet SysLog PortsapiKey* - API Key to access your OpManager server.

portNumber*- port Numbers(comma separated)
http://localhost:8060/api/json/admin/getSysLogPort?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getSysLogRuleContentGETSysLog Rule InfoapiKey* - API Key to access your OpManager server.

ruleName* - Sys Log Rule Name
http://localhost:8060/api/json/admin/getSysLogRuleContent?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ruleName=Failed logins
getSysLogSeverityMapGETList SysLog SeverityMapapiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/getSysLogSeverityMap?apiKey=081c9ac51ba16ab061d5efee583dcd2f
isSysLogRuleExistsGETIs SysLog Rule ExistsapiKey* - API Key to access your OpManager server.

ruleName* - Sys Log Rule Name.
http://localhost:8060/api/json/admin/isSysLogRuleExists?apiKey=081c9ac51ba16ab061d5efee583dcd2f&ruleName=Failed logins
startSysLogForwarderPOSTStart SysLog ForwarderapiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/startSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f
stopSysLogForwarderPOSTStop SysLog ForwarderapiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/stopSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f
updateSysLogForwarderPOSTUpdate SysLog ForwarderapiKey* - API Key to access your OpManager server.

destHost* - Previous Destination Host.

destPort* - Previous Destination Port.

newDestHost* - New Destination Host.

newDestPort* - New Destination Port.
http://localhost:8060/api/json/admin/updateSysLogForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&newDestPort=516&destHost=opman-k8r2s-64-3&destPort=515&newDestHost=opman-k8r2s-64-2
updateSysLogRulePOSTUpdate SysLog RuleapiKey* - API Key to access your OpManager server.

ruleName* - Name of the rule

facilityName - SysLog Facility

severityList - SysLog Severity(Comma Separated)

alertSeverity - OpManager Alert Severity

alarmMessage - OpManager Alert Message

matchString - String matched with incoming syslog message

consecutiveTime - consecutive time

timeInterval - time interval
(if rearmFacilityName is selected then rearmSeverityList should be selected)

rearmFacilityName - facility name for rearm syslog

rearmSeverityList : severity list for rearm syslog

rearmMatchString : String matched with incoming syslog for rearm
http://localhost:8060/api/json/admin/updateSysLogRule?apiKey=081c9ac51ba16ab061d5efee583dcd2f&description=auth alert rule&alertSeverity=2&matchString=matchstring&facilityName=auth&ruleName=test11&alarmMessage=test&severityList=alert
Templates
addVendorPOSTAdd new vendor name.apiKey* - api key.

vendor* - Vendor name of the device.
http://localhost:8060/api/json/admin/addVendor?apiKey=081c9ac51ba16ab061d5efee583dcd2f&vendor=testvendor3
associateDeviceTemplatePOSTAssociate templates to the device.apiKey* - API key.

selectedDevices* - device name (comma-separated).

typeName* - Device type.
http://localhost:8060/api/json/admin/associateDeviceTemplate?apiKey=1d626117b2ac31145ce6bca49bb0458b&typeName=Windows 2008 R2&selectedDevices=opman-k8r2s-64-2.testdomain.com
deleteDeviceTemplatePOSTEnables deletion of Device Templates.apiKey* - API Key to access your OpManager server.

typeName* - Template type name.
http://localhost:8060/api/json/admin/deleteDeviceTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeName=3com 3500G-EI
deleteSysoidPOSTEnables deletion of SysOIDapiKey* - API Key to access your OpManager server.

typeName* - Template type name.
http://localhost:8060/api/json/admin/deleteSysoid?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeName=3com 3500G-EI
editInterfaceTemplatesPOSTEdit Interface TemplateapiKey* - API Key to access your OpManager server.

typeName* - Template type name.

intfEnabled* - on or off.

statusPoll* - on.

enableIntfUtilTemplate – on or off.

enableIntfErrorTemplate – on or off.

enableIntfDiscTemplate – on or off.

If enableIntfUtilTemplate is on,
pollInterval* – Polling interval (integer).

failureThreshold* – Threshold failure value (integer).

statusPollFT* – Status polling (integer).

if enableIntfErrorTemplate is on,
utilThreshold* – threshold value (integer).

utilRearm* – threshold rearm value (integer).

utilCondition* – threshold condition (integer).

if enableIntfDiscTemplate is on,
errorThreshold* - error threshold value (integer).

errorRearm* - error Rearm value (integer).

errorCondition* - error condition value (integer)
http://localhost:8060/api/json/admin/editInterfaceTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f&intfEnabled=on&utilRearm=89&discCondition=>&errorRearm=89&discThreshold=90&statusPollFT=2&typeName=Ethernet&statusPoll=on&utilCondition=>&discRearm=89&utilThreshold=90&enableIntfDiscTemplate=on&errorThreshold=90&errorCondition=>&pollInterval=900&enableIntfErrorTemplate=on&enableIntfUtilTemplate=on&failureThreshold=9
listDeviceTemplatesGETLists all the device templates created in OpManager.apiKey* - API Key to access your OpManager server.

rows - Number of records per page (default is 100)

page - Current page count
http://localhost:8060/api/json/admin/listDeviceTemplates?apiKey=081c9ac51bad5efee583dcd2f&rows=100&page=1&sortByColumn=totaldevices&sortByType=desc
GETLists all the custom device templates created in OpManager.apiKey* - API Key to access your OpManager server.

rows - Number of records per page (default is 100)

page - Current page count

type - type of device template (custom/default)
http://localhost:8060/api/json/admin/listDeviceTemplates?apiKey=081c9ac51bad5efee583dcd2f&type=Custom&rows=100&page=1&sortByColumn=totaldevices&sortByType=desc
listInterfaceTemplatesGETLists all the interface templates created.apiKey* - API Key to access your OpManager server.

showMode* - allInterfaces or commonInterfaces
http://localhost:8060/api/json/admin/listInterfaceTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f&showMode=commonInterfaces
updateDeviceTemplatePOSTUpdates the device template.apiKey* - API Key to access your OpManager server.

typeName* - Template type name.

IconName* - Template icon name.

pingInterval* - Ping Interval.

category* - Category of Device.

vendor* - Vendor of device.

isOidUpdated* - true or false.

oidStr* - OID String value.

isMonitorChanged* - true or false.
http://localhost:8060/api/json/admin/updateDeviceTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&category=switch&vendor=3com&IconName=switch.png&isOidUpdated=no&oidStr=.1.3.6.1.4.1.43.1.8.41&isMonitorChanged=no&typeName=3com 3500G-EI&pingInterval=60
viewDeviceTemplateGETProvides information on the template associated to the deviceapiKey* - api key.

typeID* - Provide Type name.
http://localhost:8060/api/json/admin/viewDeviceTemplate?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeID=22
viewInterfaceTemplatesGETView All interface templatesapiKey* - api key.

typeName* - Template type name.
http://localhost:8060/api/json/admin/viewInterfaceTemplates?apiKey=081c9ac51ba16ab061d5efee583dcd2f&typeName=Ethernet
getAssociatedCredentialsGETObtains information on the credentials associated to a device
apiKey* - API Key to access your OpManager server.

name* – Name of the device whose credentials need to be fetched.
http://localhost:8060/api/json/device/getAssociatedCredentials?apiKey=081c9ac51ba16ab061d5efee583dcd2f&name=opman-k8r2s-64-3.testdomain.com
deletePerfomanceMonitorsPOSTDeletes the performance monitor from the given device
apiKey* - API Key to access your OpManager server.

name* – Name of the device whose credentials need to be fetched.

policyName* - Name of the performance monitor.
http://localhost:8060/api/json/device/deletePerfomanceMonitors?apiKey=081c9ac51ba16ab061d5efee583dcd2f&policyName=Win-CPUUtilization&name=opman-k8r2s-64-2.testdomain.com
Traps
deleteTrapForwarderPOSTDelete Trap ForwarderapiKey* - api Key.

destHost* - Destination Host.

destPort* - Destination Port.
http://localhost:8060/api/json/admin/deleteTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&destHost=opman-k8r2s-64-4&destPort=170
deleteTrapParserPOSTDelete Trap ParserapiKey*- API Key to access your OpManager server.

trapParserName* - name of the trap parser
http://localhost:8060/api/json/admin/deleteTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=testing
disableTrapParserPOSTDisable Trap ParserapiKey*- API Key to access your OpManager server.

trapParserName* - name of the trap parser
http://localhost:8060/api/json/admin/disableTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=LinkDown
enableTrapParserPOSTEnable Trap ParserapiKey*- API Key to access your OpManager server.

trapParserName* - name of the trap parser
http://localhost:8060/api/json/admin/enableTrapParser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=LinkDown
getGenericTypesGETGet Trap Generic TypesapiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/getGenericTypes?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getTrapForwardersGETList Trap ForwardersapiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/getTrapForwarders?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getTrapParserInfoGETGet Trap Parser DetailsapiKey*- API Key to access your OpManager server.

trapParserName* - name of the trap parser
http://localhost:8060/api/json/admin/getTrapParserInfo?apiKey=081c9ac51ba16ab061d5efee583dcd2f&trapParserName=LinkDown
startTrapForwarderPOSTStart Trap ForwarderapiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/startTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f
stopTrapForwarderPOSTStop Trap ForwarderapiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/stopTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f
updateTrapForwarderPOSTUpdate Trap ForwarderapiKey*: API Key to access your OpManager server.

destHost* : Previous Destination Host

destPort* : Previous Destination Port

newDestHost* : new Destination Host.

newDestPort* : new Destination Port
http://localhost:8060/api/json/admin/updateTrapForwarder?apiKey=081c9ac51ba16ab061d5efee583dcd2f&newDestPort=170&destHost=opman-k8r2s-64-6&destPort=165&newDestHost=opman-k8r2s-64-4
User Management
addUserPOSTAdds an user in OpManager.apiKey* - API Key to access your OpManager server.

userName* - User name

password* - password

privilege* - Privilege for the user. Following privileges are available
* Administrators - Full Access
* Operators - Restricted Access.

bvName - Provides access to the devices devices grouped in the specified business view. Multiple business views can be given by comma separated.

emailId - Email ID of the user.

landLine - Land line number of the user.

mobileNo - Mobile number of the user.

domainName - Name of the domain to which the user belongs to.
http://localhost:8060/api/json/admin/addUser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=rejoe@testdomain.com&privilege=Administrators&password=r&emailId=rejoe@testdomain.com
changePasswordPOSTAllows you to change the password of a user.apiKey* - API Key to access your OpManager server.

userName* - User name.

userId* – User ID.

domainName - Name of the domain.

oldPassword* – old password of the user.

newPassword* – new password of the user
http://localhost:8060/api/json/admin/changePassword?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=rejoe@testdomain.com&newPassword=rr&userId=2&oldPassword=r
deleteUserPOSTDeletes a user.apiKey* - API Key to access your OpManager server.

userName* - User name
http://localhost:8060/api/json/admin/deleteUser?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=rejoe@testdomain.com
listUsersGETLists all users created in OpManager.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/admin/listUsers?apiKey=081c9ac51ba16ab061d5efee583dcd2f
updateContactDetailsPOSTAllows you to update the contact details of a user.apiKey* - API Key to access your OpManager server.

userName* - User name.

userId* – User ID.

domainName - Name of the domain.

emailId* - emailid of the user.

phoneNumber – phone number of the user.

mobileNumber – mobile number of the user

http://localhost:8060/api/json/admin/updateContactDetails?apiKey=081c9ac51ba16ab061d5efee583dcd2f&userName=rejoe@testdomain.com&emailId=user1@testing.com&domainName=testdomain&userId=10&phoneNumber=04424453446&mobileNumber=04424453446
Virtualization
Dashboard
listCCTVViewGETLists all the CCTV views
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/dashboard/listCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f
getCCTVViewGETGets CCTV view widgets/dashboards
apiKey* - API Key to access your OpManager server.

cctvID* - cctv ID.
http://localhost:8060/api/json/dashboard/getCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&cctvID=1
deleteCCTVViewPOSTDeletes CCTV view
apiKey* - API Key to access your OpManager server.

cctvID* - cctv ID.
http://localhost:8060/api/json/dashboard/deleteCCTVView&cctvID=2&apiKey=081c9ac51ba16ab061d5efee583dcd2f
addCCTVViewPOSTAdd new CCTV view

dashboardId* - dashboard ID.

cctvName* - name of the cctv.

cctvDescription* - CCTV id

time* - refreshing time interval
 
http://localhost:8060/api/json/dashboard/addCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardId=1&cctvName=testcctv&cctvDescription=newcctv&time=5
getDashBoardsForCCTVGETGet dashboards for the given CCTV view
apiKey* - API Key to access your OpManager server.

cctvID* - cctv ID.
http://localhost:8060/api/json/dashboard/getDashBoardsForCCTV?apiKey=081c9ac51ba16ab061d5efee583dcd2f&cctvID=1
deleteWidgetPOSTDeletes the widget in dashboard page
apiKey* - API Key to access your OpManager server.

widgetID* - Widget ID
http://localhost:8060/api/json/dashboard/deleteWidget?apiKey=081c9ac51ba16ab061d5efee583dcd2f&widgetID=240
embedWidgetPOSTEmbeds URL of a widget
apiKey* - API Key to access your OpManager server.

regenerate* - true or false

height* - height of the widget

width* - width of the widget content
http://localhost:8060/api/json/dashboard/embedWidget?apiKey=081c9ac51ba16ab061d5efee583dcd2f&widgetID=144&regenerate=true&height=10&width=10
showWidgetsGETDisplay all available widgets in a dashboard
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/dashboard/showWidgets?apiKey=081c9ac51ba16ab061d5efee583dcd2f
deleteDashboardPOSTDeletes a dashboard
apiKey* - API Key to access your OpManager server.

dashboardID* - dashboard ID.
http://localhost:8060/api/json/dashboard/deleteDashboard?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardID=7
updateDashboardLayoutPOSTUpdates dashboard layout
apiKey* - API Key to access your OpManager server.

dashboardName* - name of the dashboard.

columnWidth* - width.

numberOfColumns* - Number of the columns.

dashboardID* - ID of the dashboard.

dashboardDescription – Description of the dashboard.
http://localhost:8060/api/json/dashboard/updateDashboardLayout?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardName=test&columnWidth=100&numberOfColumns=1&dashboardID=7&dashboardDescription=dess
createDashboardPOSTCreates new dashboard view
apiKey* - API Key to access to your OpManager.

dashboardName* - Name of the dashboard.

columnWidth* - column width

numberOfColumns* - number of columns.

selectedWidgets* - widget Ids

dashboardDescription – Description of the dashboard.
http://localhost:8060/api/json/dashboard/createDashboard?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardName=test&columnWidth=100&numberOfColumns=1&selectedWidgets=144&dashboardDescription=desssc
getWidgetGETFetches all widgets available in the given dashboardapiKey* - API Key to access your OpManager server.

dashboardName* - dashboard ID.
http://localhost:8060/api/json/dashboard/getWidgetsList?dashboardName=ThahirDashboard&apiKey=6d36ff8426cff396b81b248e5c458604
getWidgetDataGETDisplays the data present in the given widgetapiKey* - API Key to access your OpManager server.

widgetID* - Widget ID
http://localhost:8060/api/json/dashboard/getWidgetData?apiKey=83155f195334a19df5e58a8a33a6f804&widgetID=255
getWidgetsListGETFetches all widgets available in the given dashboardapiKey* - API Key to access your OpManager server.

dashboardName* - dashboard ID.
http://localhost:8060/api/json/dashboard/getWidgetsList?apiKey=081c9ac51ba16ab061d5efee583dcd2f&dashboardName=dashboardoverview
editCCTVViewPOSTEnables editing the CCTV view for configuring CCTV columns
apiKey* - API Key to access your OpManager server.

cctvName* - Name of the CCTV view.

cctvDescription – Description of the CCTV view.

cctvID* - CCTV Id.

time* - Refreshing interval.

dashboardId* - Dashboard ID.
http://localhost:8060/api/json/dashboard/editCCTVView?apiKey=081c9ac51ba16ab061d5efee583dcd2f&cctvName=testcctv&cctvDescription=newcctv&cctvID=2&time=5&dashboardId=2
getDashboardListGETFetches all available dashboards
apiKey* - API Key to access your OpManager server.
http://localhost:8060/api/json/dashboard/getDashboardList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
Credential Manager
addSNMPV3CredentialPOSTAdd new SNMP V3 credential

apiKey* - API Key to access your OpManager server.

port* – Protocol port number.

authPwd* - Credential username.

privPwd* – Credential password.

update – true or false.

credentialName* - Credential name.

desc – Credential description.

privProtocol* – Type of encryption for the protocol.

username* - Username for the encryption.

retries* - Connection retries count.

contextname* - Context name.

timeout* - Connection timeout.

authProtocol* - Authentication protocol.
http://localhost:8060/api/json/admin/addSNMPV3Credential?apiKey=1d626117b2ac31145ce6bca49bb0458b&port=161&privPwd=privUser&update=false&credentialName=snmpV3credential&desc=v3 credential&privProtocol=DES&authPwd=authUser&username=auth&retries=1&contextname=authUser&timeout=10&authProtocol=MD5
addLinuxCredentialPOSTAdds a Linux credential
apiKey* - API Key to access your OpManager server.

update* - true or false.

pwpmt* - Prompt for password (true or false).

credentialName* - Credential name.

cmdpmt* - Command prompt (credentials).

protocol* - Protocol name.

username* - Username.

portno* - Port number.

logpmt* - Log prompt.

password* - Credential password.

cliTimeout* - CLI credential timeout.
http://localhost:8060/api/json/admin/addLinuxCredential?update=false&pwpmt=:&credentialName=LinuxTelnet&cmdpmt=$&protocol=telnet&username=test&portno=23&logpmt=:&password=test123&apiKey=83155f195334a19df5e58a8a33a6f804&cliTimeout=10
addWindowsCredentialPOSTAdd new windows credential.
apiKey* - API Key to access your OpManager server.

credentialName* - Credential name.

username* - Username (domainname\username).

password* - Password.
http://localhost:8060/api/json/admin/addWindowsCredential?apiKey=081c9ac51ba16ab061d5efee583dcd2f
&credentialName=win&username=workgroup\administrator&password=Vembu123
addSNMPV1CredentialPOSTAdd new SNMP V1 credential.
apiKey* - API Key to access your OpManager server.

credentialName* - Credential name.

writeCommunity* - Write community password.

readCommunity* - Read community password.
http://localhost:8060/api/json/admin/addSNMPV1Credential?apiKey=081c9ac51ba16ab061d5efee583dcd2f&credentialName=test1&writeCommunity=Public&readCommunity=Public
WorkFlow
getWorkflowListGETLists all the workflows associated to a device.apiKey* - API Key to access your OpManager server.http://localhost:8060/api/json/workflow/getWorkflowList?apiKey=081c9ac51ba16ab061d5efee583dcd2f
* Mandatory parameters
** Mandatory if Auto-login is enabled.
 
CMDB Plugin API Beta.


REST APIMethodDescriptionParametersSample URL
getCIListGETList all configuration itemTECHNICIAN_KEY* - API Key to access server.http://172.18.10.195:8080/sdplus/CMDB/getCIList?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97
getAllChangesGETList all ChangesTECHNICIAN_KEY* - API Key to access server.http://172.18.10.195:8080/sdplus/Change/getAllChanges?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97
getAllContractsGETList all ContractTECHNICIAN_KEY* - API Key to access server.http://172.18.10.195:8080/sdplus/Contract/getAllContracts?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97
getAllPurchaseGETList all PurchasesTECHNICIAN_KEY* - API Key to access server.http://172.18.10.195:8080/sdplus/Purchase/getAllPurchase?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97
getAllProblemsGETList all ProblemsTECHNICIAN_KEY* - API Key to access server.http://172.18.10.195:8080/sdplus/Problem/getAllProblems?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97
getCIInfoGETGet details of configuration itemsTECHNICIAN_KEY* - API Key to access server.http://172.18.10.195:8080/sdplus/CMDB/getCIInfo?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getAssetRelationShipsGETGet Map details of RelationshipTECHNICIAN_KEY* - API Key to access server.http://172.18.10.195:8080/sdplus/CMDB/getAssetRelationShips?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getHardwareDetailsGETGet details of CI Hardware

TECHNICIAN_KEY* - API Key to access server.

ciID* - Configuration Item ID

http://172.18.10.195:8080/sdplus/CMDB/getHardwareDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getSoftwareDetailsGETget details of asset - software

TECHNICIAN_KEY* - API Key to access server.

ciID* - Configuration Item ID

http://172.18.10.195:8080/sdplus/CMDB/getSoftwareDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&format=json&ciID=603
getSystemDetailsGETGet details of asset - system

TECHNICIAN_KEY* - API Key to access server.

ciID* - Configuration Item ID

http://172.18.10.195:8080/sdplus/CMDB/getSystemDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getRPCDetailsGETGet details of asset associated - Request,change,problem

TECHNICIAN_KEY* - API Key to access server.

ciID* - Configuration Item ID

http://172.18.10.195:8080/sdplus/CMDB/getRPCDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getScanDetailsGETGet details of asset - Scan

TECHNICIAN_KEY* - API Key to access server.

ciID* - Configuration Item ID

http://172.18.10.195:8080/sdplus/CMDB/getScanDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getContractsForAssetGETGet details of asset associated contracts

TECHNICIAN_KEY* - API Key to access server.

ciID* - Configuration Item ID

http://172.18.10.195:8080/sdplus/CMDB/getContractsForAsset?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getCostDetailsGETGet cost details of asset

TECHNICIAN_KEY* - API Key to access server.

ciID* - Configuration Item ID

http://172.18.10.195:8080/sdplus/CMDB/getCostDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ciID=603
getProblemsInfoGETGet problem details

TECHNICIAN_KEY* - API Key to access server.

ProblemID* - Problem ID

http://172.18.10.195:8080/sdplus/Problem/getProblemsInfo?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getProblemAnalysisGETGet problem analysis details

TECHNICIAN_KEY* - API Key to access server.

ProblemID* - Problem ID
http://172.18.10.195:8080/sdplus/Problem/getProblemAnalysis?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getProblemSolutionGETGet solution details for problem

TECHNICIAN_KEY* - API Key to access server.

ProblemID* - Problem ID
http://172.18.10.195:8080/sdplus/Problem/getProblemSolution?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getProblemTaskGETGet task to be performed for problem

TECHNICIAN_KEY* - API Key to access server.

ProblemID* - Problem ID
http://172.18.10.195:8080/sdplus/Problem/getProblemTask?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getProblemIncidentsGETGet associated incident/request for problem

TECHNICIAN_KEY* - API Key to access server.

ProblemID* - Problem ID
http://172.18.10.195:8080/sdplus/Problem/getProblemIncidents?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getProblemHistoryGETGet problem history

TECHNICIAN_KEY* - API Key to access server.

ProblemID* - Problem ID
http://172.18.10.195:8080/sdplus/Problem/getProblemHistory?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ProblemID=1
getChangeInfoGETGet change details

TECHNICIAN_KEY* - API Key to access server.

ChangeID* - Change ID
http://172.18.10.195:8080/sdplus/Change/getChangeInfo?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&ChangeID=2
getContractDetailsGETGet Contract details

TECHNICIAN_KEY* - API Key to access server.

contractID* - Contract ID
http://172.18.10.195:8080/sdplus/Contract/getContractDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&contractID=303
getContractedAssetsGETGet asset associated with the contract

TECHNICIAN_KEY* - API Key to access server.

contractID* - Contract ID
http://172.18.10.195:8080/sdplus/Contract/getContractedAssets?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&format=json&contractID=303
getContractRenewalGETGet contract renewal details

TECHNICIAN_KEY* - API Key to access server.

contractID* - Contract ID
http://172.18.10.195:8080/sdplus/Contract/getContractRenewal?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&contractID=303
getChildContractGETGet child contract details

TECHNICIAN_KEY* - API Key to access server.

contractID* - Contract ID
http://172.18.10.195:8080/sdplus/Contract/getChildContract?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&contractID=303
getPoDetailsGETGet purchase order details

TECHNICIAN_KEY* - API Key to access server.

PoID* - Purchase order ID
http://172.18.10.195:8080/sdplus/Purchase/getPoDetails?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&PoID=1
getInvoiceAndPaymentGETGet invoice and payments details of PO

TECHNICIAN_KEY* - API Key to access server.

PoID* - Purchase order ID
http://172.18.10.195:8080/sdplus/Purchase/getInvoiceAndPayment?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&PoID=1
getPoRequestGETGet Request associated with PO

TECHNICIAN_KEY* - API Key to access server.

PoID* - Purchase order ID
http://172.18.10.195:8080/sdplus/Purchase/getPoRequest?TECHNICIAN_KEY=979ED357-447B-405E-AD74-F9B3EF4B1A97&PoID=1