|
View all API Specs
View all plugins
OpenAPI 3.0 spec for Kong Gateway’s open source Admin API.
You can know more about Kong Gateway at docs.konghq.com
.Give Kong a star at Kong/kong repository.
Default Admin API URL
List all services
Number of resources to be returned.
Default:100
>= 1<= 1000
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
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
A successful response listing services
service entities are abstractions of upstream services. The main attribute of a service is its URL which can be set as a single string or by specifying the protocol, host, port and path individually.
Array of CA Certificate object UUIDs that are used to build the trust store while verifying upstream server’s TLS certificate. If set to null when Nginx default is respected. If default CA list in Nginx are not specified and TLS verification is enabled, then handshake with upstream server will always fail (because no CA are trusted).
Certificate to be used as client certificate while TLS handshaking to the upstream server.
The timeout in milliseconds for establishing a connection to the upstream server.
Default:60000
Unix epoch when the resource was created.
Example:1422386534
Whether the service is active. If set to false, the proxy behavior will be as if any routes attached to it do not exist (404).
Default:true
The host of the upstream server. Note that the host value is case sensitive.
The service name.
The path to be used in requests to the upstream server.
The upstream server port.
Default:80
The protocol used to communicate with the upstream.
Default:http
The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
Default:60000
The number of retries to execute upon failure to proxy.
Default:5
An optional set of strings associated with the service for grouping and filtering.
Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
Maximum depth of chain while verifying Upstream server’s TLS certificate. If set to null, then the Nginx default is respected.’
Unix epoch when the resource was last updated.
Helper field to set protocol, host, port and path using a URL. This field is write-only and is not returned in responses.
The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server.
Default:60000