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 Resource Mappings API

Resource mappings represent the link between a resource and a service.Once a resource is mapped to a service, a rich view of the resource will be presented on the service page.A resource may be mapped to multiple services, but it cannot be mapped to the same service twice.If a resource mapped to a service is later archived, the resource mapping will be deleted.

Kong Catalog Resource 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 Resource 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 4 operations across 2 paths, and defines 33 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}.

4 operations 2 paths 33 schemas 1 DELETE2 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 Resource 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 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Catalog Resource Mappings 4

Resource mappings represent the link between a resource and a service. Once a resource is mapped to a service, a rich view of the resource will be presented on the service page. A…

POST
/v1/resource-mappings
Create Resource Mapping
create-resource-mapping body → 201400401403409
GET
/v1/resource-mappings
List Resource Mappings
list-resource-mappings 4 params → 200400401403
GET
/v1/resource-mappings/{resourceMappingId}
Get a Resource Mapping
fetch-resource-mapping 1 param → 200401403404
DELETE
/v1/resource-mappings/{resourceMappingId}
Delete Resource Mapping
delete-resource-mapping 1 param → 204401403404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are CatalogResourceMappingFilterParameters (13 properties), BaseError (5 properties), CatalogResourceRef (5 properties), StringFieldFilter (5 properties). Each schema is shown below with its type and property counts.

CreateCatalogResourceMapping
object
2 properties 2 required
InvalidParameterMinimumLength
object
5 properties 4 required
CreateCatalogResourceMappingResourceByConfig
object
3 properties 3 required
CatalogResourceRef
object
Short-hand descriptor of a catalog resource.
5 properties 5 required
ConflictError
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
CatalogResourceConfigFieldFilter
object
Filters on the resource's config field. Filters must use dot-notation to identify the property that will be used to filter the results. For example: - filter[c…
5 properties 4 required
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
IntegrationInstanceRef
object
Short-hand descriptor of an integration instance.
3 properties 3 required
CatalogServiceRef
object
Short-hand descriptor of a catalog service.
3 properties 3 required
CatalogResourceId
string
The resource ID.
ForbiddenError
UnauthorizedError
StringFieldFilterExact
object
Filter using one of the following operators: eq, oeq, neq
3 properties
IntegrationRef
object
Short-hand descriptor of an integration installed within the catalog.
3 properties 3 required
CatalogResourceType
string
The resource type. Available resource types are compiled from the integrations installed within the catalog.
PaginatedMeta
object
returns the pagination information
1 property 1 required
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.
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
CatalogResourceMapping
object
Describes a mapping between a catalog resource and a service.
4 properties 4 required
CatalogResourceMappingFilterParameters
object
13 properties
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
CatalogResourceConfig
object
JSON object representing the properties used to identify the resource in the third-party system. The schema depends on the resource type and is dynamically reg…
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-catalog-resource-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