REST V1 Endpoint Response
- Chandresh Patel
- Emily Simon
Response
Attributes | Type | Description |
|---|---|---|
| description | String | This is a description of the Endpoint. |
| connectionType | String | This specifies the connection Type. |
| isActive | Boolean | This is a Boolean that tracks whether or not the Endpoint is active. |
| endpointAddress | String | This is a String associated with the address of the endpoint. |
| endpointPort | String | This is a port associated with an SSH connection. |
| endpointId | Long | This is an identification number of an existing Endpoint. |
| password | String | This is a character sequence used to access the corresponding remote connection. |
| endpointName | String | This is the unique name of the corresponding Endpoint. |
| privateKey | String | This is a character sequence associated with the corresponding remote connection. |
| osType | String | This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. |
| baseDirectory | String | This is a character sequence which corresponds to the base directory of the corresponding Endpoint. |
| endpointSubgroup | String | This is a character sequence associated with this Endpoint's corresponding sub-group. |
| passphrase | String | An optional passphrase used when the private key was generated. |
| javaPath | String | This is a character sequence that specifies the java path of the corresponding Endpoint. |
| 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. |
- style