Versions Compared

Old Version 13

changes.mady.by.user Hayden Mumm

Saved on

compared with

New Version Current

changes.mady.by.user Erick Jones

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Response


Attributes

Type

Description

description

endpointIdLongThis is an identification number of an existing Endpoint.
endpointNameStringThis is
a description
the unique name of the corresponding Endpoint.
connectionType
descriptionStringThis
specifies the connection Type
is a description of the Endpoint.
isActiveBooleanThis is a Boolean that tracks whether or not the Endpoint is active. 
endpointAddress
connectionTypeStringThis
is a String associated with the address of the endpoint
specifies the connection Type.
endpointPort
osTypeStringThis is a
port associated with an SSH
character sequence which corresponds to the operating system type used in the corresponding remote connection.
endpointId
endpointAddress
Long
StringThis is
an identification number of an existing Endpoint.passwordString

Kept 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.endpointNameString

This is the unique name of the corresponding Endpoint.

privateKeyString

Fully-qualified path of the SSH private key file.

osType
a String associated with the address of the endpoint.
endpointPortStringThis is a
character sequence which corresponds to the operating system type used in the corresponding remote
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".
endpointSubgroup
javaPathStringThis is a character sequence
associated with this Endpoint's corresponding sub-group.passphrase
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
passphraseCredentialId
passwordCredentialId is set or not.
passphraseCredentialId
passwordCredentialIdLongThis is
the credential
the credential id associated with the endpoint
passphrase
password.
javaPath
privateKeyString
This is a character sequence that specifies the java
Fully-qualified path of the
corresponding Endpoint
SSH private key file.
isJavaPathExpression
passphraseString
"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"
Kept 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.