integrationstringrequired
Machine name of the integration.
Example:gateway-manager
suggestionRuleIdstring(uuid)required
ID of the suggestion rule.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
Get a Suggestion Rule
Returns information about a suggestion rule from a given suggestion rule ID.
get
Path Parameters
Response
application/json
Response
application/json
A response containg a suggestion rule object.
SuggestionRule
Contains information about the suggestion rule.
idstring(uuid)requiredread-only
The suggestion rule ID.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
namestringrequired
The display name of the suggestion rule.
>= 1 characters<= 120 characters
descriptionstring | nullrequired
The description of the suggestion rule
Default:null
>= 1 characters<= 2048 characters
Example:Suggestion rule description
bindingstringrequired
The integration binding object name
Example:pagerduty_service
activebooleanrequired
Determines if this suggestion rule should be evaluated when generating suggested actions.
auto_acceptbooleanrequired
Determines if the suggested action should be applied automatically.
true: Suggested action will be applied automaticallyfalse: Suggested action will not be automatically applied, user input required
action
One Ofrequired
ArchiveActionPayloadobject
The action configuration for this system suggestion rule.
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
discovery_selectorstringrequired
A boolean string or JQ expression that must evaluate to a boolean value.
Supports JQ expressions syntax on discovered entity’s integration_record property.
Example:.gateway_service.tags | contains(["_KonnectDeployment:"])
get/integrations/{integration}/suggestion-rules/{suggestionRuleId}
Authentication
Path Parameters
application/json
Update Suggestion Rule
Updates the given suggestion rule.
put
Path Parameters
integrationstringrequired
Machine name of the integration.
Example:gateway-manager
suggestionRuleIdstring(uuid)required
ID of the suggestion rule.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
Body
application/json
Body
application/json
Request body schema for creating a suggestion rule for an integration.
SuggestionRulePayload
Payload to create a suggestion rule for an integration.
* Additional properties are NOT allowed.
namestringrequired
The display name of the suggestion rule
>= 1 characters<= 120 characters
descriptionstring | null
The description of the suggestion rule
Default:null
>= 1 characters<= 2048 characters
Example:Suggestion rule description
bindingstringrequired
The integration binding object name
Example:pagerduty_service
activebooleanrequired
Determines if this suggestion rule should be evaluated when generating suggested actions.
auto_acceptbooleanrequired
Determines if the suggested action should be applied automatically.
true: Suggested action will be applied automaticallyfalse: Suggested action will not be automatically applied, user input required
discovery_selectorstringrequired
A boolean string or JQ expression that must evaluate to a boolean value.
Supports JQ expressions syntax on discovered entity’s integration_record property.
<= 2048 characters
Example:.gateway_service.tags | contains(["_KonnectDeployment:"])
action
One Ofrequired
ArchiveActionPayloadobject
* Additional properties are NOT allowed.
Show Child Parameters
rank
One OfRankAfterPayloadobject
Determines how this suggestion rule ranks against existing suggestion rules for the integration.
When rank is not specified, this suggestion rule will placed as the lowest priority rule.
* Additional properties are NOT allowed.
Show Child Parameters
Response
application/json
Response
application/json
A response containg a suggestion rule object.
SuggestionRule
Contains information about the suggestion rule.
idstring(uuid)requiredread-only
The suggestion rule ID.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
namestringrequired
The display name of the suggestion rule.
>= 1 characters<= 120 characters
descriptionstring | nullrequired
The description of the suggestion rule
Default:null
>= 1 characters<= 2048 characters
Example:Suggestion rule description
bindingstringrequired
The integration binding object name
Example:pagerduty_service
activebooleanrequired
Determines if this suggestion rule should be evaluated when generating suggested actions.
auto_acceptbooleanrequired
Determines if the suggested action should be applied automatically.
true: Suggested action will be applied automaticallyfalse: Suggested action will not be automatically applied, user input required
action
One Ofrequired
ArchiveActionPayloadobject
The action configuration for this system suggestion rule.
* Additional properties are NOT allowed.
Show Child Parameters
created_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
updated_atstring(date-time)requiredread-only
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
discovery_selectorstringrequired
A boolean string or JQ expression that must evaluate to a boolean value.
Supports JQ expressions syntax on discovered entity’s integration_record property.
Example:.gateway_service.tags | contains(["_KonnectDeployment:"])
put/integrations/{integration}/suggestion-rules/{suggestionRuleId}
Authentication
Path Parameters
Body
{
"name": "sample-datadog-monitors",
"description": "Rule to map all sample monitors to the sample service. Matches any monitor that satisfies one of the following:\n- monitor is tagged with a value with the prefix \"service:sample\" (ex:\"service:sample\", \"service:sample-gateway-manager-app\")",
"auto_accept": true,
"active": true,
"binding": "datadog_monitor",
"discovery_selector": "| any(.tags[]; startswith(\"service:sample\"))",
"action": {
"type": "map",
"data": {
"service": {
"name": "sample"
},
"resource": {
"labels": {}
}
}
}
}
application/json
Delete Suggestion Rule
Deletes the given suggestion rule.
delete
Path Parameters
integrationstringrequired
Machine name of the integration.
Example:gateway-manager
suggestionRuleIdstring(uuid)required
ID of the suggestion rule.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
Response
Response
No Content
delete/integrations/{integration}/suggestion-rules/{suggestionRuleId}
Authentication
Path Parameters
Test a Suggestion Rule Configuration
Test suggestion rule configuration against an integration record.
post
Path Parameters
integrationstringrequired
Machine name of the integration.
Example:gateway-manager
Body
application/json
Body
application/json
Request body schema for testing a suggestion rule configuration against an integration data.
TestSuggestionRulePayload
Payload to test suggestion rule configuration against an integration record.
* Additional properties are NOT allowed.
bindingstringrequired
The integration binding object name
Example:pagerduty_service
discovery_selectorstringrequired
A boolean string or JQ expression that must evaluate to a boolean value.
Supports JQ expressions syntax on discovered entity’s integration_record property.
<= 2048 characters
Example:.gateway_service.tags | contains(["_KonnectDeployment:"])
action
One Ofrequired
ArchiveActionPayloadobject
* Additional properties are NOT allowed.
Show Child Parameters
integration_recordobjectrequired
JSON object that may contain additional context about the entity.
Example:{"control_plane":{"id":"0a7647d1-483a-4817-a5ac-28937b511563","name":"control_plane_name"},"gateway_service":{"id":"3fd1bff6-b60d-4c22-bb74-e4cac63196fb","name":"gateway_service_name"}}
* Additional properties are allowed.
Response
application/json
Response
application/json
A response containing the evaluation of a suggestion rule configuration against an integration data.
TestSuggestionRule
Contains evaluation results of a suggestion rule configuration against an integration record.
* Additional properties are NOT allowed.
evaluationobjectrequired
Evaluation result of suggesetion rule configuration against given integration record.
* Additional properties are NOT allowed.
Show Child Parameters
errorsarray[object]required
List of errors that occured when evaluating suggestion rule configuration against given integration record.
Show Child Parameters
post/integrations/{integration}/suggestion-rules/test
Authentication
Path Parameters
Body
{
"binding": "datadog_monitor",
"discovery_selector": "| any(.tags[]; startswith(\"service:sample\"))",
"action": {
"type": "map",
"data": {
"service": {
"name": "sample"
},
"resource": {
"labels": {}
}
}
},
"integration_record": {
"name": "sample-monitor",
"description": "A sample monitor",
"tags": [
"service:sample"
]
}
}
application/json
Suggestion Rule Errors
Suggestion rule errors describes errors which have occured when a suggestion rule was evaluated on a resource.
An error may occur due to syntax errors on the configured suggestion rule, or various other runtime errors.