Create Ingestion Policy
Create a specific ingestion policy
Request
URI
POST
https://{api_host}/api/v2/usage/ingestionpolicy
COPY
Request Body
IngestionPolicyWriteModel of type(s) application/json
Optional
{
"alert": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": false,
"lastEventTime": 0,
"conditionsThresholdOperator": "string",
"hidden": false,
"severity": "string",
"minutes": 0,
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": false,
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": 0,
"endTime": 0,
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": 0,
"hosts": [
"string"
],
"summarizedEvents": 0,
"alertTags": [
"string"
],
"isUserEvent": false,
"isEphemeral": false,
"creatorId": "string",
"updaterId": "string",
"updatedAt": 0,
"runningState": "string",
"canDelete": false,
"canClose": false,
"creatorType": [
"string"
]
},
"orphan": false,
"deleted": false,
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": 0,
"processRateMinutes": 0,
"createUserId": "string",
"updated": 0,
"updateUserId": "string",
"queryFailing": false,
"lastFailedTime": 0,
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": false,
"lastProcessedMillis": 0,
"pointsScannedAtLastQuery": 0,
"includeObsoleteMetrics": false,
"lastQueryTime": 0,
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": false,
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": false,
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": false,
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": false,
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": 0,
"snoozed": 0,
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"querySyntaxError": false,
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"notificants": [
"string"
],
"lastNotificationMillis": 0,
"notificationResendFrequencyMinutes": 0,
"alertsLastDay": 0,
"alertsLastWeek": 0,
"alertsLastMonth": 0,
"numPointsInFailureFrame": 0,
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": 0,
"endTime": 0,
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": 0,
"hosts": [
"string"
],
"summarizedEvents": 0,
"alertTags": [
"string"
],
"isUserEvent": false,
"isEphemeral": false,
"creatorId": "string",
"updaterId": "string",
"updatedAt": 0,
"runningState": "string",
"canDelete": false,
"canClose": false,
"creatorType": [
"string"
]
},
"systemAlertVersion": 0,
"alertType": "string",
"evaluateRealtimeData": false,
"secureMetricDetails": false,
"enablePDIncidentBySeries": false,
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": 0,
"fixedLegendEnabled": false,
"fixedLegendUseRawStats": false,
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": 0,
"showHosts": false,
"showLabels": false,
"showRawValues": false,
"showValueColumn": false,
"autoColumnTags": false,
"columnTags": "string",
"tagMode": "string",
"numTags": 0,
"groupBySource": false,
"sortValuesDescending": false,
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": false,
"y1ScaleSIBy1024": false,
"y0UnitAutoscaling": false,
"y1UnitAutoscaling": false,
"invertDynamicLegendHoverControl": false,
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": false,
"fixedLegendShowMetricName": false,
"fixedLegendFilterLimit": 0,
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": false,
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": false,
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
0
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": 0,
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": 0,
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": 0,
"alertChartDescription": "string"
},
"accounts": [
"string"
],
"groups": [
"string"
],
"name": "string",
"id": "string",
"description": "string",
"scope": "string",
"sources": [
"string"
],
"alertId": "string",
"isLimited": false,
"limitPPS": 0,
"namespaces": [
"string"
],
"pointTags": [
{
"key": "string",
"value": "string"
}
],
"tagsAnded": false,
"lastUpdatedMs": 0,
"lastUpdatedAccountId": "string",
"customer": "string"
}array of string
accounts
Optional
The accounts associated with the ingestion policy
array of string
groups
Optional
The groups associated with the ingestion policy
string
name
Optional
The name of the ingestion policy
string
id
Optional
The unique ID for the ingestion policy
string
description
Optional
The description of the ingestion policy
string
scope
Optional
The scope of the ingestion policy
Possible values are : ACCOUNT, GROUP, NAMESPACE, SOURCE, TAGS,
array of string
sources
Optional
The sources associated with the ingestion policy
string
alertId
Optional
The ingestion policy alert Id
boolean
isLimited
Optional
Whether the ingestion policy is limited
integer As int32 As int32
limitPPS
Optional
The PPS limit of the ingestion policy
array of string
namespaces
Optional
The namespaces associated with the ingestion policy
boolean
tagsAnded
Optional
Whether tags should be AND-ed or OR-ed.If true, a metric must contain all tags in order for the ingestion policy to apply. If false, the tags are OR-ed, and a metric must contain one of the tags. Default: false
integer As int64 As int64
lastUpdatedMs
Optional
The last time when the ingestion policy is updated, in epoch milliseconds
string
lastUpdatedAccountId
Optional
The account that updated this ingestion policy last time
string
customer
Optional
ID of the customer to which the ingestion policy belongs
Responses
200
successful operation
Returns ResponseContainerIngestionPolicyReadModel of type(s) application/json
{
"status": {
"result": "string",
"message": "string",
"code": 0
},
"response": {
"accounts": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"groups": [
{
"name": "string",
"id": "string",
"description": "string"
}
],
"metadata": {
"usageInBillingPeriod": 0,
"customer": "string",
"ingestionPolicyId": "string"
},
"name": "string",
"id": "string",
"description": "string",
"scope": "string",
"alert": {
"tagpaths": [
"string"
],
"targetEndpoints": [
"string"
],
"modifyAclAccess": false,
"lastEventTime": 0,
"hidden": false,
"severity": "string",
"minutes": 0,
"name": "string",
"id": "string",
"target": "string",
"application": [
"string"
],
"service": [
"string"
],
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"targetInfo": [
{
"method": "string",
"id": "string",
"name": "string"
}
],
"systemOwned": false,
"tags": {
"customerTags": [
"string"
]
},
"status": [
"string"
],
"event": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": 0,
"endTime": 0,
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": 0,
"hosts": [
"string"
],
"summarizedEvents": 0,
"alertTags": [
"string"
],
"isUserEvent": false,
"isEphemeral": false,
"creatorId": "string",
"updaterId": "string",
"updatedAt": 0,
"runningState": "string",
"canDelete": false,
"canClose": false,
"creatorType": [
"string"
]
},
"orphan": false,
"deleted": false,
"acl": {
"canView": [
"string"
],
"canModify": [
"string"
]
},
"created": 0,
"processRateMinutes": 0,
"createUserId": "string",
"updated": 0,
"updateUserId": "string",
"queryFailing": false,
"lastFailedTime": 0,
"lastErrorMessage": "string",
"additionalInformation": "string",
"metricsUsed": [
"string"
],
"hostsUsed": [
"string"
],
"inTrash": false,
"lastProcessedMillis": 0,
"pointsScannedAtLastQuery": 0,
"includeObsoleteMetrics": false,
"lastQueryTime": 0,
"condition": "string",
"conditionQueryType": "string",
"conditionQBEnabled": false,
"conditionQBSerialization": "string",
"displayExpression": "string",
"displayExpressionQueryType": "string",
"displayExpressionQBEnabled": false,
"creatorId": "string",
"updaterId": "string",
"displayExpressionQBSerialization": "string",
"alertSources": [
{
"hidden": false,
"color": "string",
"name": "string",
"query": "string",
"description": "string",
"queryType": "string",
"queryBuilderEnabled": false,
"queryBuilderSerialization": "string",
"alertSourceType": [
"string"
]
}
],
"resolveAfterMinutes": 0,
"snoozed": 0,
"failingHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"querySyntaxError": false,
"runbookLinks": [
"string"
],
"triageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"alertTriageDashboards": [
{
"dashboardId": "string",
"description": "string"
}
],
"inMaintenanceHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"activeMaintenanceWindows": [
"string"
],
"prefiringHostLabelPairs": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"notificants": [
"string"
],
"lastNotificationMillis": 0,
"notificationResendFrequencyMinutes": 0,
"alertsLastDay": 0,
"alertsLastWeek": 0,
"alertsLastMonth": 0,
"numPointsInFailureFrame": 0,
"noDataEvent": {
"computedHlps": [
{
"severity": "string",
"host": "string",
"startTime": 0,
"label": "string",
"observed": 0,
"firing": 0
}
],
"table": "string",
"name": "string",
"id": "string",
"startTime": 0,
"endTime": 0,
"createdEpochMillis": 0,
"updatedEpochMillis": 0,
"tags": [
"string"
],
"metricsUsed": [
"string"
],
"createdAt": 0,
"hosts": [
"string"
],
"summarizedEvents": 0,
"alertTags": [
"string"
],
"isUserEvent": false,
"isEphemeral": false,
"creatorId": "string",
"updaterId": "string",
"updatedAt": 0,
"runningState": "string",
"canDelete": false,
"canClose": false,
"creatorType": [
"string"
]
},
"systemAlertVersion": 0,
"alertType": "string",
"evaluateRealtimeData": false,
"secureMetricDetails": false,
"enablePDIncidentBySeries": false,
"chartSettings": {
"type": "string",
"min": "number",
"max": "number",
"customTags": [
"string"
],
"expectedDataSpacing": 0,
"fixedLegendEnabled": false,
"fixedLegendUseRawStats": false,
"plainMarkdownContent": "string",
"lineType": "string",
"stackType": "string",
"windowing": "string",
"windowSize": 0,
"showHosts": false,
"showLabels": false,
"showRawValues": false,
"showValueColumn": false,
"autoColumnTags": false,
"columnTags": "string",
"tagMode": "string",
"numTags": 0,
"groupBySource": false,
"sortValuesDescending": false,
"defaultSortColumn": "string",
"y1Max": "number",
"y1Min": "number",
"y1Units": "string",
"y0ScaleSIBy1024": false,
"y1ScaleSIBy1024": false,
"y0UnitAutoscaling": false,
"y1UnitAutoscaling": false,
"invertDynamicLegendHoverControl": false,
"fixedLegendPosition": "string",
"fixedLegendDisplayStats": [
"string"
],
"fixedLegendFilterSort": "string",
"fixedLegendShowSourceName": false,
"fixedLegendShowMetricName": false,
"fixedLegendFilterLimit": 0,
"fixedLegendFilterField": "string",
"fixedLegendHideLabel": false,
"xmax": "number",
"xmin": "number",
"ymax": "number",
"ymin": "number",
"timeBasedColoring": false,
"sparklineDisplayValueType": "string",
"sparklineDisplayColor": "string",
"sparklineDisplayVerticalPosition": "string",
"sparklineDisplayHorizontalPosition": "string",
"sparklineDisplayFontSize": "string",
"sparklineDisplayPrefix": "string",
"sparklineDisplayPostfix": "string",
"sparklineSize": "string",
"sparklineLineColor": "string",
"sparklineFillColor": "string",
"sparklineValueColorMapColors": [
"string"
],
"sparklineValueColorMapValuesV2": [
"number"
],
"sparklineValueColorMapValues": [
0
],
"sparklineValueColorMapApplyTo": "string",
"sparklineDecimalPrecision": 0,
"sparklineValueTextMapText": [
"string"
],
"sparklineValueTextMapThresholds": [
"number"
],
"chartDefaultColor": "string",
"logsTable": {
"columns": [
"string"
]
}
},
"ingestionPolicyId": "string",
"failingHostLabelPairLinks": [
"string"
],
"sortAttr": 0,
"severityList": [
"string"
],
"alertChartUnits": "string",
"alertChartBase": 0,
"alertChartDescription": "string"
},
"lastUpdatedMs": 0,
"lastUpdatedAccountId": "string",
"customer": "string",
"sources": [
"string"
],
"alertId": "string",
"isLimited": false,
"limitPPS": 0,
"namespaces": [
"string"
],
"pointTags": [
{
"key": "string",
"value": "string"
}
],
"tagsAnded": false
}
}