Update Suggestion Rule
Updates the given suggestion rule.
Path Parameters
Machine name of the integration.
Example:gateway-manager
ID of the suggestion rule.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
Body
application/json
Body
Request body schema for creating a suggestion rule for an integration.
SuggestionRulePayload
Payload to create a suggestion rule for an integration.
The display name of the suggestion rule
>= 1 characters<= 120 characters
The description of the suggestion rule
Default:null
>= 1 characters<= 2048 characters
Example:Suggestion rule description
The integration binding object name
Example:pagerduty_service
Determines if this suggestion rule should be evaluated when generating suggested actions.
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
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:"])
One OfShow Child Parameters
One OfDetermines 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.
Show Child Parameters
Response
application/json
Response
A response containg a suggestion rule object.
SuggestionRule
Contains information about the suggestion rule.
The suggestion rule ID.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
The display name of the suggestion rule.
>= 1 characters<= 120 characters
The description of the suggestion rule
Default:null
>= 1 characters<= 2048 characters
Example:Suggestion rule description
The integration binding object name
Example:pagerduty_service
Determines if this suggestion rule should be evaluated when generating suggested actions.
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
One OfThe action configuration for this system suggestion rule.
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
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:"])
Authentication
Path Parameters
Body
Delete Suggestion Rule
Deletes the given suggestion rule.
Path Parameters
Machine name of the integration.
Example:gateway-manager
ID of the suggestion rule.
Example:22f72bd1-2897-473e-9471-302de3ccf38b
Response
Response
No Content
Authentication
Path Parameters
Test a Suggestion Rule Configuration
Test suggestion rule configuration against an integration record.
Path Parameters
Machine name of the integration.
Example:gateway-manager
Body
application/json
Body
Request body schema for testing a suggestion rule configuration against an integration data.
TestSuggestionRulePayload
Payload to test suggestion rule configuration against an integration record.
The integration binding object name
Example:pagerduty_service
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:"])
One OfShow Child Parameters
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"}}
Response
application/json
Response
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.
Evaluation result of suggesetion rule configuration against given integration record.
Show Child Parameters
List of errors that occured when evaluating suggestion rule configuration against given integration record.
Show Child Parameters
Authentication
Path Parameters
Body
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.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filters a collection of suggestion rule errors.
Show Child Parameters
Response
application/json
Response
A paginated list response for a collection of suggestion rule errors.
returns the pagination information
Show Child Parameters
Represents any errors which occured when evaluating a suggestion rule