Endpoint
/api/v2/tenants/{tenantId}/serviceGroups/search
Path Parameters
tenantIdstring
Query Parameters
pageNointeger
pageSizeinteger
isDescendingOrderboolean
sortNamestring
queryStringstring
Responses
OK
descendingOrderboolean
nextPageboolean
orderBystring
pageNointeger
pageSizeinteger
previousPageNointeger
resultsarray
Child Parameters
- results.alert
- (Optional) Generate an alert when the threshold limits are breached.
- results.alertType
- (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.
- results.childType
- Child service group type. Example: DEVICE, SERVICEGROUP, SNS, SQS
- results.createdDate
- results.filterCriteria
- results.frequency
- (Optional)
- results.id
- results.include
- results.kbArticlesIds
- 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].
- results.metrics
- results.monitorNames
- results.name
- Unique name for the service group. The service group is identified with this name.
- results.parent
- results.thresholdLimit
- (Optional) Provide a specific threshold value to determine count or percentage.
- results.thresholdType
- (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`.
- results.type
- (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.
- results.updatedDate
totalPagesinteger
totalResultsinteger
{
"descendingOrder": true,
"nextPage": false,
"orderBy": "id",
"pageNo": 1,
"pageSize": 100,
"previousPageNo": 0,
"results": [
{
"alert": false,
"alertType": 0,
"childType": "SERVICEGROUP",
"createdDate": "2018-06-20T12:22:11+0000",
"id": "SGP-35ce4940-dc09-43f4-95d7-de4dec4ee9c5",
"include": "ALL",
"metrics": [],
"name": "Finance Inventory",
"thresholdLimit": 1,
"thresholdType": "count",
"type": "alert"
},
{
"alert": false,
"alertType": 0,
"childType": "SERVICEGROUP",
"createdDate": "2018-06-20T11:48:20+0000",
"id": "SGP-c93673d0-355e-40bf-807c-44cc1d8678a4",
"include": "ALL",
"metrics": [],
"name": "VG Lab Servers",
"thresholdLimit": 1,
"thresholdType": "count",
"type": "alert"
},
{
"alert": false,
"alertType": 2,
"childType": "DEVICE",
"createdDate": "2018-06-20T11:33:08+0000",
"frequency": 5,
"id": "SGP-d71e0398-f33b-48ba-a283-1fa11ebe3e17",
"include": "ALL",
"metrics": [],
"monitorNames": [
"service.availability.metric"
],
"name": "Warehouse Maintenance Servers",
"thresholdLimit": 1,
"thresholdType": "count",
"type": "alert",
"updatedDate": "2018-06-20T11:43:17+0000"
},
{
"alert": false,
"alertType": 2,
"childType": "DEVICE",
"createdDate": "2018-06-19T13:04:17+0000",
"id": "SGP-0e2ddd05-225e-4078-8d4a-93e03d9aad1b",
"include": "ALL",
"metrics": [],
"name": "Audit Networks",
"thresholdLimit": 1,
"thresholdType": "count",
"type": "alert",
"updatedDate": "2018-06-20T11:16:35+0000"
},
{
"alert": false,
"alertType": 2,
"childType": "DEVICE",
"createdDate": "2018-01-03T12:56:55+0000",
"id": "SGP-615a32d1-67b1-47f8-b4e4-e224b66d2ca1",
"include": "ALL",
"metrics": [],
"name": "Finance Services",
"thresholdLimit": 1,
"thresholdType": "count",
"type": "alert"
},
{
"alert": false,
"alertType": 0,
"childType": "SYNTHETIC",
"createdDate": "2017-10-24T19:25:25+0000",
"id": "SGP-1a15ad00-69cf-440c-b19e-880d5a550e2b",
"include": "ALL",
"metrics": [],
"name": "Synthetic Monitoring",
"thresholdLimit": 1,
"thresholdType": "count",
"type": "alert"
},
{
"alert": false,
"alertType": 2,
"childType": "DEVICE",
"createdDate": "2016-12-08T11:03:02+0000",
"frequency": 5,
"id": "SGP-54d8a28a-3b00-4fb5-9079-e008d132f648",
"include": "ALL",
"metrics": [],
"monitorNames": [
"service.availability.metric"
],
"name": "testing",
"thresholdLimit": 1,
"thresholdType": "count",
"type": "alert"
}
],
"totalPages": 1,
"totalResults": 7
}