Search
K
Konnect Service Catalog

Update API Spec

Updates the API spec for the given service.

patch

Path Parameters

serviceIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

apiSpecIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Body

application/json

UpdateCatalogServiceApiSpec

* Additional properties are NOT allowed.
namestring

The name of the API

>= 1 characters<= 120 characters

Example:Pet Store

descriptionstring | null

The description of the API

<= 2048 characters

Example:A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification

providerOne Of

Represents the provider, or source, of an API specs.
Note that provider cannot be patched for API specs that are bound to a resource.
Trying to do so will result in a 400 response.

UrlApiSpecProviderobject
Show Child Parameters

Response

application/json

A response containing a single API spec.

CatalogServiceApiSpec

idstring(uuid)required

The API spec ID

Example:eadb88fe-e8eb-45c2-9591-dc783f93f29b

service_idstring(uuid)required

The ID of the service the API spec is associated to.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The name of the API

>= 1 characters<= 120 characters

Example:Pet Store

descriptionstring | nullrequired

The description of the API.

<= 2048 characters

Example:A sample API that uses a pet store as an example to demonstrate features in the OpenAPI specification.

resource_idstring | nullrequired

The ID of the Resource that is bound to the API spec.
Only set when the given provider.type requires a 1-to-1 mapping between Resource
and API Spec.

Example:IqkHvMdyHukxcwAs

providerAny Of
required

Represents the provider, or source, of API spec contents.

UrlApiSpecProviderobject
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

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

patch/catalog-services/{serviceId}/api-specs/{apiSpecId}

Body

{ "name": "api-spec-name", "description": "API Spec Description" }
 
application/json

Delete API Spec

Deletes the API spec for the given service.

delete

Path Parameters

serviceIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

apiSpecIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

API Spec was deleted successfully.

delete/catalog-services/{serviceId}/api-specs/{apiSpecId}
 

Get an API Spec Contents

Returns the API spec for the given service.
Specify Accept: application/json to retrieve the contents as JSON.
Specify Accept: application/yaml to retrieve the contents as YAML.
Defaults to JSON format.

get

Path Parameters

serviceIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

apiSpecIdstringrequired

The id of the service.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

Response object containing raw API spec contents

ApiSpecContents

ApiSpecContentsobject

Represents raw API spec contents

* Additional properties are allowed.
get/catalog-services/{serviceId}/api-specs/{apiSpecId}/contents
 

Catalog Integrations

Integrations are applications, either Konnect-internal or external, which extend the functionality of the Service Catalog.
Install and authorize an integration to discover the resources across your organization which support your services.
Map relevant resources to your services to provide a rich view of cataloged services.
To set up and view a list of all the integrations we support please view our documentation.

Create Integration

Creates a catalog integration.

post

Body

application/json

CreateCatalogIntegration

CreateCatalogIntegration
One Of
visibilitystringrequired

Allowed values:private

resource_typesobjectrequired

Defines the resource types that the integration manages within the catalog.

This schema is a key-value object where:

  • Keys are globally unique, machine-readable identifiers for each resource type.
  • Values are objects describing metadata about the resource type.

This declaration enables the platform to understand the structure, identity, and behavior of resources discovered by the integration.
By registering resource types, integrations communicate the kinds of entities they will ingest and maintain,
allowing the catalog to enforce consistency, validation, and visibility across all integrations.

Example:{"gateway_svc":{"display_name":"Gateway Service","schema":{"type":"simple","definition":{"control_plane_id":"string","gatway_service_id":"string"}},"resource_id_template":"{{control_plane_id}}:{{gateway_service_id}}","integration_data_schema":null},"analytics_dashboard":{"display_name":"Dashboard","schema":{"type":"simple","definition":{"dashboard_id":"string"}},"resource_id_template":"{{dashboard_id}}","integration_data_schema":null}}

descriptionstringrequired

Description of the integration.

<= 2048 characters

display_namestringrequired

The display name of the integration.

>= 1 characters<= 120 characters

Example:My Integration

Response

application/json

A response containing a single integration object.

CatalogIntegration

namestringrequiredread-only

The machine name of the integration that uniquely identifies it within the catalog.

Example:gateway-manager

display_namestringrequired

The display name of the integration.

Example:Gateway Manager

descriptionstring

The description of the integration.

built_inbooleanrequiredread-only

Denotes whether the integration is built-in to the catalog.
Built-in integrations are always connected and available by default.

Example:true

versionstringrequiredread-only

The integration version.

Example:v1

visibilitystringrequired

The visibility of the integration.

Allowed values:publicprivate

Example:public

authorizationAny Of
required

Defines the authorization strategy for an integration.

Variant 1object | null
config_schemarequired

Defines the configuration schema for the integration.

Example:{"base_url":{"type":"string","display_name":"Base URL","description":"The customer-specific API URL","required":true}}

resource_typesobjectrequired

Defines the resource types that the integration manages within the catalog.

This schema is a key-value object where:

  • Keys are globally unique, machine-readable identifiers for each resource type.
  • Values are objects describing metadata about the resource type.

This declaration enables the platform to understand the structure, identity, and behavior of resources discovered by the integration.
By registering resource types, integrations communicate the kinds of entities they will ingest and maintain,
allowing the catalog to enforce consistency, validation, and visibility across all integrations.

Example:{"gateway_svc":{"display_name":"Gateway Service","schema":{"type":"simple","definition":{"control_plane_id":"string","gatway_service_id":"string"}},"resource_id_template":"{{control_plane_id}}:{{gateway_service_id}}","integration_data_schema":null},"analytics_dashboard":{"display_name":"Dashboard","schema":{"type":"simple","definition":{"dashboard_id":"string"}},"resource_id_template":"{{dashboard_id}}","integration_data_schema":null}}

discoveryobject | nullrequired

Defines how the integration participates in Discovery.
Discovery enables integrations to automatically ingest and update resources in the catalog.

Show Child Parameters
api_spec_providerobject | nullrequired

Defines how an integration behaves as a source provider of Catalog Service API specs.
API specs are entities that can be attached to Catalog Services.
When an integration implements this capability, it can act as a source type for API spec contents.
In this role, the integration becomes the source of truth for the spec.
When a spec is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the spec data.
A null value indicates the given integration does not act as a source provider of API specs.

Show Child Parameters
eventsobject | nullrequired

Defines the event types across all resource types belonging to the integration that will be ingested into the catalog.

  • Keys are the machine-readable, globally unique names of resource types registered by this integration.
  • Values are a map of event type definitions.

Example:{"gateway_svc":{"plugin_added":{"display_name":"Plugin Added","description":"Event triggered when a new plugin is added to a gateway service.","events_feed":{"enabled":true}}}}

incident_providerobject | null

Defines how an integration behaves as a source provider of Catalog Service Incidents.
Incidents are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for Incident data.
In this role, the integration becomes the source of truth for the incident data.
When an incident is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the incident data.
A null value indicates the given integration does not act as a source provider of incidents.

on_call_providerobject | null

Defines how an integration behaves as a source provider of Catalog Service On-Call schedules.
On-Call schedules are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for On-Call data.
In this role, the integration becomes the source of truth for the on-call schedule data.
When an on-call schedule is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the on-call schedule data.
A null value indicates the given integration does not act as a source provider of on-call schedules.

pull_request_providerobject | null

Defines how an integration behaves as a source provider of Catalog Service Pull Requests.
Pull Requests are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for Pull Request data.
In this role, the integration becomes the source of truth for the pull request data.
When a pull request is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the pull request data.
A null value indicates the given integration does not act as a source provider of pull requests.

workflow_providerobject | null

Defines how an integration behaves as a source provider of Catalog Service Workflows.
Workflows are entities that can be attached to Catalog Services via an integration’s Resource mapping.
When an integration implements this capability, it can act as a source type for Workflow data.
In this role, the integration becomes the source of truth for the workflow data.
When a workflow is attached to a Catalog Service using this source type, the platform relies on the external system to provide and update the workflow data.
A null value indicates the given integration does not act as a source provider of workflows.

post/integrations

Body

{ "visibility": "private", "description": "description of integration", "display_name": "Catalog Integration", "resource_types": { "service": { "display_name": "Service", "scope": "service", "schema": { "type": "simple", "definition": { "id": "string" } }, "integration_data_schema": { "type": "json_schema", "definition": { "type": "object", "properties": { "id": { "type": "string", "example": "456" } } } }, "resource_id_template": "{{id}}" } } }
 
application/json