Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Catalog Service API Mappings API

Service API mappings represent the link between Service and API entities.Once an API is mapped to a Service, a rich view of the linked APIs will be presented on the APIs tab of the Catalog Service.Similarly, Services mapped to an API will be listed on the API overview page under Catalog.An API may be mapped to multiple services, but it cannot be mapped to the same service twice.If a mapped API is unlinked from a Service, the mapping will be deleted.

Kong Catalog Service API Mappings 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 Service API Mappings. 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 3 paths, and defines 20 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}.

5 operations 3 paths 20 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Catalog Service API Mappings 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 3 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Catalog Service API Mappings 5

Service API mappings represent the link between Service and API entities. Once an API is mapped to a Service, a rich view of the linked APIs will be presented on the APIs tab of t…

GET
/v1/apis/{apiId}/service-mappings
List Service Mappings for an API
list-service-mappings-for-api 5 params → 200400401403404
GET
/v1/catalog-services/{serviceId}/api-mappings
List API Mappings for a Service
list-catalog-service-api-mappings 5 params → 200400401403404
POST
/v1/catalog-services/{serviceId}/api-mappings
Create API Mapping for a Service
create-catalog-service-api-mapping 1 param body → 201400401403404409
GET
/v1/catalog-services/{serviceId}/api-mappings/{mappingId}
Get API Mapping for a Service
get-catalog-service-api-mapping 2 params → 200400401403404
DELETE
/v1/catalog-services/{serviceId}/api-mappings/{mappingId}
Delete API Mapping for a Service
delete-catalog-service-api-mapping 2 params → 204400401403404

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are CatalogServiceApiMapping (5 properties), InvalidParameterMinimumLength (5 properties), BaseError (5 properties), InvalidParameterMaximumLength (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
CatalogApiServiceMappingFilterParameters
object
1 property
InvalidParameterChoiceItem
object
5 properties 4 required
ConflictError
InvalidParameterMaximumLength
object
5 properties 4 required
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
ForbiddenError
UnauthorizedError
PaginatedMeta
object
returns the pagination information
1 property 1 required
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
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…
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
CatalogServiceApiMapping
object
Represents an API mapping associated with a service in the catalog.
5 properties 5 required
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
CatalogServiceApiMappingFilterParameters
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-catalog-service-api-mappings-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