Endpoint
/api/v2/tenants/{tenantId}/policies/firstResponse

Example:

Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

Query Parameters
pageNo
integer

pageSize
integer

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.enabled
results.firstResponseType
results.id
results.name
results.precedence
totalPages
integer

totalResults
integer

{
  "descendingOrder": false,
  "nextPage": false,
  "orderBy": "precedence",
  "pageNo": 1,
  "pageSize": 100,
  "previousPageNo": 0,
  "results": [
    {
      "enabled": true,
      "firstResponseType": "SUPPRESSION",
      "id": "POLICY-AC-c44f4193-154a-4aa5-b8a9-e5ea5acb386b",
      "name": "Policy1",
      "precedence": 1
    },
    {
      "enabled": true,
      "firstResponseType": "SUPPRESSION",
      "id": "POLICY-AC-d53e179d-8c9b-4564-b793-dc639f6a7cf2",
      "name": "Policy2",
      "precedence": 2
    }
  ],
  "totalPages": 1,
  "totalResults": 2
}
Endpoint
/api/v2/tenants/{tenantId}/policies/firstResponse
Path Parameters
tenantId
string

Describes the client ID or msp ID of the tenant

attributeActions
object

attributeActions.continuousLearning
attributeActions.runProcess
attributeActions.suppress
createdBy
object

createdBy.email
createdBy.firstName
createdBy.lastName
createdBy.loginName
createdTime
string

enabledMode
string

filterCriteria
object

filterCriteria.filterBased
filterCriteria.matchingType
filterCriteria.rules
matchingType
string

name
string

organizationMatchingType
string

patternActions
object

patternActions.seasonalityTimeFrame
patternActions.suppress
updatedBy
object

updatedBy.email
updatedBy.firstName
updatedBy.lastName
updatedBy.loginName
updatedTime
string

{
  "attributeActions": {
    "continuousLearning": true,
    "runProcess": {
      "learnedConfiguration": true,
      "processIds": [
        "PROCESS_9beade88-834a-4229-ab34-90380214cf74"
      ]
    },
    "suppress": {
      "learnedConfiguration": true,
      "suppressDuration": 5
    }
  },
  "enabledMode": "ON",
  "filterCriteria": {
    "filterBased": true,
    "matchingType": "ALL",
    "rules": [
      {
        "entityName": "resource_name",
        "entityValue": "vm",
        "filterType": "nativeAttributes",
        "operator": "Starts with"
      },
      {
        "entityName": "ip_address",
        "filterType": "nativeAttributes",
        "ipMatchingConditions": {
          "cidrNotation": "192.168.1.1/24",
          "ipAddressMatchType": "CIDR Match"
        }
      }
    ]
  },
  "name": "firstResponse_1",
  "patternActions": {
    "seasonalityTimeFrame": "7D",
    "suppress": {
      "seasonalAlerts": true
    }
  }
}
{
  "attributeActions": {
    "suppress": {
      "learnedConfiguration": true,
      "suppressDuration": 5
    }
  },
  "enabledMode": "ON",
  "filterCriteria": {
    "filterBased": true,
    "matchingType": "ALL",
    "rules": [
      {
        "entityName": "resource_name",
        "entityValue": "vm",
        "filterType": "nativeAttributes",
        "operator": "Starts  With"
      }
    ]
  },
  "includedClients": [
    "client_8",
    "client_9"
  ],
  "name": "partnerPolicy1",
  "organizationMatchingType": "INCLUDE"
}

Responses

OK

attributeActions
object

attributeActions.continuousLearning
attributeActions.runProcess
attributeActions.suppress
createdBy
object

createdBy.email
createdBy.firstName
createdBy.lastName
createdBy.loginName
createdTime
string

enabledMode
string

filterCriteria
object

filterCriteria.filterBased
filterCriteria.matchingType
filterCriteria.rules
matchingType
string

name
string

organizationMatchingType
string

patternActions
object

patternActions.seasonalityTimeFrame
patternActions.suppress
updatedBy
object

updatedBy.email
updatedBy.firstName
updatedBy.lastName
updatedBy.loginName
updatedTime
string

{
  "attributeActions": {
    "continuousLearning": true,
    "runProcess": {
      "learnedConfiguration": true,
      "processIds": [
        "PROCESS_9beade88-834a-4229-ab34-90380214cf74"
      ]
    },
    "suppress": {
      "learnedConfiguration": true,
      "suppressDuration": 5
    }
  },
  "createdBy": {
    "email": "opsAdmin@opsramp.com",
    "firstName": "OpsRamp API User",
    "lastName": " ",
    "loginName": "opsramp_api_user"
  },
  "createdTime": "2019-02-28T09:25:56+0000",
  "enabled": true,
  "enabledMode": "ON",
  "filterCriteria": {
    "filterBased": true,
    "matchingType": "ALL",
    "rules": [
      {
        "entityName": "resource_name",
        "entityValue": "vm",
        "filterType": "nativeAttributes",
        "operator": "Starts with"
      },
      {
        "entityName": "ip_address",
        "filterType": "nativeAttributes",
        "ipMatchingConditions": {
          "cidrNotation": "192.168.1.1/24",
          "ipAddressMatchType": "CIDR Match"
        }
      }
    ]
  },
  "id": "POLICY-AC-d53e179d-8c9b-4564-b793-dc639f6a7cf2",
  "name": "firstResponse_1",
  "patternActions": {
    "seasonalityTimeFrame": "7D",
    "suppress": {
      "seasonalAlerts": true
    }
  },
  "updatedBy": {
    "email": "opsAdmin@opsramp.com",
    "firstName": "OpsRamp API User",
    "lastName": " ",
    "loginName": "opsramp_api_user"
  },
  "updatedTime": "2019-02-28T10:14:05+0000"
}
{
  "attributeActions": {
    "suppress": {
      "learnedConfiguration": true,
      "suppressDuration": 5
    }
  },
  "clientsIncluded": "ALL",
  "createdBy": {
    "email": "helpdesk@opsramp.com",
    "firstName": "Super Admin",
    "id": "USR0000000003",
    "lastName": " ",
    "loginName": "superadmin"
  },
  "createdTime": "2020-11-05T11:29:23+0000",
  "enabled": true,
  "enabledMode": "ON",
  "filterCriteria": {
    "filterBased": true,
    "matchingType": "ALL",
    "rules": [
      {
        "entityName": "resource_name",
        "entityValue": "vm",
        "filterType": "nativeAttributes",
        "operator": "Starts with"
      }
    ]
  },
  "id": "POLICY-AC-5c75b766-6dc3-4998-bf87-81d5fbf31961",
  "name": "ml_time",
  "updatedBy": {
    "email": "helpdesk@opsramp.com",
    "firstName": "API User",
    "id": "USR0000000002",
    "lastName": " ",
    "loginName": "opsramp_api_user"
  },
  "updatedTime": "2020-11-06T14:00:18+0000"
}