SearchResultItem

object

Item included in the list of search results.

idstringrequired

Unique identifier for the record.

typestringrequired

Konnect entity type.

namestringrequired

Name of the entity.

descriptionstring

Description of the entity.

labelsobject

Labels for the entity.

relationsobject

Relations for the entity.

attributesobject

Attributes for the entity.

matchstring

The matched text from the record.

relations_listarray[object]

The relations tree with child and sibling relations.

Show Child Parameters
Example

Relation

object
typestringrequired

The type of the related entity.

idstringrequired

The unique identifier of the related entity.

child_relationsarray[object]required

The child relations of the related entity.

Show Child Parameters
Example

Error

object

standard error

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.

Example

InvalidRules

string

invalid parameters rules

Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype

InvalidParameterStandard

object
* Additional properties are NOT allowed.
fieldstringrequiredread-only

Example:name

rulestringread-only

invalid parameters rules

Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype

sourcestring

Example:body

reasonstringrequiredread-only

Example:is a required field

Example