AddMonitor APIs - Cloud Apps

This section explains how to use the AddMonitor API to add monitors of the category type Cloud Apps. The following monitors are supported:

Supported HTTP methods: POST

Allowed roles: Administrator

Amazon

Syntax

For Applications Manager versions till 15170:

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&accessKey=[ACCESSKEY]&SecretAccessKey=[SECRETACCESSKEY]&displayname=[DISPLAYNAME]&AccountType=[ACCOUNTTYPE]&AmazonServices=[SERVICES]

For Applications Manager versions 15180 onwards:

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Amazon&accessKey=[ACCESSKEY]&SecretAccessKey=[SECRETACCESSKEY]&displayname=[DISPLAYNAME]&AccountType=[ACCOUNTTYPE]&AmazonServices=[SERVICES]&GlobalRegions=[GLOBALREGIONS/False] &ChinaRegions=[CHINAREGIONS/False]&AWSGovCloudRegions=[GOVCLOUDREGIONS/False]&AdvancedSettings=[True/False]&discoverchild=[yes/no/unmanage]&DeletedResourceAction=[Alert/Stop/Unmanage/Delete]&StopDiscovery=[True/False]&AWSServicesToStopDiscovery=[SERVICES]&NameFilterRegex=[.*[a-zA-Z0-9-_.].*]

Request Parameters

The parameters involved in the API request are described below. Also, refer to the list of common request parameters.

Field Description
type The type of the monitor you want to add. Value should be Amazon
AmazonServices The Amazon Services that you want to monitor. Possible values are:
  • ALB (for Application Load Balancer)
  • EC2 (for Elastic Compute Cloud)
  • BEANSTALK (for Elastic Beanstalk environments)
  • AmazonGatewayLoadBalancer (for Amazon Gateway Load Balancer)
  • LAMBDA (for Lambda functions)
  • NLB (for Network Load Balancer)
  • ECS (for Elastic Container Service clusters)
  • EKS (for Elastic Kubernetes Service)
  • AmazonElasticContainerRegistry (for Amazon Elastic Container Registry)
  • RDS (for Relational Database Services)
  • DYNAMODB (for DynamoDB)
  • SQS (for Simple Queue Service)
  • AmazonFileTransferFamily (for Amazon File Transfer Family)
  • AmazonAPIGatewayHTTPAPI (for Amazon API Gateway HTTP API)
  • AmazonAPIGatewayRESTAPI (for Amazon API Gateway REST API)
  • AmazonAPIGatewayWebSocketAPI (for Amazon API Gateway WebSocket API)
  • AmazonCloudFront (for Amazon CloudFront)
  • AmazonDirectConnect (for Amazon Direct Connect)
  • AmazonVpcNatGateway (for Amazon Vpc Nat Gateway)
  • AmazonRoute53HealthChecks (for Amazon Route 53 Health Checks)
  • AmazonElasticFileSystem (for Amazon Elastic File System)
  • AmazonFSxFileCache (for Amazon FSx File Cache)
  • S3 (for S3 Buckets)
  • SNS (for Simple Notification Services)
  • DYNAMODB,EC2,RDS,S3,SNS,ALB,NLB,SQS,LAMBDA,BEANSTALK,AmazonCloudFront,AmazonElasticFileSystem,ECS,EKS (for multiple services)
accessKey The access Key ID of the AWS account with API access.

Note: Click here to know more about access keys.
SecretAccessKey The secret access key of the accessKey for the AWS account.
AccountType The account type. Possible values are
  • AwsGlobal
  • AwsChina
  • AwsGovCloud
GlobalRegions* List of global regions that you can choose from when AwsGlobal AccountType is chosen. Possible values are:
All-Regions, us-east-1, us-east-2, us-west-1, us-west-2, ap-east-1, ap-south-2, ap-southeast-3, ap-southeast-4, ap-south-1, ap-northeast-3, ap-northeast-2, ap-southeast-1, ap-southeast-2, ap-northeast-1, ca-central-1, eu-central-1, eu-central-2, eu-west-1, eu-west-2, eu-west-3, eu-north-1, eu-south-1, eu-south-2, me-south-1, me-central-1, il-central-1, sa-east-1, af-south-1 or False.

Note: Specify the value All-Regions only if you want to monitor from all the above-mentioned regions. Do not enter other region values when All-Regions is specified.
ChinaRegions* List of China regions that you can choose from when AwsChina AccountType is chosen. Possible values are:
cn-northwest-1, cn-north-1 or False.
AWSGovCloudRegions* List of US GovCloud regions that you can choose from when AwsGovCloud AccountType is chosen. Possible values are:
us-gov-west-1, us-gov-east-1 or False.
discoverchild* Enables configuration options for discovery of child monitors. Possible values are yes, no, and unmanage.
AdvancedSettings* Enables advanced settings, when checked. Possible values are True or False.
DeletedResourceAction* Actions to be performed on the resources deleted in Amazon console. If this parameter is not used, by default it is 'Alert'. Possible values are Alert/Stop/Unmanage/Delete.

Note: DeletedResourceAction will be effective only when AdvancedSettings is enabled.
StopDiscovery* Prevents discovery of resources under chosen service. Possible values are either True or False.
AWSServicesToStopDiscovery* Services for which further discovery of resources must be prevented. Available services are:
  • ALB (for Application Load Balancer)
  • EC2 (for Elastic Compute Cloud)
  • BEANSTALK (for Elastic Beanstalk environments)
  • AmazonGatewayLoadBalancer (for Amazon Gateway Load Balancer)
  • LAMBDA (for Lambda functions)
  • NLB (for Network Load Balancer)
  • ECS (for Elastic Container Service clusters)
  • EKS (for Elastic Kubernetes Service)
  • AmazonElasticContainerRegistry (for Amazon Elastic Container Registry)
  • RDS (for Relational Database Services)
  • DYNAMODB (for DynamoDB)
  • SQS (for Simple Queue Service)
  • AmazonFileTransferFamily (for Amazon File Transfer Family)
  • AmazonAPIGatewayHTTPAPI (for Amazon API Gateway HTTP API)
  • AmazonAPIGatewayRESTAPI (for Amazon API Gateway REST API)
  • AmazonAPIGatewayWebSocketAPI (for Amazon API Gateway WebSocket API)
  • AmazonCloudFront (for Amazon CloudFront)
  • AmazonDirectConnect (for Amazon Direct Connect)
  • AmazonVpcNatGateway (for Amazon Vpc Nat Gateway)
  • AmazonRoute53HealthChecks (for Amazon Route 53 Health Checks)
  • AmazonElasticFileSystem (for Amazon Elastic File System)
  • AmazonFSxFileCache (for Amazon FSx File Cache)
  • S3 (for S3 Buckets)
  • SNS (for Simple Notification Services)
  • DYNAMODB,EC2,RDS,S3,SNS,ALB,NLB,SQS,LAMBDA,BEANSTALK,AmazonCloudFront,AmazonElasticFileSystem,ECS,EKS (for multiple services)
If this option is not used, then the value should be set to False.
NameFilterRegex* Regex to filter EC2 instances and adds the instances that match the regex alone.

Note: Regex may contain alphanumeric characters, hyphen(-), underscore(_), and period(.) symbols. To ignore characters, specify .* at the beginning/end/middle one or more times.

Note: Parameters with * have been added from Applications Manager version 15180 onwards.

Sample Request

For Applications Manager versions till 15170:

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&accessKey=ACCESSKEYACCESSKEYAC&type=Amazon&SecretAccessKey=SECRETACCESSKEYSECRETACCESSKEYSECRETACCE&displayname=test&AccountType=AwsGlobal&AmazonServices=DYNAMODB,EC2,RDS,S3,SNS,ALB,NLB,SQS,AmazonCloudFront,AmazonElasticFileSystem,LAMBDA,BEANSTALK,ECS,EKS

For Applications Manager versions 15180 onwards:

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Amazon&accessKey=ACCESSKEYACCESSKEYAC&SecretAccessKey=SECRETACCESSKEYSECRETACCESSKEYSECRETACCE&displayname=Amazon&AccountType=AwsGlobal&AmazonServices=EC2,RDS,S3,SNS,ALB,NLB,SQS,AmazonCloudFront,AmazonElasticFileSystem,LAMBDA,BEANSTALK,ECS,EKS,AmazonAPIGatewayRESTAPI,AmazonAPIGatewayWebSocketAPI,AmazonAPIGatewayHTTPAPI,AmazonDirectConnect,AmazonElasticContainerRegistry,AmazonFSxFileCache,AmazonGatewayLoadBalancer,AmazonRoute53HealthChecks,AmazonVpcNatGateway&GlobalRegions=us-east-1,us-west-2&AdvancedSettings=true&discoverchild=unmanage&DeletedResourceAction=Delete&StopDiscovery=True&AWSServicesToStopDiscovery=DYNAMODB&NameFilterRegex=.*prod-instance.*

Google Cloud Platform

Syntax

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=GoogleCloudPlatform&displayname=[DISPLAY_NAME]&GCPServices=[GCP_Services]&ProjectID=[Project_ID]&provider=[OAuth_Provider_Name]&advancedsettings=[True/False]&deletedresourceaction=[Alert/Stop/Unmanage/Delete]&stopdiscovery=[True/False]&servicestostopdiscovery=[False/GCP_Services]

Request Parameters

The parameters involved in the API request are described below. Also refer to the list of common request parameters.

Field Description
displayname Display name of the monitor.
type Type of monitor to be added. The value should be GoogleCloudPlatform.
GCPServices Google Cloud Services like Compute, Storage, Filestore, etc. Available services are ComputeEngine, CloudStorage, CloudFilestore and KubernetesEngine.
ProjectID Unique ID of the project to be monitored.
provider Name of the OAuth Provider created in Applications Manager. Refer here for steps to add new OAuth Provider.
advancedsettings Enables additional settings. Possible values are either True or False
deletedresourceaction Actions to be performed on the resources deleted in GCP console. If this parameter is not used, by default it is 'Alert'. Possible values - Alert/Stop/Unmanage/Delete
stopdiscovery Prevents discovery of resources under chosen service. Possible values are either True or False
servicestostopdiscovery Services for which resources should not be discovered. Available services are ComputeEngine, CloudStorage, CloudFilestore and KubernetesEngine. If this option is not used, then the value should be False.

Sample Request

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=GoogleCloudPlatform&displayname=GCP&GCPServices=ComputeEngine,CloudStorage,CloudFilestore,KubernetesEngine&ProjectID=black-agility-235006&provider=gcp&advancedsettings=True&deletedresourceaction=Stop&stopdiscovery=False&servicestostopdiscovery=False

Microsoft 365

For Applications Manager Versions till 16300 :

Syntax

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=[TYPE]&Office365TenantName=[OFFICE365TENANTNAME]&Office365Useremail=[ADMINEMAIL]&Office365Password=[PASSWORD]&Office365Services=[OFFICE365SERVICES]&displayname=[DISPLAYNAME]&Timeout=[TIMEOUT]&ServiceHealth=[True/False]&TenantID=[TENANTID]&ClientID=[CLIENTID]&ClientSecret=[CLIENTSECRET]

Request Parameters

The parameters involved in the API request are described below. Also refer to the list of common request parameters.

Field Description
type The type of the monitor you want to add. Value should be Office365.
Office365TenantName The tenant name used by the Microsoft 365 subscription.
Office365Useremail* The Microsoft 365 user email with admin privileges.
Office365Password* The Microsoft 365 user account password.
Office365Services Required services to monitor. Supported services are "ExchangeOnline,SharepointOnline,MicrosoftTeams"
Timeout The Timeout interval in seconds.
ServiceHealth Option to enable Service Health monitoring. (True or False)
TenantID* Tenant ID of the tenant in which the application is created.
ClientID* Client ID/Application ID of the application created
ClientSecret* Client Secret created in the application created.

Note: Please note that the parameters marked with * are mandatory, while the ones marked with * are optional and applicable only when Service health is enabled.

Sample Request

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Office365&Office365TenantName=appmanager&Office365Useremail=apm@appmanager.onmicrcosoft.com&Office365Password=appman&Office365Services=ExchangeOnline,SharepointOnline,MicrosoftTeams&displayname=officemonitor&Timeout=600&ServiceHealth=True&TenantID=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh&ClientID=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh&ClientSecret=aaaaaabbbbbbccccccddddddeeeeee

For Applications Manager Versions from 16310 :

Syntax

http://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=Office365&displayname=officemonitor&Office365TenantName=applicationsmanager&Office365Services=ExchangeOnline,SharepointOnline,MicrosoftTeams&TenantID=[TENANTID]&ClientID=[CLIENTID]&ClientSecret=[CLIENTSECRET]&UsePowerShell=[True/False]&Office365Useremail=[EMAIL]&Office365Password=[PASSWORD]&Timeout=600

Request Parameters

The parameters involved in the API request are described below. Also refer to the list of common request parameters.

Field Description
type The type of the monitor you want to add. Value should be Office365.
Office365TenantName The tenant name used by the Microsoft 365 subscription.
Office365Services Required services to monitor. Supported services are "ExchangeOnline,SharepointOnline,MicrosoftTeams"
TenantID* Tenant ID of the tenant in which the application is created.
ClientID* Client ID/Application ID of the application created
ClientSecret* Client Secret created in the application created.
UsePowerShell To monitor Exchange Online Mailboxes & SharePoint Sites via PowerShell.The value will be either True or False.
Office365Useremail* The Microsoft 365 user email with admin privileges.
Office365Password* The Microsoft 365 user account password.
Timeout The Timeout interval in seconds.

Please note that the parameters marked with * are mandatory, while the ones marked with * are optional and applicable only when UsePowershell is enabled.

Sample Request

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=Office365&displayname=office365monitor&Office365TenantName=appmanager&Office365Services=ExchangeOnline,SharepointOnline,MicrosoftTeams&TenantID=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh&ClientID=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh&ClientSecret=aaaaaabbbbbbccccccddddddeeeeee&UsePowershell=True&Office365Useremail=apm@appmanager.onmicrcosoft.com&Office365Password=appman&Timeout=600

Microsoft Azure

To add Microsoft Azure monitor using Mode 1 (AD Application & Service Principal):

Syntax

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=MicrosoftAzure&displayname=[DISPLAYNAME]&SubscriptionID=[SUBSCRIPTIONID]&AzureServices=[SERVICES]&AzureAccountType=[AZUREACCOUNTTYPE]&DiscoveryMode=[DISCOVERYMODE]&ClientID=[CLIENTID]&TenantID=[TENANTID]&AppKey=[APPKEY]&ChildDiscovery=[unmanage/monitor/regexFilter]&DiscoveryFilterRegex=[ModuleType_Attribute=Regex]&AdvancedSettings=[True/False]&urlRetry=[True/False]&DeletedResourceAction=[Alert/Stop/Unmanage/Delete]&Timeout=[TIMEOUT]

Request Parameters

The parameters involved in the API request are described below. Also refer to the list of common request parameters.

Field Description
type* Type of the monitor you want to add. Value should be 'MicrosoftAzure'.
displayname* Preferred display name of the monitor.
SubscriptionID* Subcription ID of the Azure subscription to be monitored.
AzureServices* Azure services to be monitored. Provide the services as comma-separated values.
The possible values are:
  • All-Supported-Services
  • VirtualMachines
  • StorageAccounts
  • PremiumStorageAccount
  • SQLDatabases
  • ServiceBus
  • KubernetesServices
  • SQLManagedInstance
  • LoadBalancer
  • AzurePostgreSQLServer
  • AzureAppService
  • AzureSynapseAnalytics
  • AzureFunctions
  • AzureVirtualNetwork
  • AzureVMScaleSets
  • AzureRedisCache
  • AzureCosmosDB
  • AzureMariaDBServer
  • AzureMySQLServer
  • AzureExpressRouteCircuit
  • AzureNetworkInterface
  • AzureVNetGateway
  • AzureApplicationGateway
  • AzureFirewall
  • AzureTrafficManagerProfile
  • AzurePublicIPAddress
  • AzureDNSZone
  • AzurePrivateDNSZone
  • AzureFrontDoorAndCDNProfile
  • AzureNetworkWatcherConnection
  • AzureConnection
  • AzureAppPlan
  • AzureContainerInstance
  • AzureContainerRegistry
  • AzureSQLElasticPool
  • AzureLogicAppStandard
  • AzureLogicAppConsumption
  • AzureEventHubNamespace
  • AzureEventHubCluster
  • AzureStorageSyncService
  • AzureKeyVaults
  • AzureKeyVaultManagedHSM
  • AzureBastion
  • AzureRelay
  • AzureContainerApp
  • AzurePrivateEndpoint
  • AzurePrivateLinkService
  • AzureBackupVault
  • AzureRecoveryServiceVault
 
Note:
  • Selecting All-Supported-Services will enable all the supported Azure services, without selecting them individually.
  • All-Supported-Services value is not considered when it is provided with other possible values.
  • When no value is provided for Azure Services, All-Supported-Services will be considered as the default value.
AzureAccountType* The account type of your Azure account. Possible values are
  • AzureGlobal
  • AzureGovCloud
  • AzureChina
DiscoveryMode* Mode of resource discovery. The value should be 'AzureSPApp'.
ClientID* Client ID of the Microsoft Entra (Previously Azure Active Directory) application created in Azure portal.
TenantID* Tenant ID (Directory ID) of Microsoft Entra ID (Previously Azure Active Directory).
AppKey* Password of the Microsoft Entra (Previously Azure Active Directory) application created in Azure portal.
ChildDiscovery Enables configuration options for discovery of child monitors. Possible values are unmanage, monitor and regexFilter.
DiscoveryFilterRegex* Filters Azure Resources and adds the monitor that match the regex alone. Click here to learn about the possible attributes and module types.
Note:
  • Multiple Regex values can be provided as comma separated values following the syntax.
  • Encode the '&' symbol as '%26' while entering the Regex value.
  • DiscoveryFilterRegex is a mandatory value if ChildDiscovery=regexFilter.
AdvancedSettings Enables advanced settings, when checked. Possible values are True or False.
urlRetry Enabling this option will automatically retry APIs that fail due to network connectivity, during data collection. Possible values are True or False.

Note: urlRetry will be effective only when AdvancedSettings is enabled.
DeletedResourceAction Actions that are to be performed on the resources deleted in the Azure console. If this parameter is not used, by default it is set to 'Alert'. Possible values are Alert/Stop/Unmanage/Delete.

Note: DeletedResourceAction will be effective only when AdvancedSettings is enabled.

Sample Request

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=MicrosoftAzure&displayname=AzureRestAPI&SubscriptionID=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh&AzureServices=All-Supported-Services&AzureAccountType=AzureGlobal&DiscoveryMode=AzureSPApp&ClientID=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh&TenantID=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh&AppKey=aaaaaabbbbbbccccccddddddeeeeee&ChildDiscovery=regexFilter&DiscoveryFilterRegex=VirtualMachines_Name=APM.*%26%26VirtualMachines_ResourceGroupName=APP.*&AdvancedSettings=true&urlRetry=True&DeletedResourceAction=Stop&Timeout=200

To add Microsoft Azure monitor using Mode 2 (Azure Organizational Account):

Syntax

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=MicrosoftAzure&displayname=[DISPLAYNAME]&SubscriptionID=[SUBSCRIPTIONID]&AzureServices=[SERVICES]&AzureAccountType=[AZUREACCOUNTTYPE]&DiscoveryMode=[DISCOVERYMODE]&AzureOrgUserName=[USEREMAILOFORGANIZATIONALACCOUNT]&AzureOrgPassword=[PASSWORDOFORGANIZATIONALACCOUNT]&ChildDiscovery=[unmanage/monitor/regexFilter]&DiscoveryFilterRegex=[ModuleType_Attribute=Regex]&AdvancedSettings=[True/False]&urlRetry=[True/False]&DeletedResourceAction=[Alert/Stop/Unmanage/Delete]&Timeout=[TIMEOUT]

Request Parameters

The parameters involved in the API request are described below. Also refer to the list of common request parameters.

Field Description
type* Type of the monitor you want to add. Value should be 'MicrosoftAzure'.
displayname* Preferred display name of the monitor.
SubscriptionID* Subcription ID of the Azure subscription to be monitored.
AzureServices* Azure services to be monitored. Provide the services as comma-separated values.
The possible values are:
  • All-Supported-Services
  • VirtualMachines
  • StorageAccounts
  • PremiumStorageAccount
  • SQLDatabases
  • ServiceBus
  • KubernetesServices
  • SQLManagedInstance
  • LoadBalancer
  • AzurePostgreSQLServer
  • AzureAppService
  • AzureSynapseAnalytics
  • AzureFunctions
  • AzureVirtualNetwork
  • AzureVMScaleSets
  • AzureRedisCache
  • AzureCosmosDB
  • AzureMariaDBServer
  • AzureMySQLServer
  • AzureExpressRouteCircuit
  • AzureNetworkInterface
  • AzureVNetGateway
  • AzureApplicationGateway
  • AzureFirewall
  • AzureTrafficManagerProfile
  • AzurePublicIPAddress
  • AzureDNSZone
  • AzurePrivateDNSZone
  • AzureFrontDoorAndCDNProfile
  • AzureNetworkWatcherConnection
  • AzureConnection
  • AzureAppPlan
  • AzureContainerInstance
  • AzureContainerRegistry
  • AzureSQLElasticPool
  • AzureLogicAppStandard
  • AzureLogicAppConsumption
  • AzureEventHubNamespace
  • AzureEventHubCluster
  • AzureStorageSyncService
  • AzureKeyVaults
  • AzureKeyVaultManagedHSM
  • AzureBastion
  • AzureRelay
  • AzureContainerApp
  • AzurePrivateEndpoint
  • AzurePrivateLinkService
  • AzureBackupVault
  • AzureRecoveryServiceVault
 
Note:
  • Selecting All-Supported-Services will enable all the supported Azure services, without selecting them individually.
  • All-Supported-Services value is not considered when it is provided with other possible values.
  • When no value is provided for Azure Services, All-Supported-Services will be considered as the default value.
AzureAccountType* The account type of your Azure account. Possible values are
  • AzureGlobal
  • AzureGovCloud
  • AzureChina
DiscoveryMode* Mode of resource discovery. The value should be 'AzureOrgAccount'
AzureOrgUserName* Organizational account created in Azure portal.
AzureOrgPassword* Password of the organizational account.
ChildDiscovery Enables configuration options for discovery of child monitors. Possible values are unmanage, monitor and regexFilter.
DiscoveryFilterRegex* Filters Azure Resources and adds the monitor that match the regex alone. Click here to learn about the possible attributes and module types.
Note:
  • Multiple Regex values can be provided as comma separated values following the syntax.
  • Encode the '&' symbol as '%26' while entering the Regex value.
  • DiscoveryFilterRegex is a mandatory value if ChildDiscovery=regexFilter.
AdvancedSettings Enables advanced settings, when checked. Possible values are True or False.
urlRetry Enabling this option will automatically retry APIs that fail due to network connectivity, during data collection. Possible values are True or False.

Note: urlRetry will be effective only when AdvancedSettings is enabled.
DeletedResourceAction Actions that are to be performed on the resources deleted in the Azure console. If this parameter is not used, by default it is set to 'Alert'. Possible values are Alert/Stop/Unmanage/Delete.

Note: DeletedResourceAction will be effective only when AdvancedSettings is enabled.
Timeout The timeout value, in seconds. Default value is 300.

Sample Request

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=MicrosoftAzure&displayname=AzureRestAPI&SubscriptionID=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh&AzureServices=VirtualMachines,StorageAccounts,PremiumStorageAccount,SQLDatabases,ServiceBus,KubernetesServices,SQLManagedInstance,LoadBalancer,AzurePostgreSQLServer,AzureAppService,AzureSynapseAnalytics,AzureFunctions,AzureVirtualNetwork,AzureVMScaleSets,AzureRedisCache,AzureCosmosDB,AzureMariaDBServer,AzureMySQLServer&AzureAccountType=AzureGlobal&DiscoveryMode=AzureOrgAccount&AzureOrgUserName=apmou@apmoutlook.onmicrosoft.com&AzureOrgPassword=appman&ChildDiscovery=monitor&AdvancedSettings=true&urlRetry=True &DeletedResourceAction=Unmanage&Timeout=200

To add Microsoft Azure monitor using Mode 3 (OAuth Mode):

Syntax

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=MicrosoftAzure&displayname=[DISPLAYNAME]&SubscriptionID=[SUBSCRIPTIONID]&AzureServices=[SERVICES]&AzureAccountType=[AZUREACCOUNTTYPE]&DiscoveryMode=[DISCOVERYMODE]&OAuthVal=[OAUTHVALUE]&ChildDiscovery=[unmanage/monitor/regexFilter]&DiscoveryFilterRegex=[ModuleType_Attribute=Regex]&AdvancedSettings=[True/False]&urlRetry=[True/False]&DeletedResourceAction=[Alert/Stop/Unmanage/Delete]&Timeout=[TIMEOUT]

Request Parameters

The parameters involved in the API request are described below. Also refer to the list of common request parameters.

Field Description
type* Type of the monitor you want to add. Value should be 'MicrosoftAzure'.
displayname* Preferred display name of the monitor.
SubscriptionID* Subcription ID of the Azure subscription to be monitored.
AzureServices* Azure services to be monitored. Provide the services as comma-separated values.
The possible values are:
  • All-Supported-Services
  • VirtualMachines
  • StorageAccounts
  • PremiumStorageAccount
  • SQLDatabases
  • ServiceBus
  • KubernetesServices
  • SQLManagedInstance
  • LoadBalancer
  • AzurePostgreSQLServer
  • AzureAppService
  • AzureSynapseAnalytics
  • AzureFunctions
  • AzureVirtualNetwork
  • AzureVMScaleSets
  • AzureRedisCache
  • AzureCosmosDB
  • AzureMariaDBServer
  • AzureMySQLServer
  • AzureExpressRouteCircuit
  • AzureNetworkInterface
  • AzureVNetGateway
  • AzureApplicationGateway
  • AzureFirewall
  • AzureTrafficManagerProfile
  • AzurePublicIPAddress
  • AzureDNSZone
  • AzurePrivateDNSZone
  • AzureFrontDoorAndCDNProfile
  • AzureNetworkWatcherConnection
  • AzureConnection
  • AzureAppPlan
  • AzureContainerInstance
  • AzureContainerRegistry
  • AzureSQLElasticPool
  • AzureLogicAppStandard
  • AzureLogicAppConsumption
  • AzureEventHubNamespace
  • AzureEventHubCluster
  • AzureStorageSyncService
  • AzureKeyVaults
  • AzureKeyVaultManagedHSM
  • AzureBastion
  • AzureRelay
  • AzureContainerApp
  • AzurePrivateEndpoint
  • AzurePrivateLinkService
  • AzureBackupVault
  • AzureRecoveryServiceVault
 
Note:
  • Selecting All-Supported-Services will enable all the supported Azure services, without selecting them individually.
  • All-Supported-Services value is not considered when it is provided with other possible values.
  • When no value is provided for Azure Services, All-Supported-Services will be considered as the default value.
AzureAccountType* The account type of your Azure account. Possible values are
  • AzureGlobal
  • AzureGovCloud
  • AzureChina
DiscoveryMode* Mode of resource discovery. The value should be 'AzureOAuth'.
OAuthVal* Indicates the OAuth value. Refer here for steps to add new OAuth Provider.
ChildDiscovery Enables configuration options for discovery of child monitors. Possible values are unmanage, monitor and regexFilter.
DiscoveryFilterRegex* Filters Azure Resources and adds the monitor that match the regex alone. Click here to learn about the possible attributes and module types.
Note:
  • Multiple Regex values can be provided as comma separated values following the syntax.
  • Encode the '&' symbol as '%26' while entering the Regex value.
  • DiscoveryFilterRegex is a mandatory value if ChildDiscovery=regexFilter.
AdvancedSettings Enables advanced settings, when checked. Possible values are True or False.
urlRetry Enabling this option will automatically retry APIs that fail due to network connectivity, during data collection. Possible values are True or False.

Note: urlRetry will be effective only when AdvancedSettings is enabled.
DeletedResourceAction Actions that are to be performed on the resources deleted in the Azure console. If this parameter is not used, by default it is set to 'Alert'. Possible values are Alert/Stop/Unmanage/Delete.

Note: DeletedResourceAction will be effective only when AdvancedSettings is enabled.

Sample Request

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=MicrosoftAzure&displayname=AzureOAuthRestAPI&SubscriptionID=aaaabbbb-cccc-dddd-eeee-ffffgggghhhh&AzureServices=VirtualMachines,StorageAccounts,PremiumStorageAccount,SQLDatabases,ServiceBus,KubernetesServices,SQLManagedInstance,LoadBalancer,AzurePostgreSQLServer,AzureAppService,AzureSynapseAnalytics,AzureFunctions,AzureVirtualNetwork,AzureVMScaleSets,AzureRedisCache,AzureCosmosDB,AzureMariaDBServer,AzureMySQLServer&AzureAccountType=AzureGlobal&DiscoveryMode=AzureOAuth&OAuthVal=10000000&ChildDiscovery=unmanage&AdvancedSettings=False&urlRetry=False&DeletedResourceAction=Alert&Timeout=200

Note: Please note that the parameters marked with * are mandatory.

OpenStack

Syntax

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=OpenStack&displayname=[DISPLAY_NAME]&baseAuthURL=[IDENTITY_URL]&tenantName=[PROJECT_NAME]&username=[USENAME]&password=[PASSWORD]&isProxyNeeded=[yes/no]&isProjectScopedToken=[True/False]

Request Parameters

The parameters involved in the API request are described below. Also, refer to the list of common request parameters.

Field Description
displayname The display name of the OpenStack monitor
type The type of the monitor you want to add. For OpenStack, it should be "OpenStack"
baseAuthURL The Base Authentication URL for OpenStack. Eg: http://controller:5000
tenantName The Project Name associated with User of OpenStack account.
username The Username of OpenStack account.
password The Password of OpenStack account.
isProxyNeeded Specifies if a proxy is required for monitoring. Possible values are yes or no.
isProjectScopedToken Specifies if the authorization scope is set to Tenant/Project. Possible values are True/False.

Sample Request

https://apm-prod-server:8443/AppManager/xml/AddMonitor?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=OpenStack&displayname=OpenStack_API&baseAuthURL=http://controller:5000&tenantName=Venus&username=admin&password=appman&isProxyNeeded=no&isProjectScopedToken=False

Error Handling:

4601 - The Authentication URL should not be empty.
4602 - The Tenant Name should not be empty.

Oracle Cloud Infrastructure

Syntax

https://[HOST]:[PORT]/AppManager/xml/AddMonitor?apikey=[APIKEY]&type=OracleCloud&displayname=[DISPLAY_NAME]&TenancyOCID=[Tenancy_OCID]&UserID=[User_OCID]&OracleServices=[Oracle_Services]&PEMFilePath=[PEM_File_Path]&Fingerprint=[Finger_print]&RegionsToMonitor=[Regions_To_Monitor]&stopdiscovery=[Stop_Discovery_Option]&ActionOnTerminatedResources=[Action]&advancedsettings=[Advanced_Settings]&servicesToNotDiscover=[Services_To_Not_Discover]

Request Parameters

The parameters involved in the API request are described below. Also refer to the list of common request parameters.

Field Description
displayname Name of the Oracle Cloud monitor
type Type of monitor to be added. Value should be OracleCloud.
TenancyOCID Oracle Cloud Identifier for the tenancy.
UserID Oracle Cloud Identifier for the user.
OracleServices Type of service to be monitored. Available services are Compute, Database, and Storage.
PEMFilePath File path in which the file contains the private key.
Fingerprint Obtained by uploading public key to the Oracle Cloud console.
RegionsToMonitor List of regions to be monitored.
stopdiscovery Prevents discovery of resources under a particular service.
ActionOnTerminatedResources Actions to be performed on terminated resources.
advancedsettings Enables additional settings, when checked.
servicesToNotDiscover Services for which discovery should not be enabled. Available services are Compute, Database, and Storage.

Sample Request

https://apm-prod-server:8443/AppManager/xml/AddMonitor? apikey=aaaaaabbbbbbccccccddddddeeeeee&type=OracleCloud&displayname=oraclecloudrest&TenancyOCID=ocid1.tenancy.oc1..aaaaaaaagltesttesttesttest26h5ksdo6fgbvbcmj377dnoka73rq&UserID=ocid1.user.oc1..aaaaaaaabz2skyed3j3kwxsgqtesttesttesttestoczno4ew2ov7rr57wnuza&OracleServices=Compute,Storage,Database&PEMFilePath=C:\Users\APMuser\.oci\oci_api_key.pem&Fingerprint=ea:e1:f8:68:a1:7f:ds:df:as:sd:d7:62:9e:53:f0:1f&RegionsToMonitor=eu-frankfurt-1,us-ashburn-1&stopdiscovery=False&ActionOnTerminatedResources=Unmanage&advancedsettings=False&servicesToNotDiscover=Compute

Thank you for your feedback!

Was this content helpful?

We are sorry. Help us improve this page.

How can we improve this page?
Do you need assistance with this topic?
By clicking "Submit", you agree to processing of personal data according to the Privacy Policy.