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

The API Image API from Kong — 2 operation(s) for api image.

Kong API Image 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 API Image. 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 4 operations across 2 paths, and defines 14 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}.

4 operations 2 paths 14 schemas 1 DELETE2 GET1 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 API Image 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 4

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

API Image 4
PUT
/v3/apis/{apiId}/images/{imageType}
Create or Replace an API Image
upsert-api-image 2 params body → 200201401403404409
GET
/v3/apis/{apiId}/images/{imageType}
Get API Image
fetch-api-image 2 params → 200401403404
DELETE
/v3/apis/{apiId}/images/{imageType}
Delete an API Image
delete-api-image 2 params → 204401403404
GET
/v3/apis/{apiId}/images/{imageType}/raw
Get an API Raw Image
fetch-api-raw-image 2 params → 302401403404

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are APIImage (6 properties), BaseError (5 properties), ReplaceImageRequestSchema (1 property). Each schema is shown below with its type and property counts.

APIImage
object
6 properties 6 required
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
ConflictError
ImageDataUri
UnauthorizedError
ForbiddenError
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,
CreatedAt
string
An ISO-8601 timestamp representation of entity creation date.
BaseError
object
standard error
5 properties 4 required
ImageTypeSchema
string
The type of the image.
ReplaceImageRequestSchema
object
1 property 1 required
NotFoundError

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-api-image-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