Kong Services API
Service entities are abstractions of your microservice interfaces or formal APIs. For example, a service could be a data transformation microservice or a billing API.The main attribute of a service is the destination URL for proxying traffic. This URL can be set as a single string or by specifying its protocol, host, port and path individually.Services are associated to routes, and a single service can have many routes associated with it. Routes are entrypoints in Kong Gateway which define rules to match client requests. Once a route is matched, Kong Gateway proxies the request to its associated service. See the [Route documentation](https://developer.konghq.com/gateway/entities/route/) for a detailed explanation of how Kong proxies traffic.Services can be both [tagged and filtered by tags](https://developer.konghq.com/admin-api/).
Kong Services 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 Services. 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.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Kong Services 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 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.
Service entities are abstractions of your microservice interfaces or formal APIs. For example, a service could be a data transformation microservice or a billing API. The main att…
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Service (20 properties), Service_2 (20 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.