REST V1 Endpoint Response

endpointId

Long

This is an identification number of an existing Endpoint.

endpointName

String

This is the unique name of the corresponding Endpoint.

description

String

This is a description of the Endpoint.

isActive

Boolean

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

connectionType

String

This specifies the connection Type.

osType

String

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

endpointAddress

String

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

endpointPort

String

This is a port associated with an SSH connection.

baseDirectory

String

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

isBaseDirectoryExpression

String

"Y" if the base directory is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N".

javaPath

String

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

isJavaPathExpression

String

"Y" if the Java path is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N".

password

String

Kept for backward compatibility. It will be either ***** or null depending on whether passwordCredentialId is set or not.

passwordCredentialId

Long

This is the credential id associated with the endpoint password.

privateKey

String

Fully-qualified path of the SSH private key file.

passphrase

String

Kept for backward compatibility. It will be either ***** or null depending on whether passphraseCredentialId is set or not.

passphraseCredentialId

Long

This is the credential id associated with the endpoint passphrase.

runAsUserName

String

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

dockerHost

Boolean

This indicates if endpoint is docker engine.

k8sCluster

Boolean

This indicates if endpoint is kubernetes engine.

k8sContext

String

Name of the configured K8s context.

endpointGroup

String

This is a character sequence associated with this Endpoint's corresponding group.

endpointSubgroup

String

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