integrationInstancestringrequired
The id of the integration instance.
Example:3321067c-407f-417b-8aac-cd2c5ec92d85
Integration Instance Proxy Request
Proxies a request to an external API for the integration instance.
post
Path Parameters
Body
application/json
Body
application/json
Request body schema for an integration instance proxy request.
* Additional properties are NOT allowed.
methodstringrequired
The HTTP request method.
Allowed values:DELETEGETPATCHPOSTPUT
Example:GET
base_urlstring(uri)required
The base URL of the proxied API as defined in the integration manifest.
Example:https://api.pagerduty.com
pathstringrequired
The URL path of the proxied API request as defined in the integration manifest.
Example:/incidents
bodyobject
JSON object representing the request body that will be sent to the proxied API.
Example:{"name":"Foo"}
* Additional properties are allowed.
queryobject
JSON object representing the query parameters that will be sent to the proxied API.
Example:{"limit":5,"offset":10}
* Additional properties are allowed.
headersobject
JSON object representing the request headers that will be sent to the proxied API.
Example:{"content-type":"application/json"}
* Additional properties are allowed.
Response
application/problem+json
Response
application/problem+json
Error response indicating the proxy request could not be sent due to invalid state of the request body or integration instance
Any Ofstatusintegerrequiredread-only
The 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.
titlestringrequiredread-only
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.
typestringread-only
The error type.
instancestringrequiredread-only
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.
detailstringrequiredread-only
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.
invalid_parameters
One Ofarrayrequiredunique-items
invalid parameters
>= 1 items
InvalidParameterStandardobject
* Additional properties are NOT allowed.
Show Child Parameters
post/integration-instances/{integrationInstance}/proxy
Authentication
Path Parameters
Body
{
"method": "GET",
"base_url": "https://api.pagerduty.com",
"path": "/incidents"
}
application/problem+json
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.
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
Path Parameters
integrationstringrequired
Machine name of the integration.
Example:gateway-manager
Response
application/json
Response
application/json
A paginated list response for a collection of system defined suggestion rules.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarrayrequired
Contains information about the system defined suggestion rule.
Show Child Parameters
get/integrations/{integration}/system-suggestion-rules
Authentication
Path Parameters
Query Parameters
application/json
Create Suggestion Rule
Creates a suggestion rule for the given integration.
post
Path Parameters
integrationstringrequired
Machine name of the integration.
Example:gateway-manager
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:"])
post/integrations/{integration}/suggestion-rules
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
List Suggestion Rules
Returns a paginated collection of a suggestion rules.
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 rules.
* Additional properties are NOT allowed.
Show Child Parameters
Path Parameters
integrationstringrequired
Machine name of the integration.
Example:gateway-manager
Response
application/json
Response
application/json
A paginated list response for a collection of suggestion rules.
* Additional properties are NOT allowed.
metaobjectrequired
returns the pagination information
Show Child Parameters
dataarrayrequired
Contains information about the suggestion rule.
Show Child Parameters
get/integrations/{integration}/suggestion-rules
Authentication
Path Parameters
Query Parameters
application/json