Endpoint
/api/v2/tenants/{tenantId}/integrations/installed/{installedAppIntgId}/config

  • Create configuration profile having
    • Target device connection details (config profile name, IP/hostname, credentials., etc) as defined in the manifest.
    • Create alert conditions (threshold, alert enable/disable alert message settings)
    • Set discovery & monitoring schedule

Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

installedAppIntgId
string

Installed App Integration UUID

adapaterMetric
array

adapaterMetric.availabilityRule
adapaterMetric.metrics
adapaterMetric.resourceType
configId
string

configId,the adapter manifest uuid for profiles.

frequency
number

installedUniqueId
string

Installed app uuid.

name
string

This is name of the app as listed in available apps in the adapter category

properties
object

properties.Credential
properties.HostName
properties.IP Address
schedule
object

Define the discovery time of resources:

schedule.pattern
Pattern of the schedule. Example: If pattern type is WEEKLY, then pattern is MON, WED.
schedule.patternType
Discovery schedule pattern type. Example: HOURLY, DAILY, WEEKLY, MONTHLY, MINUTES.
schedule.startTime
Define start time of discovery.
scheduleFlag
boolean

{
  "adapterMetric": [
    {
      "availabilityRule": "ALL",
      "metrics": [
        {
          "availibityMetric": false,
          "dataPointConverisonOptions": [
            {
              "true": "1"
            }
          ],
          "dataPointType": "Gauge",
          "defaultMetric": true,
          "graph": {
            "formatPlottedValue": true,
            "graphPoint": true
          },
          "metricName": "metric1",
          "multiplicationFactor": "1",
          "notification": {
            "alertOn": "NONE",
            "critical": {
              "operator": "GREATER_THAN_EQUAL",
              "repeat": 1,
              "value": "65"
            },
            "description": "hnas file system percentage-metric-1",
            "direction": "NEGATIVE",
            "formatAlertValue": true,
            "limit": 10,
            "sensitivity": "HIGH",
            "subject": "sample-app-metric1",
            "warning": {
              "operator": "NONE",
              "repeat": 2,
              "value": "null"
            }
          },
          "units": "percentage"
        },
        {
          "availibityMetric": false,
          "dataPointConverisonOptions": [
            {
              "true": "1"
            }
          ],
          "dataPointType": "Gauge",
          "defaultMetric": true,
          "graph": {
            "formatPlottedValue": true,
            "graphPoint": true
          },
          "metricName": "metric2",
          "multiplicationFactor": "1",
          "notification": {
            "alertOn": "NONE",
            "critical": {
              "operator": "GREATER_THAN_EQUAL",
              "repeat": 1,
              "value": "65"
            },
            "description": "hnas file system percentage-metric-2",
            "direction": "NEGATIVE",
            "formatAlertValue": true,
            "limit": 10,
            "sensitivity": "HIGH",
            "subject": "sample-app-meric-2",
            "warning": {
              "operator": "NONE",
              "repeat": 2,
              "value": "null"
            }
          },
          "units": "percentage"
        },
        {
          "availibityMetric": false,
          "dataPointConverisonOptions": [
            {
              "true": "1"
            }
          ],
          "dataPointType": "Gauge",
          "defaultMetric": true,
          "graph": {
            "formatPlottedValue": true,
            "graphPoint": true
          },
          "metricName": "metric3",
          "multiplicationFactor": "1",
          "notification": {
            "alertOn": "NONE",
            "critical": {
              "operator": "GREATER_THAN_EQUAL",
              "repeat": 1,
              "value": "65"
            },
            "description": "hnas file system percentage-metric-1",
            "direction": "NEGATIVE",
            "formatAlertValue": true,
            "limit": 10,
            "sensitivity": "HIGH",
            "subject": "sample-app-metric1",
            "warning": {
              "operator": "NONE",
              "repeat": 2,
              "value": "null"
            }
          },
          "units": "percentage"
        }
      ],
      "resourceType": "Server"
    }
  ],
  "frequency": 120,
  "name": "test-121",
  "properties": {
    "Credential": {
      "Custom": {
        "secret": "second-test-secret",
        "secretToken": "second-test-secretToken"
      }
    },
    "HostName": "hostName-schudule",
    "IP Address": "192.25.26.199"
  },
  "schedule": {
    "pattern": "sunday, monday, tuesday,",
    "patternType": "WEEKLY",
    "startTime": "9"
  }
}

Responses

OK

adapaterMetric
array

adapaterMetric.availabilityRule
adapaterMetric.metrics
adapaterMetric.resourceType
configId
string

configId,the adapter manifest uuid for profiles.

frequency
number

installedUniqueId
string

Installed app uuid.

name
string

This is name of the app as listed in available apps in the adapter category

properties
object

properties.Credential
properties.HostName
properties.IP Address
schedule
object

Define the discovery time of resources:

schedule.pattern
Pattern of the schedule. Example: If pattern type is WEEKLY, then pattern is MON, WED.
schedule.patternType
Discovery schedule pattern type. Example: HOURLY, DAILY, WEEKLY, MONTHLY, MINUTES.
schedule.startTime
Define start time of discovery.
scheduleFlag
boolean

{
  "adapterMetric": [
    {
      "availabilityRule": "ALL",
      "metrics": [
        {
          "availibityMetric": false,
          "dataPointConverisonOptions": [
            {
              "true": "1"
            }
          ],
          "dataPointType": "Gauge",
          "defaultMetric": true,
          "graph": {
            "formatPlottedValue": true,
            "graphPoint": true
          },
          "metricName": "metric1",
          "multiplicationFactor": "1",
          "notification": {
            "alertOn": "NONE",
            "critical": {
              "operator": "GREATER_THAN_EQUAL",
              "repeat": 1,
              "value": "65"
            },
            "description": "hnas file system percentage-metric-1",
            "direction": "NEGATIVE",
            "formatAlertValue": true,
            "limit": 10,
            "raiseAlert": false,
            "sensitivity": "HIGH",
            "subject": "sample-app-metric1",
            "warning": {
              "operator": "NONE",
              "repeat": 2,
              "value": "null"
            }
          },
          "units": "percentage"
        },
        {
          "availibityMetric": false,
          "dataPointConverisonOptions": [
            {
              "true": "1"
            }
          ],
          "dataPointType": "Gauge",
          "defaultMetric": true,
          "graph": {
            "formatPlottedValue": true,
            "graphPoint": true
          },
          "metricName": "metric2",
          "multiplicationFactor": "1",
          "notification": {
            "alertOn": "NONE",
            "critical": {
              "operator": "GREATER_THAN_EQUAL",
              "repeat": 1,
              "value": "65"
            },
            "description": "hnas file system percentage-metric-2",
            "direction": "NEGATIVE",
            "formatAlertValue": true,
            "limit": 10,
            "raiseAlert": false,
            "sensitivity": "HIGH",
            "subject": "sample-app-meric-2",
            "warning": {
              "operator": "NONE",
              "repeat": 2,
              "value": "null"
            }
          },
          "units": "percentage"
        },
        {
          "availibityMetric": false,
          "dataPointConverisonOptions": [
            {
              "true": "1"
            }
          ],
          "dataPointType": "Gauge",
          "defaultMetric": true,
          "graph": {
            "formatPlottedValue": true,
            "graphPoint": true
          },
          "metricName": "metric3",
          "multiplicationFactor": "1",
          "notification": {
            "alertOn": "NONE",
            "critical": {
              "operator": "GREATER_THAN_EQUAL",
              "repeat": 1,
              "value": "65"
            },
            "description": "hnas file system percentage-metric-1",
            "direction": "NEGATIVE",
            "formatAlertValue": true,
            "limit": 10,
            "raiseAlert": false,
            "sensitivity": "HIGH",
            "subject": "sample-app-metric1",
            "warning": {
              "operator": "NONE",
              "repeat": 2,
              "value": "null"
            }
          },
          "units": "percentage"
        }
      ],
      "resourceType": "Server"
    }
  ],
  "configId": "ADAPTER-MANIFEST-be2e25cb-4c93-43b9-998d-24a6219e2398",
  "frequency": 120,
  "installedUniqueId": "INTG-65ccfb46-9431-4c47-9d3e-5645fabd53a9",
  "name": "test-121",
  "properties": {
    "Credential": {
      "Custom": {
        "secret": "second-test-secret",
        "secretToken": "second-test-secretToken"
      }
    },
    "HostName": "hostName-schudule",
    "IP Address": "192.25.26.199"
  },
  "scheduleFlag": false
}