Konnect Service Catalog

CatalogResourceRef

object

Short-hand descriptor of a catalog resource.

idstring(base64url)required

The resource ID.

>= 16 characters<= 16 characters

Example:4UdXnoaDYYJsH_Ir

namestringrequired

The name of the resource.

integrationobjectrequired

Short-hand descriptor of an integration installed within the catalog.

Show Child Parameters
typestringrequired

The resource type. Available resource types are compiled from the integrations installed within the catalog.

>= 1 characters<= 120 characters

Example:gateway_svc

configobjectrequired

JSON object representing the properties used to identify the resource in the third-party system.
The schema depends on the resource type and is dynamically registered at runtime.

Example:{"control_plane_id":"ccadfb0a-56cd-4f74-955d-aec1d87157c8","gateway_service_id":"94896d05-0c4d-45eb-aae3-de754885dd58"}

* Additional properties are allowed.
Example

ResourceIngestionStatus

object

The resource ingestion status.

* Additional properties are NOT allowed.
last_scheduledstring(date-time)required

The timestamp denoting when the last ingestion job was run.
RFC-3339 format is used with a “T” character separating date from time within the field value.
A null value denotes that ingestion for the given integration was never run.

Example

TimeValue

object

Represents a time value inclusive of units.

valuenumberrequired

Example:3.25

unitstringrequired

Allowed values:millisecondssecondsminuteshoursdaysmonthsyears

Example:hours

Example

IntegrationNotInstalledError

object
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.

Example:404

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.

Example:Not Found

typestringrequiredread-only

The error type.

Allowed values:service_catalog_integration_not_installed

Example:https://httpstatuses.com/404

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.

Example:kong:trace:1234567890

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.

Example:Not found

Example

IntegrationUnauthorizedError

object
typestringrequired

Allowed values:service_catalog_integration_unauthorized

statusintegerrequired

Allowed values:400

titlestringrequired

Example:Invalid Request

instancestringrequired

The Konnect trace ID.

Example:konnect:trace:3674017986744198214

detailstringrequired

Example:The integration instance "cc461d8c-dade-4ce0-ad86-290f3ff8de1a" is unauthorized

invalid_parametersOne Of
arrayrequiredunique-items

invalid parameters

>= 1 items

InvalidParameterStandardobject
* Additional properties are NOT allowed.
Show Child Parameters
Example