Create Service Associated to a Specific Certificate
POST {{gateway}}/certificates/:certificateIdorName/services
Create Service Associated to a Specific Certificate konghq
Attributes | Mandatory | Type | Description |
---|
certificate name or id | required | path | The unique identifier or the name attribute of the Certificate that should be associated to the newly-created Service. |
Request Body
Attributes | Mandatory | Description |
---|
name | optional | The Service name |
retries | optional | The number of retries to execute upon failure to proxy. Defaults to 5 |
protocol | required | The protocol used to communicate with the upstream. Accepted values are: "grpc", "grpcs", "http", "https", "tcp", "tls". Defaults to "http" |
host | required | The host of the upstream server |
port | required | The upstream server port. Defaults to 80 |
path | optional | The path to be used in requests to the upstream server. |
connect_timeout | optional | The timeout in milliseconds for establishing a connection to the upstream server. Defaults to 60000. |
write_timeout | optional | The timeout in milliseconds between two successive write operations for transmitting a request to the upstream server. Defaults to 60000. |
read_timeout | optional | The timeout in milliseconds between two successive read operations for transmitting a request to the upstream server. Defaults to 60000. |
tags | optional | An optional set of strings associated with the Service, for grouping and filtering. |
client_certificate | optional | Certificate to be used as client certificate while TLS handshaking to the upstream server. With form-encoded, the notation is client_certificate.id=. With JSON, use “"client_certificate":{"id":""}. |
url | required | Shorthand attribute to set protocol, host, port and path at once. This attribute is write-only (the Admin API never “returns” the url). |
Request Body
{"name"=>"httpbin-api", "url"=>"https://httpbin.org/"}
Key | Datatype | Required | Description |
---|
Content-Type | string | | |
RESPONSES
status: Created
{"host":"httpbin.org","created_at":1583524667,"connect_timeout":60000,"id":"ebcbaad6-797f-435c-be22-63051db717c3","protocol":"https","name":"httpbin-api","read_timeout":60000,"port":443,"path":"/","updated_at":1583524667,"retries":5,"write_timeout":60000,"tags":null,"client_certificate":null}