UpdateCatalogService
objectThe machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
Optionally provide a description of the Service.
<= 2048 characters
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Labels are intended to store INTERNAL metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
CatalogServiceFilterParameters
objectFilter using one of the following operators: eq, oeq, neq
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter by custom fields using dot-notation to specify the custom field.
Filter operators are dictated by the custom field type. For example:
filter[custom_fields.owner]filter[custom_fields.owner][neq]=kongfilter[custom_fields.dashboard.link][contains]=https
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z
One OfFilters on the given datetime (RFC-3339) field value.
Value strictly equals given RFC-3339 formatted timestamp in UTC
Example:2022-03-30T07:20:50Z
CatalogService
objectThe service object contains information about a Service Catalog service.
The service ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The machine name of the Service that uniquely identifies it within the catalog.
Match pattern:^[0-9a-z.-]+$
>= 1 characters<= 120 characters
Example:user-svc
The display name of the Service.
>= 1 characters<= 120 characters
Example:User Service
Optionally provide a description of the Service.
<= 2048 characters
Map of customizable, catalog-defined fields providing information about a service.
Example:{"owner":"John Appleseed","dashboard":{"name":"On-Call Dashboard","link":"https://my-dashboard-svc.io/dashboards/1"}}
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"env":"test"}
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
CatalogIntegrationFilterParameters
objectOne OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
One OfFilter using one of the following operators: eq, oeq, neq, contains, ocontains
Show Child Parameters
CatalogIntegration
objectThe machine name of the integration that uniquely identifies it within the catalog.
Example:gateway-manager
The display name of the integration.
Example:Gateway Manager
The description of the integration.
Denotes whether the integration is built-in to the catalog.
Built-in integrations are always connected and available by default.
Example:true
The integration version.
Example:v1
The visibility of the integration.
Allowed values:publicprivate
Example:public
Any OfDefines the authorization strategy for an integration.
Defines the configuration schema for the integration.
Example:{"base_url":{"type":"string","display_name":"Base URL","description":"The customer-specific API URL","required":true}}
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"}}},"analytics_dashboard":{"display_name":"Dashboard","schema":{"type":"simple","definition":{"dashboard_id":"string"}}}}
Defines how the integration participates in Discovery.
Discovery enables integrations to automatically ingest and update resources in the catalog.
Show Child Parameters
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
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}}}}