Search
K
Konnect Service Catalog

CreateCatalogResourceMappingResourceByConfig

object
* Additional properties are NOT allowed.
integration_instancestringrequired

The id or name of the integration instance the resource belongs to.

Example:aws-lambda-prod

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

CatalogResourceMappingFilterParameters

object
resource.idOne Of
StringFieldFilterExactobject

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

* Additional properties are NOT allowed.
Show Child Parameters
resource.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
resource.typeOne 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
resource.configOne Of
CatalogResourceConfigFieldFilterobject

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

* Additional properties are NOT allowed.
Show Child Parameters
resource.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
resource.integration.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
resource.integration.instance.idOne Of
UuidFieldFilterobject

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

* Additional properties are NOT allowed.
Show Child Parameters
resource.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
resource.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
service.idOne Of
StringFieldFilterExactobject

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

* Additional properties are NOT allowed.
Show Child Parameters
service.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
service.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
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

CatalogResourceMapping

object

Describes a mapping between a catalog resource and a service.

idstring(uuid)required

The resource mapping ID.

Example:d277faad-ed4e-4c56-a0fb-acce065dee34

resourceobjectrequired

Short-hand descriptor of a catalog resource.

Show Child Parameters
serviceobjectrequired

Short-hand descriptor of a catalog service.

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

CriteriaTemplateFilterParameters

object
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
display_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
installedboolean

Filter by a boolean value (true/false).

integration_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
Example

CriteriaTemplate

object

Representation of a criteria template.

namestringrequired

Reference to the unique name of the criteria template.

Example:time_to_merge

display_namestringrequired

The human-readable display name of the template.

categorystringrequired

Categorical tag for the functionality the template relates to.

Allowed values:Source Code ManagementIncident ManagementObservabilityCode QualityIssue TrackingCommunicationsFeature ManagementSecurity / VulnerabilityDocumentationCatalog ManagementGateway Configuration

Example:Source Code Management

template_stringstringrequired

Liquid template string used to render the criteria interpolated by parameters.

integration_namestringrequired

The catalog integration who registered the given criteria template.
This will be null when a template is always available independent of connected integrations.

installedbooleanrequired

Whether the template is available given the current state of the catalog.
For example, this will be false when the template is provided by an integrastion
that is not currently connected.

schemaAny Of
required
EmptySchemaobject
required_integration_capabilitystringrequired

Required capability from connected integrations to use this criteria template.
Applicable for templates that are not provided by a given integration (functional
across integrations).

Allowed values:on_call_providerincident_providerpull_request_providerworkflow_provider

Example