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

Resources are entities discovered from integration instances and are intended to be mapped to the relevant services in the catalog.Once a resource has been mapped to a service, a rich view of this resource will be displayed when viewing your service.Any resources which you would like to ignore and hide can be archived.Note that archiving a resource will **remove** any mappings it has to services in the catalog.You can create Resources using only the properties required to identify the resource in the third-party system.Additional data will be hydrated if the integration that the Resource is linked to has been provided with authentication credentials.Resources which have not yet been hydrated may still be mapped to a Catalog Service.

Kong Catalog 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 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 3 operations across 3 paths, and defines 34 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.

3 operations 3 paths 34 schemas 2 GET1 PATCH

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

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

Catalog Resources 3

Resources are entities discovered from integration instances and are intended to be mapped to the relevant services in the catalog. Once a resource has been mapped to a service, a…

PATCH
/v1/integration-instances/{integrationInstanceId}/resources/{resourceId}
Update Resource
update-resource 2 params body → 200400401403404
GET
/v1/resources
List Resources
list-resources 3 params → 200400401403
GET
/v1/resources/{id}
Get a Resource
fetch-resource 1 param → 200401403404

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are CatalogResourceFilterParameters (14 properties), CatalogResource (10 properties), CatalogResourceIntegrationDataFieldFilter (5 properties), StringFieldFilter (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.
UpdateCatalogResource
object
1 property
CursorMetaPage
object
5 properties 3 required
IntegrationRef
object
Short-hand descriptor of an integration installed within the catalog.
3 properties 3 required
UnauthorizedError
NotFoundError
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 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
CatalogResourceType
string
The resource type. Available resource types are compiled from the integrations installed within the catalog.
CatalogResourceFilterParameters
object
14 properties
NumericFieldFilter
Filter by a numeric value.
InvalidParameterMaximumLength
object
5 properties 4 required
InvalidParameterStandard
object
4 properties 2 required
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…
BooleanFieldFilter
boolean
Filter by a boolean value (true/false).
CursorPageParameters
object
3 properties
InvalidParameterChoiceItem
object
5 properties 4 required
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
StringFieldFilterExact
object
Filter using one of the following operators: eq, oeq, neq
3 properties
InvalidParameters
array
invalid parameters
CursorMeta
object
Pagination metadata.
1 property 1 required
ForbiddenError
CatalogResource
object
Information about a catalog resource.
10 properties 10 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…
CatalogResourceId
string
The resource ID.
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
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
IntegrationInstanceRef
object
Short-hand descriptor of an integration instance.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-catalog-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
Where this information came from

This is an independent, third-party profile of Kong Catalog Resources 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.