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 System Accounts API

The System Accounts API from Kong — 2 operation(s) for system accounts.

Kong System Accounts 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 System Accounts. 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 17 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 17 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 System Accounts 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.

System Accounts 5
GET
/v3/system-accounts
List System Accounts
get-system-accounts 3 params → 200400401403
POST
/v3/system-accounts
Create System Account
post-system-accounts body → 201401403409
GET
/v3/system-accounts/{accountId}
Get a System Account
get-system-accounts-id 1 param → 200401403404
PATCH
/v3/system-accounts/{accountId}
Update System Account
patch-system-accounts-id 1 param body → 200401403404409
DELETE
/v3/system-accounts/{accountId}
Delete System Account
delete-system-accounts-id 1 param → 204401403404

Schemas 17

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

InvalidParameterMinimumLength
object
5 properties 4 required
InvalidParameterChoiceItem
object
5 properties 4 required
ConflictError
InvalidParameterMaximumLength
object
5 properties 4 required
LegacyStringFieldFilter
object
Filter using one of the following operators: eq, contains
2 properties
UnauthorizedError
PaginatedMeta
object
returns the pagination information
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
SystemAccount
object
Schema of the system account.
6 properties
InvalidParameterStandard
object
4 properties 2 required
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
BooleanFieldFilter
boolean
Filter by a boolean value (true/false).

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-system-accounts-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