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

A target is an IP address or hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added, modified, or deleted. Changes take effect on the fly.To disable a target, post a new one with `weight=0`, or use the `DELETE` method to accomplish the same.

Kong Targets 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 Targets. 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 7 operations across 4 paths, and defines 17 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.

7 operations 4 paths 17 schemas 1 DELETE3 GET2 POST1 PUT

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
API Key, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 5

Kong Targets 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 7

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

Targets 7

A target is an IP address or hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be dynamically added,…

POST
/{workspace}/upstreams/{UpstreamIdForTarget}/targets
Create a new Target associated with an Upstream
create-target-with-upstream 2 params body → 201
GET
/v2/control-planes/{controlPlaneId}/core-entities/targets
List all targets for a control plane
list-targets 4 params → 200400401403
GET
/v2/control-planes/{controlPlaneId}/core-entities/upstreams/{UpstreamIdForTarget}/targets
List all Targets associated with an Upstream
list-target-with-upstream 5 params → 200
POST
/v2/control-planes/{controlPlaneId}/core-entities/upstreams/{UpstreamIdForTarget}/targets
Create a new Target associated with an Upstream
create-target-with-upstream 2 params body → 201
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/upstreams/{UpstreamIdForTarget}/targets/{TargetId}
Delete a a Target associated with an Upstream
delete-target-with-upstream 3 params → 204
GET
/v2/control-planes/{controlPlaneId}/core-entities/upstreams/{UpstreamIdForTarget}/targets/{TargetId}
Get a Target associated with an Upstream
get-target-with-upstream 3 params → 200404
PUT
/v2/control-planes/{controlPlaneId}/core-entities/upstreams/{UpstreamIdForTarget}/targets/{TargetId}
Upsert a Target associated with an Upstream
upsert-target-with-upstream 3 params body → 200

Schemas 17

The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are Target (8 properties), TargetWithoutParents (8 properties), Target_2 (8 properties), TargetWithoutParents_2 (8 properties). Each schema is shown below with its type and property counts.

Target
object
A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be d…
8 properties 1 required
TargetWithoutParents
object
A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be d…
8 properties 1 required
BadRequestError
BaseError
object
standard error
5 properties 4 required
InvalidParameterMinimumLength
object
5 properties 4 required
TargetWithoutParents_2
object
A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be d…
8 properties 1 required
UnauthorizedError
PaginationOffsetResponse
string
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
InvalidParameterMaximumLength
object
5 properties 4 required
InvalidParameterStandard
object
4 properties 2 required
InvalidParameterChoiceItem
object
5 properties 4 required
PaginationNextResponse
string
URI to the next page (may be null)
InvalidParameters
array
invalid parameters
ForbiddenError
Target_2
object
A target is an ip address/hostname with a port that identifies an instance of a backend service. Every upstream can have many targets, and the targets can be d…
8 properties 1 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-targets-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 Targets 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.