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 Services API

Represents all the services mapped to a specific resource.

Kong Catalog Resource 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 Resource 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 1 operation across 1 path, and defines 31 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}.

1 operations 1 paths 31 schemas 1 GET

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 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Catalog Resource Services 1

Represents all the services mapped to a specific resource.

GET
/v1/resources/{id}/catalog-services
List Resource Services
list-catalog-resource-services 5 params → 200400401403404

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are CatalogService (8 properties), CatalogServiceFilterParameters (7 properties), InvalidParameterDependentItem (5 properties), BaseError (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
UrlCustomField
object
2 properties 2 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
CatalogService
object
The service object contains information about a Service Catalog service.
8 properties 8 required
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,…
UnauthorizedError
ForbiddenError
TextCustomField
string
PaginatedMeta
object
returns the pagination information
1 property 1 required
NumericCustomField
number
CustomFields
object
Map of customizable, catalog-defined fields providing information about a service.
StringFieldFilter
object
Filter using one of the following operators: eq, oeq, neq, contains, ocontains
5 properties
BooleanFieldFilter
boolean
Filter by a boolean value (true/false).
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
InvalidParameters
array
invalid parameters
BadRequestError
NumericFieldFilter
Filter by a numeric value.
InvalidParameterStandard
object
4 properties 2 required
CatalogServiceFilterParameters
object
7 properties
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
NotFoundError
LabelsFieldFilter
BooleanCustomField
boolean

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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