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

APIs related to Konnect Developer Portal Custom Snippets.

Kong Snippets 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 Snippets. 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 5 operations across 2 paths, and defines 33 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}.

5 operations 2 paths 33 schemas 1 DELETE2 GET1 PATCH1 POST

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 Snippets 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 5

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

Snippets 5

APIs related to Konnect Developer Portal Custom Snippets.

GET
/v3/portals/{portalId}/snippets
List Snippets
list-portal-snippets 5 params → 200400401403404
POST
/v3/portals/{portalId}/snippets
Create Snippet
create-portal-snippet 1 param body → 201400401403404
GET
/v3/portals/{portalId}/snippets/{snippetId}
Get a Snippet
get-portal-snippet 2 params → 200401403404
PATCH
/v3/portals/{portalId}/snippets/{snippetId}
Update Snippet
update-portal-snippet 2 params body → 200400401403404
DELETE
/v3/portals/{portalId}/snippets/{snippetId}
Delete Snippet
delete-portal-snippet 2 params → 204401403404

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are PortalSnippetResponse (9 properties), PortalSnippetInfo (8 properties), PortalSnippetsFilterParameters (6 properties), CreatePortalSnippetRequest (6 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
PortalSnippetsFilterParameters
object
6 properties
UpdatedAt
string
An ISO-8601 timestamp representation of entity update date.
InvalidParameterChoiceItem
object
5 properties 4 required
Description
string
InvalidParameterMaximumLength
object
5 properties 4 required
SnippetVisibilityStatus
string
Whether a snippet is publicly accessible to non-authenticated users. If not provided, the defaultpagevisibility value of the portal will be used.
UuidFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
ListPortalSnippetsResponse
object
A paginated list of custom snippets in a portal.
2 properties 2 required
UUID
string
Contains a unique identifier used for this resource.
ForbiddenError
UnauthorizedError
PublishedStatus
string
Whether the resource is visible on a given portal. Defaults to unpublished.
SnippetName
string
The unique name of a snippet in a portal.
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
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
SnippetTitle
string
The display title of a snippet in a portal.
InvalidParameterStandard
object
4 properties 2 required
SnippetContent
string
The renderable markdown content of a page in a portal.
DateTimeFieldFilter
Filters on the given datetime (RFC-3339) field value.
CreatePortalSnippetRequest
object
Create a snippet in a portal.
6 properties 2 required
UpdatePortalSnippetRequest
object
Update a snippet in a portal.
6 properties
VisibilityStatus
string
Whether the resource is publicly accessible to non-authenticated users.
PortalSnippetInfo
object
Information about a snippet in a portal.
8 properties 7 required
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
PortalSnippetResponse
object
Details about a snippet in a portal.
9 properties 7 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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