Search
K
Konnect Service Catalog

List Resource Actions

Returns a paginated collection of a resource actions.

get

Query Parameters

pageobject

Determines which page of the collection to retrieve.

Show Child Parameters
filterobject

Filters a collection of resource actions.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

A paginated list response for a collection of resource actions.

* Additional properties are NOT allowed.
metaobjectrequired

Pagination metadata.

Show Child Parameters
dataarray[object]required

Contains information about a resource action

* Additional properties are NOT allowed.
Show Child Parameters
get/resource-actions
 
application/json

Integration Instance Proxy

The integration instance proxy allows requests to be made to the authorized integration instance.
The APIs which are allowed to be proxied to the integration instances are defined in the proxies section of the Integration.

Integration Instance Proxy Request

Proxies a request to an external API for the integration instance.

post

Path Parameters

integrationInstancestringrequired

The id of the integration instance.

Example:3321067c-407f-417b-8aac-cd2c5ec92d85

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

Error response indicating the proxy request could not be sent due to invalid state of the request body or integration instance

Any Of
statusintegerrequiredread-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_parametersOne Of
arrayrequiredunique-items

invalid parameters

>= 1 items

InvalidParameterStandardobject
* Additional properties are NOT allowed.
Show Child Parameters
post/integration-instances/{integrationInstance}/proxy

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

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
 
application/json