How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

5 operations 2 paths 35 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Catalog Services API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

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.

Catalog Services 5

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…

POST
/v1/catalog-services
Create Service
create-catalog-service body → 201400401403
GET
/v1/catalog-services
List Services
list-catalog-services 4 params → 200400401403
GET
/v1/catalog-services/{id}
Get a Service
fetch-catalog-service 1 param → 200401403404
PATCH
/v1/catalog-services/{id}
Update Service
update-catalog-service 1 param body → 200400401403404409
DELETE
/v1/catalog-services/{id}
Delete Service
delete-catalog-service 1 param → 204401403404

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), InvalidParameterChoiceItem (5 properties), InvalidParameterDependentItem (5 properties). Each schema is shown below with its type and property counts.

BadRequestError
BaseError
object
standard error
5 properties 4 required
InvalidParameterMinimumLength
object
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
PaginatedMeta
object
returns the pagination information
1 property 1 required
BooleanCustomField
boolean
UnauthorizedError
CatalogService
object
The service object contains information about a Service Catalog service.
8 properties 8 required
NotFoundError
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
LabelsFieldFilter
UrlCustomField
object
2 properties 2 required
LabelsUpdate
object
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 me…
NumericFieldFilter
Filter by a numeric value.
InvalidParameterMaximumLength
object
5 properties 4 required
InvalidParameterStandard
object
4 properties 2 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
TextCustomField
string
BooleanFieldFilter
boolean
Filter by a boolean value (true/false).
NumericCustomField
number
InvalidParameterChoiceItem
object
5 properties 4 required
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
InvalidParameters
array
invalid parameters
Labels
object
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,…
CreateCatalogService
object
5 properties 2 required
CatalogServiceFilterParameters
object
7 properties
ConflictError
ForbiddenError
SortQuery
string
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provi…
UpdateCatalogService
object
5 properties
InvalidParameterDependentItem
object
5 properties 4 required
CustomFields
object
Map of customizable, catalog-defined fields providing information about a service.
InvalidRules
string
invalid parameters rules

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-catalog-services-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API
Where this information came from

This is an independent, third-party profile of Kong Catalog Services API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.