Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

POST /system/server_connection_validator

Creates a server connection validator for the provided hostname and port, based on the provided host ids.

Creates a new server connection validator. Server connection validator is used to determine if a server in the deployment can connect to a given hostname and port. If a server does not have access to the hostname and port, it gives feedback on why the connection was not possible. The validator for each server in the deployment is returned in the response from the server. The validator or the hostname/port is not persisted.

Table 1: POST /system/server_connection_validator Resource Details

MIME Type

application/json

Table 2: POST /system/server_connection_validator Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

fields

header

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3: POST /system/server_connection_validator Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

request_details

Object

application/json

  • hostname - String - The hostname to attempt a connection to.

  • port - Integer - The port to attempt a connection to.

  • hosts - List<Host> - List of Hosts to perform the connection check on. Defaults to all active hosts in the deployment.

    • id - ID of the host.

{ "hostname": "String", "hosts": [ { "connection_result": "String <one of: SUCCESS, MANAGEDHOST_

UNREACHABLE, UNREACHABLE>", "id": 42 } ], "port": 42 }

Table 4: POST /system/server_connection_validator Response Codes

HTTP Response Code

Unique Code

Description

200

 

response with a server connection validator. The successful 200 response is returned regardless if any connection checks passed the validation or not. The 200 response indicates the validation was performed. Details of the validation will be in the returned validator structure.

422

1001

The hostname is not well formed.

422

1002

The port must be between 1 and 65535 (inclusive).

422

1003

One of the given host IDs were not valid

422

1004

One of the specified hosts were not Active

500

1005

Encountered a server processing error while attempting to fetch deployment information.

500

1006

Encountered a server error while performing the connection validation.

Response Description

A Server Connection Validator with the following fields:

  • hostname - The hostname the connection was attempted to.

  • port - The port the connection was attempted to.

  • hosts - The hosts connection information. Each host contains the following information:

    • id - The host ID the connection was attempted on.

    • connection_result - Enum representing the connection status. SUCCESS, UNREACHABLE, MANAGEDHOST_UNREACHABLE

Response Sample