Create or Update Service Group

Use this API to create a parent (root level) service group.

This API can perform the following actions on a service group:

  1. Create a service group
  2. Rename a service group
  3. Add set of services to a service group
  4. Change knowledge base articles assigned to a service group
  5. Add a service group as child to a parent service group

Path Parameters

  • clientIdstringrequired

    Describes the clientId of the tenant

Request Body

application/json

  • idstring

  • namestring

    Unique name for the service group. The service group is identified with this name.

  • createdDatestring

  • updatedDatestring

  • childTypestring

    Child service group type. Example: DEVICE, SERVICEGROUP, SNS, SQS

  • frequencyinteger

    (Optional)

  • thresholdTypestring

    (Optional) Define the availability status for a service group with below threshold types: - count: Define availability of a service group based on the number of resources in the group. For example, if 10 resources are down. - percentage: Percentage of resources or services that should be considered to determine the availability. Below are the supported availability statuses: - Down: If resources or services down are greater than or equal to a specific value(count/percentage), then service is considered as Down. - Degraded: If resource or services down are less than a specific value(count/percentage), then service is considered as Degraded. - OK: If all resources or services are Up, then service is considered as OK. For example, a user wants to define availability status as Down if 5 resources are down, then the values are provided as: `"thresholdType": "count","thresholdLimit": 5`.

  • thresholdLimitinteger

    (Optional) Provide a specific threshold value to determine count or percentage. only numeric values are accepted; decimal values will be rounded to the lower value(floor). The range is between 1 to 100.

  • monitorNamesarray of strings

  • includestring

  • typestring

    (Optional) - To generate an alert when the threshold limits are breached, provide type: alert. - To display the availability status without generating an alert, provide type: default.

  • alertTypeinteger

    (Optional) Provide specific alertType value to set service availability monitor: - Service Availability Monitor will be set to Available, If alertType = 2. - Service Availability Monitor will be set to Any critical alert, If alertType = 0. - Service Availability Monitor will be set to Critical alert, If alertType = 1.

  • alertboolean

    (Optional) Generate an alert when the threshold limits are breached.

  • metricsarray

  • filterCriteriaobject

  • parentobject

  • kbArticlesIdsarray of strings

    Assign knowledge base articles to a device group.Note: To fetch a knowledge base article ID: 1. Log into OpsRamp. 2. Click Knowledge Base. 3. Select the required article and then copy the article ID. 4. Provide the article ID in "kbArticleIds" field. Example: "kbArticleIds": [22089].

  • depthnumber

  • clientobject

Request Body Samples

[
  {
    "name": "Finance Inventory",
    "createdDate": "2018-06-20T11:33:08+0000",
    "updatedDate": "2018-06-20T11:33:08+0000",
    "childType": "SERVICEGROUP",
    "frequency": 5,
    "thresholdType": "count",
    "thresholdLimit": 1,
    "monitorNames": [
      "service.availability.metric"
    ],
    "include": "ALL",
    "type": "alert",
    "alertType": 2,
    "alert": false,
    "metrics": []
  }
]

Responses

  • idstring

  • namestring

    Unique name for the service group. The service group is identified with this name.

  • createdDatestring

  • updatedDatestring

  • childTypestring

    Child service group type. Example: DEVICE, SERVICEGROUP, SNS, SQS

  • frequencyinteger

    (Optional)

  • thresholdTypestring

    (Optional) Define the availability status for a service group with below threshold types: - count: Define availability of a service group based on the number of resources in the group. For example, if 10 resources are down. - percentage: Percentage of resources or services that should be considered to determine the availability. Below are the supported availability statuses: - Down: If resources or services down are greater than or equal to a specific value(count/percentage), then service is considered as Down. - Degraded: If resource or services down are less than a specific value(count/percentage), then service is considered as Degraded. - OK: If all resources or services are Up, then service is considered as OK. For example, a user wants to define availability status as Down if 5 resources are down, then the values are provided as: `"thresholdType": "count","thresholdLimit": 5`.

  • thresholdLimitinteger

    (Optional) Provide a specific threshold value to determine count or percentage. only numeric values are accepted; decimal values will be rounded to the lower value(floor). The range is between 1 to 100.

  • monitorNamesarray of strings

  • includestring

  • typestring

    (Optional) - To generate an alert when the threshold limits are breached, provide type: alert. - To display the availability status without generating an alert, provide type: default.

  • alertTypeinteger

    (Optional) Provide specific alertType value to set service availability monitor: - Service Availability Monitor will be set to Available, If alertType = 2. - Service Availability Monitor will be set to Any critical alert, If alertType = 0. - Service Availability Monitor will be set to Critical alert, If alertType = 1.

  • alertboolean

    (Optional) Generate an alert when the threshold limits are breached.

  • metricsarray

  • filterCriteriaobject

  • parentobject

  • kbArticlesIdsarray of strings

    Assign knowledge base articles to a device group.Note: To fetch a knowledge base article ID: 1. Log into OpsRamp. 2. Click Knowledge Base. 3. Select the required article and then copy the article ID. 4. Provide the article ID in "kbArticleIds" field. Example: "kbArticleIds": [22089].

  • depthnumber

  • clientobject

Loading Examples...