Kong Upstreams API
The upstream object represents a virtual hostname and can be used to load balance incoming requests over multiple services (targets).An upstream also includes a [health checker](https://developer.konghq.com/gateway/traffic-control/health-checks-circuit-breakers/), which can enable and disable targets based on their ability or inability to serve requests.The configuration for the health checker is stored in the upstream object, and applies to all of its targets.
Kong Upstreams 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 Upstreams. 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 9 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.2.0, at version 3.14.0.
Requests are made against 5 base URLs: {protocol}://{hostname}:{port}{path}, https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 5
Kong Upstreams API declares
5 security schemes
for authenticating requests.
An API key is passed in the header as Kong-Admin-Token (adminToken).
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).
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 9
Across 4 paths, the API surfaces 9 operations — 2 DELETE, 3 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The upstream object represents a virtual hostname and can be used to load balance incoming requests over multiple services (targets). An upstream also includes a [health checker](…
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Upstream_2 (23 properties), Upstream (23 properties), GatewayUnauthorizedError (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kong 12
Other APIs Kong publishes across the network.
This is an independent, third-party profile of Kong Upstreams 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.