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

Represents all the resources mapped to a specific service.

Kong Catalog Service Resources 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 Resources. 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 30 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 30 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 Service Resources 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 Service Resources 1

Represents all the resources mapped to a specific service.

GET
/v1/catalog-services/{id}/resources
List Service Resources
list-catalog-service-resources 4 params → 200400401403404

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are CatalogResourceRefFilterParameters (13 properties), CatalogResource (10 properties), InvalidParameterDependentItem (5 properties), BaseError (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
CatalogResourceRefFilterParameters
object
13 properties
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
ForbiddenError
CatalogResourceId
string
The resource ID.
UnauthorizedError
StringFieldFilterExact
object
Filter using one of the following operators: eq, oeq, neq
3 properties
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
CatalogResourceIntegrationDataFieldFilter
object
Filters on the resource's integrationdata field. Filters must use dot-notation to identify the property that will be used to filter the results. For example: -…
5 properties 4 required
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
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
NumericFieldFilter
Filter by a numeric value.
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
IntegrationRef
object
Short-hand descriptor of an integration installed within the catalog.
3 properties 3 required
CatalogResource
object
Information about a catalog resource.
10 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-catalog-service-resources-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