Create a new service
Create a new service
Path Parameters
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The service name.
Example:my-service
The number of retries to execute upon failure to proxy. Default:5.
Default:5
Example:5
The protocol used to communicate with the upstream. Accepted values are: grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws
, wss
. Default: http.
Allowed values:grpcgrpcshttphttpstcptls tls_passthroughudpwswss
Default:http
Example:http
The host of the upstream server. Note that the host value is case sensitive.
Example:example.com
The upstream server port. Default: 80.
Default:80
Example:80
The path to be used in requests to the upstream server.
Example:/some_api
The timeout in milliseconds for establishing a connection to the upstream server. Default: 60000.
Default:6000
Example:6000
The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: 60000.
Default:6000
Example:6000
The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: 60000.
Default:6000
Example:6000
An optional set of strings associated with the service for grouping and filtering.
Example:user-level
Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is client_certificate.id=<client_certificate id>. With JSON, use client_certificate:{id:<client_certificate id>}.
Show Child Parameters
Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
Default:true
Maximum depth of chain while verifying Upstream server’s TLS certificate. If set to null, then the Nginx default is respected. Default: null.
Default:null
Example:respected
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. With form-encoded, the notation is ca_certificates[]=4e3ad2e4-0bc4-4638-8e34-c84a417ba39b&ca_certificates[]=51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515. With JSON, use an Array.
Example:4e3ad2e4-0bc4-4638-8e34-c84a417ba39b
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.
Default:true
Response
application/json
Response
Successfully created service
Authentication
Path Parameters
Body
Delete a service
Delete a service
Path Parameters
ID or name of the service to delete
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
204
Response
Successfully deleted service or the resource didn’t exist
Authentication
Path Parameters
Get a service
Get a service using ID or name.
Query Parameters
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
Number of resources to be returned.
Default:100
>= 1<= 1000
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
Path Parameters
ID or name of the service to lookup
Example:7fca84d6-7d37-4a74-a7b0-93e576089a41
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Response
application/json
Response
The service response object is returned when creating a new service or retreiving an existing service.
Unix epoch when the resource was last created.
Service enabled boolean
Authentication
Path Parameters
Query Parameters
Upsert a service
Create or Update service using ID or name.
Path Parameters
ID or name of the service to lookup
Example:7fca84d6-7d37-4a74-a7b0-93e576089a41
The ID of your runtime group. This variable is available in the Konnect manager
Example:9524ec7d-36d9-465d-a8c5-83a3c9390458
Body
application/json
Body
The service name.
Example:my-service
The number of retries to execute upon failure to proxy. Default:5.
Default:5
Example:5
The protocol used to communicate with the upstream. Accepted values are: grpc, grpcs, http, https, tcp, tls, tls_passthrough, udp, ws
, wss
. Default: http.
Allowed values:grpcgrpcshttphttpstcptls tls_passthroughudpwswss
Default:http
Example:http
The host of the upstream server. Note that the host value is case sensitive.
Example:example.com
The upstream server port. Default: 80.
Default:80
Example:80
The path to be used in requests to the upstream server.
Example:/some_api
The timeout in milliseconds for establishing a connection to the upstream server. Default: 60000.
Default:6000
Example:6000
The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: 60000.
Default:6000
Example:6000
The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: 60000.
Default:6000
Example:6000
An optional set of strings associated with the service for grouping and filtering.
Example:user-level
Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is client_certificate.id=<client_certificate id>. With JSON, use client_certificate:{id:<client_certificate id>}.
Show Child Parameters
Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.
Default:true
Maximum depth of chain while verifying Upstream server’s TLS certificate. If set to null, then the Nginx default is respected. Default: null.
Default:null
Example:respected
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. With form-encoded, the notation is ca_certificates[]=4e3ad2e4-0bc4-4638-8e34-c84a417ba39b&ca_certificates[]=51e77dc2-8f3e-4afa-9d0e-0e3bbbcfd515. With JSON, use an Array.
Example:4e3ad2e4-0bc4-4638-8e34-c84a417ba39b
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.
Default:true
Response
application/json
Response
The service response object is returned when creating a new service or retreiving an existing service.
Unix epoch when the resource was last created.
Service enabled boolean
Authentication
Path Parameters
Body
Routes
Gateway routes