Create a new Service
Create a new Service
Path parameters
The name of the workspace
Request body
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).
The timeout in milliseconds for establishing a connection to the upstream server.
Unix epoch when the resource was created.
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.
A string representing a UUID (universally unique identifier).
The Service name.
The path to be used in requests to the upstream server.
The upstream server port.
The protocol used to communicate with the upstream.
The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
The number of retries to execute upon failure to proxy.
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.
Example request
{
"host": "example.internal",
"id": "49fd316e-c457-481c-9fc7-8079153e4f3c",
"name": "example-service",
"path": "/",
"port": 80,
"protocol": "http"
}Response
Successfully created Service
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).
The timeout in milliseconds for establishing a connection to the upstream server.
Unix epoch when the resource was created.
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.
A string representing a UUID (universally unique identifier).
The Service name.
The path to be used in requests to the upstream server.
The upstream server port.
The protocol used to communicate with the upstream.
The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server.
The number of retries to execute upon failure to proxy.
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.
Example response
{
"host": "example.internal",
"id": "49fd316e-c457-481c-9fc7-8079153e4f3c",
"name": "example-service",
"path": "/",
"port": 80,
"protocol": "http"
}