REST V1 Endpoint Response

Response

Attributes
Type
Description
descriptionString

This is a description of the Endpoint.

connectionTypeString

This specifies the connection Type.

isActiveBoolean

This is a Boolean that tracks whether or not the Endpoint is active. 

endpointAddressString

This is a String associated with the address of the endpoint.

endpointPortString

This is a port associated with an SSH connection.

endpointIdLong

This is an identification number of an existing Endpoint.

passwordString

This is a character sequence used to access the corresponding remote connection.

endpointNameString

This is the unique name of the corresponding Endpoint.

privateKeyString

This is a character sequence associated with the corresponding remote connection.

osTypeString

This is a character sequence which corresponds to the operating system type used in the corresponding remote connection.

baseDirectoryString

This is a character sequence which corresponds to the base directory of the corresponding Endpoint.

endpointSubgroupStringThis is a character sequence associated with this Endpoint's corresponding sub-group.
passphraseString

An optional passphrase used when the private key was generated.

javaPathString

This is a character sequence that specifies the java path of the corresponding Endpoint.

runAsUserNameString

An optional user to run as (using sudo) after establishing connection to the endpoint.

dockerHostBooleanThis indicates if endpoint is docker engine.
k8sClusterBoolean

This indicates if endpoint is kubernetes engine.

k8sContextStringName of the configured K8s context.