Kong Catalog Services API
Create and maintain a centralized catalog of all services running in your organization.Add custom fields and map resources from across your organization to provide a 360-degree overview of your services.Custom fields allow you to surface key information such as:- `Owner`: The person or team responsible for the service- `Product Manager`: The person assigned to guide the service's direction for customer success- `Jira Project`: The Jira project which represents past, present and future work for the serviceResources are discovered from the integrations you use within your organization to create, operate and manage your services.Mapping the resources relevant to your service will provide a rich view of the service's communication channels, dependencies and more.Types of resources which you can map to a service include:- `Code Repositories:` The software project(s) that make up the service- `Monitors and Dashboards:` Tools providing visibility into the health and performance of the service- `Communication Channels`: Virtual spaces where questions and concerns can be raised about the service- `Incident Management Resources`: Alerts setup within your incident management platform to notify individuals regarding issues with the service
Kong Catalog Services API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Catalog Services. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.
This API exposes 5 operations across 2 paths, and defines 35 schemas. It is described by OpenAPI 3.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Kong Catalog Services API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Kong-Admin-Token (adminToken).
By default, every request must be authenticated.
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Create and maintain a centralized catalog of all services running in your organization. Add custom fields and map resources from across your organization to provide a 360-degree o…
Schemas 35
The contract defines 35 schemas that model the data the API accepts and returns. The most detailed are CatalogService (8 properties), CatalogServiceFilterParameters (7 properties), InvalidParameterMinimumLength (5 properties), InvalidParameterMaximumLength (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kong 12
Other APIs Kong publishes across the network.