Sign in
Services

Get a Service

Get a Service using ID or name.

get/v2/control-planes/{controlPlaneId}/core-entities/services/{ServiceId}

Response

Successfully fetched Service

ca_certificatesstring[] nullable

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 nullable

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

created_atinteger nullable

Unix epoch when the resource was created.

enabledboolean nullable

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 required

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

idstring nullable

A string representing a UUID (universally unique identifier).

namestring nullable

The Service name.

pathstring nullable

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

portinteger nullable

The upstream server port.

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

The protocol used to communicate with the upstream.

read_timeoutinteger nullable

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

retriesinteger nullable

The number of retries to execute upon failure to proxy.

tagsstring[] nullable

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

tls_verifyboolean nullable

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

tls_verify_depthinteger nullable

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

updated_atinteger nullable

Unix epoch when the resource was last updated.

urlstring nullable

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 nullable

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"
}

Changes

Changed in 5 of the 52 revisions of this API.2314

  • 96118a9cd7f437See the full diff
    • ▲

      the response property tls_sans/dnsnames became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tls_sans/uris became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property url became nullable for the status 200

      response-property-became-nullable

    • ○

      the connect_timeout response's property default value 60000 was added for the status 200

      response-property-default-value-added

    • ○

      the enabled response's property default value true was added for the status 200

      response-property-default-value-added

    • ○

      the port response's property default value 80 was added for the status 200

      response-property-default-value-added

    • ○

      the protocol response's property default value http was added for the status 200

      response-property-default-value-added

    • ○

      the read_timeout response's property default value 60000 was added for the status 200

      response-property-default-value-added

    • ○

      the retries response's property default value 5 was added for the status 200

      response-property-default-value-added

    • ○

      the write_timeout response's property default value 60000 was added for the status 200

      response-property-default-value-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2c77aeaee5fb1See the full diff
    • ▲

      the response property tags became nullable for the status 200

      response-property-became-nullable

  • dbc2de5f26631See the full diff
    • ○

      added the optional property tls_sans to the response with the 200 status

      response-optional-property-added

  • fc6abbc537f362See the full diff
    • ▲

      the response property created_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property port became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property protocol became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property updated_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property port became optional for the status 200

      response-property-became-optional

    • ▲

      the response property protocol became optional for the status 200

      response-property-became-optional

    • ○

      the response optional property created_at became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response optional property updated_at became not read-only for the status 200

      response-optional-property-became-not-read-only

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 08ead66e9ebb134See the full diff
    • ▲

      the response property ca_certificates became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property client_certificate became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property connect_timeout became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property enabled became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property path became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property read_timeout became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property retries became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tags became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tls_verify became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property tls_verify_depth became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property write_timeout became nullable for the status 200

      response-property-became-nullable

    • ○

      the response optional property id became not read-only for the status 200

      response-optional-property-became-not-read-only

    • ○

      the response property host became required for the status 200

      response-property-became-required

    • ○

      the response property port became required for the status 200

      response-property-became-required

    • ○

      the response property protocol became required for the status 200

      response-property-became-required

    This revision also has 88 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog