REST V1 Endpoint Response

Response


Attributes

Type

Description

endpointIdLongThis is an identification number of an existing Endpoint.
endpointNameStringThis is the unique name of the corresponding Endpoint.
descriptionStringThis is a description of the Endpoint.
isActiveBooleanThis is a Boolean that tracks whether or not the Endpoint is active. 
connectionTypeStringThis specifies the connection Type.
osTypeStringThis is a character sequence which corresponds to the operating system type used in the corresponding remote connection.
endpointAddressStringThis is a String associated with the address of the endpoint.
endpointPortStringThis is a port associated with an SSH connection.
baseDirectoryStringThis is a character sequence which corresponds to the base directory of the corresponding Endpoint.
isBaseDirectoryExpressionString"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".
javaPathStringThis is a character sequence that specifies the java path of the corresponding Endpoint.
isJavaPathExpressionString"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".
passwordStringKept for backward compatibility. It will be either ***** or null depending on whether passwordCredentialId is set or not.
passwordCredentialIdLongThis is the credential id associated with the endpoint password.
privateKeyStringFully-qualified path of the SSH private key file.
passphraseStringKept for backward compatibility. It will be either ***** or null depending on whether passphraseCredentialId is set or not.
passphraseCredentialIdLongThis is the credential id associated with the endpoint passphrase.
runAsUserNameStringAn optional user to run as (using sudo) after establishing connection to the endpoint.
dockerHostBooleanThis indicates if endpoint is docker engine.
k8sClusterBooleanThis indicates if endpoint is kubernetes engine.
k8sContextStringName of the configured K8s context.
endpointGroupStringThis is a character sequence associated with this Endpoint's corresponding group.
endpointSubgroupStringThis is a character sequence associated with this Endpoint's corresponding sub-group.