Search
K
Konnect Service Catalog

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

ResourceAction

object

Contains information about a resource action

* Additional properties are NOT allowed.
idstring(uuid)required

The resource action ID.

Example:93b411db-6f68-47d2-8959-de2d91914f2f

user_idstringrequired

Represents the user who performed the action.
A null value represents that action was taken by the system.

action_typestringrequired

Represents which action was performed on a resource:

  • map: a resource was mapped to a service
  • unmap: a resource was unmapped from a service
  • archive: a resource was archived
  • restore: a resource was restored

Allowed values:mapunmaparchiverestore

causestringrequired

Represents what caused the resource action to occur:

  • user-action: user performed a resource action
  • suggestion-rule: resource action performed based on the configuration of a suggestion rule

Allowed values:user-actionsuggestion-rule

service_idstring(uuid)required

The service effected by the resource action

Example:6567bdab-9a94-4763-a736-7638b777fc04

resource_idstringrequired

The resource effected by the resource action

Example:R4bimspbBIFkYA1v

resource_namestringrequired

The name of the resource affected by the resource action

<= 255 characters

Example:Billing Service

integrationobjectrequired

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

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

Example

ResourceActionFilterParameters

object
* Additional properties are NOT allowed.
idobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
user_idOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
service_idobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
resource_idobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
resource_nameOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.instance.nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.instance.display_nameOne Of
StringFieldFilterOne Of
Filter by operatorobject

Filter using one of the following operators: eq, oeq, neq, contains, ocontains

* Additional properties are NOT allowed.
Show Child Parameters
integration.instance.idOne Of
StringFieldFilterExactobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
action_typeobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
causeobject

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
Show Child Parameters
created_atOne Of

Filters on the given datetime (RFC-3339) field value.

DateTimeFieldImplicitEqualsFilterstring(date-time)

Value strictly equals given RFC-3339 formatted timestamp in UTC

Example:2022-03-30T07:20:50Z

Example