Search
K
Konnect Service Catalog

RankAfterPayload

object

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.
after_suggestion_rule_idstring(uuid)required

When set to null, this rule is indicated to be the highest priority rule.

Example

RankBeforePayload

object

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.
before_suggestion_rule_idstring(uuid)required

When set to null, this rule is indicated to be the lowest priority rule.

Example

SystemSuggestionRule

Contains information about the system defined 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

descriptionstringrequired

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 automatically
  • false: Suggested action will not be automatically applied, user input required
actionobjectrequired

The action configuration for this system suggestion rule.

Show Child Parameters
Example

SuggestionRulePayload

object

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

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 automatically
  • false: 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:"])

actionOne Of
required
ArchiveActionPayloadobject
* Additional properties are NOT allowed.
Show Child Parameters
rankOne Of
RankAfterPayloadobject

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
Example

TestSuggestionRulePayload

object

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:"])

actionOne Of
required
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.
Example