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.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Kong Catalog 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 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.
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…
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), InvalidParameterDependentItem (5 properties), BaseError (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kong 12
Other APIs Kong publishes across the network.