Integration Instance Proxy Request
Proxies a request to an external API for the integration instance.
Path Parameters
The id of the integration instance.
Example:3321067c-407f-417b-8aac-cd2c5ec92d85
Body
application/json
Body
Request body schema for an integration instance proxy request.
The HTTP request method.
Allowed values:DELETEGETPATCHPOSTPUT
Example:GET
The base URL of the proxied API as defined in the integration manifest.
Example:https://api.pagerduty.com
The URL path of the proxied API request as defined in the integration manifest.
Example:/incidents
JSON object representing the request body that will be sent to the proxied API.
Example:{"name":"Foo"}
JSON object representing the query parameters that will be sent to the proxied API.
Example:{"limit":5,"offset":10}
JSON object representing the request headers that will be sent to the proxied API.
Example:{"content-type":"application/json"}
Response
application/problem+json
Response
Error response indicating the proxy request could not be sent due to invalid state of the request body or integration instance
Any OfThe HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.
A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.
The error type.
Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.
A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.
One Ofinvalid parameters
>= 1 items
Show Child Parameters
Authentication
Path Parameters
Body
Suggestion Rules
Suggestion rules allow for automated management of resources.
Suggestion rule can be configured to:
- Map resources to existing catalog service
- Map resources to a new catalog service
- Archive resources
System suggestion rules are built-in rules which are configured and managed by Kong.
List System Suggestion Rules
Returns a paginated collection of a system defined suggestion rules.
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
Path Parameters
Machine name of the integration.
Example:gateway-manager
Response
application/json
Response
A paginated list response for a collection of system defined suggestion rules.
returns the pagination information
Show Child Parameters
Contains information about the system defined suggestion rule.
Show Child Parameters
Authentication
Path Parameters
Query Parameters
Create Suggestion Rule
Creates a suggestion rule for the given integration.
Path Parameters
Machine name of the integration.
Example:gateway-manager
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
List Suggestion Rules
Returns a paginated collection of a suggestion rules.
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 rules.
Show Child Parameters
Path Parameters
Machine name of the integration.
Example:gateway-manager
Response
application/json
Response
A paginated list response for a collection of suggestion rules.
returns the pagination information
Show Child Parameters
Contains information about the suggestion rule.