Services

Gateway services

List all services

List all services

get

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

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

200 application/json

The service response object is returned when creating a new service or retreiving an existing service.

connect_timeoutinteger
created_atinteger

Unix epoch when the resource was last created.

enabledboolean

Service enabled boolean

hoststring
idstring
namestring
pathstring
portinteger
protocolstring
read_timeoutinteger
retriesinteger
updated_atinteger
write_timeoutinteger
get/runtime-groups/{runtimeGroupId}/core-entities/services
 
200 application/json

Create a new service

Create a new service

post

Path Parameters

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Body

application/json
namestring

The service name.

Example:my-service

retriesinteger

The number of retries to execute upon failure to proxy. Default:5.

Default:5

Example:5

protocolstringrequired

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

hoststringrequired

The host of the upstream server. Note that the host value is case sensitive.

Example:example.com

portintegerrequired

The upstream server port. Default: 80.

Default:80

Example:80

pathstring

The path to be used in requests to the upstream server.

Example:/some_api

connect_timeoutinteger

The timeout in milliseconds for establishing a connection to the upstream server. Default: 60000.

Default:6000

Example:6000

write_timeoutinteger

The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Default: 60000.

Default:6000

Example:6000

read_timeoutinteger

The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Default: 60000.

Default:6000

Example:6000

tagsarray[string]

An optional set of strings associated with the service for grouping and filtering.

Example:user-level

client_certificateobject

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
tls_verifyboolean

Whether to enable verification of upstream server TLS certificate. If set to null, then the Nginx default is respected.

Default:true

tls_verify_depthstring | null

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

ca_certificatesarray[string]

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

enabledbooleanrequired

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

Successfully created service

connect_timeoutinteger
created_atinteger
enabledboolean
hoststring
idstring
namestring
pathstring
portinteger
protocolstring
read_timeoutinteger
retriesinteger
updated_atinteger
write_timeoutinteger
post/runtime-groups/{runtimeGroupId}/core-entities/services

Body

{ "name": "my-service", "retries": 5, "protocol": "http", "host": "example.com", "port": 80, "path": "/some_api", "connect_timeout": 6000, "write_timeout": 6000, "read_timeout": 6000, "tags": [ "user-level" ], "client_certificate": { "id": "4e3ad2e4-0bc4-4638-8e34-c84a417ba39b" }, "tls_verify": true, "tls_verify_depth": null, "ca_certificates": [ "4e3ad2e4-0bc4-4638-8e34-c84a417ba39b" ], "enabled": true }
 
application/json

Delete a service

Delete a service

delete

Path Parameters

service_idstringrequired

ID or name of the service to delete

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

204

Successfully deleted service or the resource didn’t exist

delete/runtime-groups/{runtimeGroupId}/core-entities/services/{service_id}
 
204

Get a service

Get a service using ID or name.

get

Query Parameters

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

sizeinteger

Number of resources to be returned.

Default:100

>= 1<= 1000

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

Path Parameters

service_idstringrequired

ID or name of the service to lookup

Example:7fca84d6-7d37-4a74-a7b0-93e576089a41

runtimeGroupIdstringrequired

The ID of your runtime group. This variable is available in the Konnect manager

Example:9524ec7d-36d9-465d-a8c5-83a3c9390458

Response

application/json

The service response object is returned when creating a new service or retreiving an existing service.

connect_timeoutinteger
created_atinteger

Unix epoch when the resource was last created.

enabledboolean

Service enabled boolean

hoststring
idstring
namestring
pathstring
portinteger
protocolstring
read_timeoutinteger
retriesinteger
updated_atinteger
write_timeoutinteger
get/runtime-groups/{runtimeGroupId}/core-entities/services/{service_id}
 
application/json