Services

Update a Service

patch/services/{ServiceIdOrName}

Request body

ca_certificatesstring[]

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).

connect_timeoutinteger

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

created_atinteger

Unix epoch when the resource was created.

enabledboolean

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.

hoststring

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

idstring

namestring

The Service name.

pathstring

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

portinteger

The upstream server port.

protocol'grpc' | 'grpcs' | 'http' | 'https' | 'tcp' | 'tls' | 'tls_passthrough' | 'udp' | 'ws' | 'wss'

The protocol used to communicate with the upstream.

read_timeoutinteger

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

retriesinteger

The number of retries to execute upon failure to proxy.

tagsstring[]

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

tls_verifyboolean

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

tls_verify_depthinteger

Maximum depth of chain while verifying Upstream server's TLS certificate. If set to null, then the Nginx default is respected.

updated_atinteger

Unix epoch when the resource was last updated.

urlstring

Helper field to set protocol, host, port and path using a URL. This field is write-only and is not returned in responses.

write_timeoutinteger

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

Response

Successfully updated Service