Enterprise Kong Admin API

v3.9.0OAS 3.0

OpenAPI 3.0 spec for Kong Gateway’s Enterprise Admin API.

You can learn more about Kong Gateway at docs.konghq.com
.Give Kong a star at Kong/kong repository.

API Base URL
  • Server 1:{protocol}://{hostname}:{port}{path}[Enterprise Kong Admin API]

    Default Admin API URL

Security
kongAdminToken (apiKey)

When RBAC is enabled, an admin token is required to use the Kong Admin API.
This token is passed in a Kong-Admin-Token header by default.
To configure the header name, adjust rbac_auth_header in kong.conf.



Each admin has their own token.
The admin associated with the token must have relevant permissions for the object they’re interacting with.
Generate tokens using the /admins API.



If RBAC isn’t enabled, this token isn’t required.

List all services

List all Services

get
{protocol}://{hostname}:{port}{path}/services

Query Parameters

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

offsetstring

Offset from which to return the next set of resources. Use the value of the ‘offset’ field from the response of a list operation as input here to paginate through all the resources

tagsstring

A list of tags to filter the list of resources on. Multiple tags can be concatenated using , to mean AND or using / to mean OR.

Example:tag1,tag2

Response

application/json

A successful response listing Services

dataarray[object]

Service entities, as the name implies, are abstractions of each of your own upstream services. Examples of Services would be a data transformation microservice, a billing API, etc. The main attribute of a Service is its URL (where Kong should proxy traffic to), which can be set as a single string or by specifying its protocol, host, port and path individually. Services are associated to routes (a Service can have many routes associated with it). Routes are entry-points in Kong and define rules to match client requests. Once a route is matched, Kong proxies the request to its associated Service. See the [Proxy Reference][proxy-reference] for a detailed explanation of how Kong proxies traffic.

Example:{"host":"example.internal","id":"49fd316e-c457-481c-9fc7-8079153e4f3c","name":"example-service","path":"/","port":80,"protocol":"http"}

Show Child Parameters
offsetstring

Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page

get/services
 
application/json