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

APIs for managing static assets for Konnect Developer Portals.

Kong Assets 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 Assets. 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 6 operations across 4 paths, and defines 19 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}.

6 operations 4 paths 19 schemas 4 GET2 PUT

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 Assets 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 6

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

Assets 6

APIs for managing static assets for Konnect Developer Portals.

GET
/v3/portals/{portalId}/assets/favicon
Get Favicon
get-portal-asset-favicon 1 param → 200401403
PUT
/v3/portals/{portalId}/assets/favicon
Replace Favicon
replace-portal-asset-favicon 1 param body → 200400401403
GET
/v3/portals/{portalId}/assets/favicon/raw
Get Favicon (Raw)
get-portal-asset-favicon-raw 1 param → 200401403
GET
/v3/portals/{portalId}/assets/logo
Get Logo
get-portal-asset-logo 1 param → 200401403
PUT
/v3/portals/{portalId}/assets/logo
Replace Logo
replace-portal-asset-logo 1 param body → 200400401403
GET
/v3/portals/{portalId}/assets/logo/raw
Get Logo (Raw)
get-portal-asset-logo-raw 1 param → 200401403

Schemas 19

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

InvalidParameterMinimumLength
object
5 properties 4 required
ImageICODataUri
string
must be a data URL with base64 ICO image data, e.g., data:image/ico;base64,
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
ImageGIFDataUri
string
must be a data URL with base64 GIF image data, e.g., data:image/gif;base64,
ForbiddenError
UnauthorizedError
ImageSVGDataUri
string
must be a data URL with base64 SVG image data, e.g., data:image/svg\+xml;base64,
ImageJPGDataUri
string
must be a data URL with base64 JPEG image data, e.g., data:image/jpeg;base64,
ImagePNGDataUri
string
must be a data URL with base64 PNG image data, e.g., data:image/png;base64,
ReplacePortalImageAsset
object
The image data to upload. Images must be a data URL with binary image data in base 64 format. See https://developer.mozilla.org/en-US/docs/Web/HTTP/BasicsofHTT…
1 property 1 required
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
PortalImageAssetBlob
string
Raw binary image data
InvalidParameterStandard
object
4 properties 2 required
PortalImageDataUri

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-assets-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