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 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.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.

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.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 Snippets 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 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), UpdatePortalSnippetRequest (6 properties), PortalSnippetsFilterParameters (6 properties). Each schema is shown below with its type and property counts.

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

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

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