integrationstringrequired
Machine name of the integration.
Example:gateway-manager
Test a Suggestion Rule Configuration
Test suggestion rule configuration against an integration record.
post
Path Parameters
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.
List Suggestion Rule Errors
Returns a paginated collection of suggestion rule errors.
get
Query Parameters
page[size]integer
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
page[number]integer
Determines which page of the entities to retrieve.
Example:1
filterobject
Filters a collection of suggestion rule errors.
* Additional properties are NOT allowed.
Show Child Parameters
Response
application/json
Response
application/json
A paginated list response for a collection of suggestion rule errors.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarrayrequired
Represents any errors which occured when evaluating a suggestion rule
Show Child Parameters
get/suggestion-rule-errors
Authentication
Query Parameters
application/json
Integration Events
Integration events represent the activity within an integration instance.
List Integration Events
Returns a paginated collection of integration events.
get
Query Parameters
pageobject
Determines which page of the collection to retrieve.
Show Child Parameters
filterobject
Filters a collection of integration events.
* Additional properties are NOT allowed.
sortstring
The asc suffix is optional as the default sort order is ascending.
The desc suffix is used to specify a descending order.
Multiple sort attributes may be provided via a comma separated list.
JSONPath notation may be used to specify a sub-attribute (eg: ‘foo.bar desc’).
Example:created_at desc
Response
application/json
Response
application/json
A Paginated list response for a collection of integration events.
* Additional properties are NOT allowed.
metaobjectrequired
Pagination metadata.
Show Child Parameters
dataarray[object]required
Event on a resource binding for an integration.
* Additional properties are NOT allowed.
Show Child Parameters
get/integration-events
Authentication
Query Parameters
application/json