Endpoints can be accessed and modified through this API using four services: GET, POST, PUT, and PATCH. These four services allow for the retrieval, creation, complete update, and partial update of endpoints.
...
If we had an endpoint in our database with an Id of 13901 and had the following attributes
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"password": "Password",
"passwordCredentialId": 12345,
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "GOODPOST1",
"connectionType": "SSH",
"endpointAddress": "NotNeeded00",
"endpointId": 13910,
"endpointSubgroup": "subGroupTester",
"endpointPort": "1",
"endpointGroup": "endpointGroup",
"runAsUserName": "TestInput",
"osType": "UNIX",
"javaPath": "ServerJavaHome",
"passphrase": "Passphrase",
"passphraseCredentialId": 54321
} |
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/v1/topology/endpoint/13901
The GET request would return the following JSON endpoint object
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"password": "*****",
"passwordCredentialId": 12345,
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "GOODPOST1",
"connectionType": "SSH",
"endpointAddress": "NotNeeded00",
"endpointId": 13910,
"endpointSubgroup": "subGroupTester",
"endpointPort": "1",
"endpointGroup": "endpointGroup",
"runAsUserName": "TestInput",
"osType": "UNIX",
"javaPath": "ServerJavaHome",
"passphrase": "*****",
"passphraseCredentialId": 54321
} |
GET (Using Query Parameters)
This GET service will return a list of Endpoints in the form of JSON objects based on the query parameters name, address, group and subgroup. Endpoints are only returned if they match ALL of the specified query parameters. If no query parameters are given this request will return the entire list of Endpoints.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/topology/endpoint? Append the following character sequences to the above URL to specify Query parameters.Use '&' between successive query parameters:endpointName={name} endpointAddress={address} endpointGroup={group} endpointSubgroup={subgroup} Examples:To Specify the name parameter only:http://host:port/flexdeploy/rest/v1/topology/endpoint?endpointName={name} To Specify the name and group parameters:http://host:port/flexdeploy/rest/v1/topology/endpoint?endpointName={name}&endpointGroup={group} To Specify the name, address and group parameters:http://host:port/flexdeploy/rest/v1/topology/endpoint?endpointName={name}&endpointAddress={address}&endpointGroup={group} |
...
| Attributes | Type | Required | Description |
|---|---|---|---|
| description | String | No | A description of the Endpoint. |
| connectiontype | String | Yes | This specifies the connection Type. "SSH" or "LOCALHOST" |
| isActive | Boolean | No | This is a Boolean that tracks whether or not the Endpoint is active. Default is true. |
| endpointAddress | String | No | This is a String associated with the address of the endpoint. |
| endpointPort | String | Dependent | This is a port associated with an SSH connection. Dependency: Mandatory when connectionType is "SSH", otherwise not used. |
| password | String | Dependent | This is a character sequence used to access the corresponding remote connection. Dependency: Either password, passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used. |
| passwordCredentialId | Long | Dependent | This is the id of the credential associated with the endpoint password. Dependency: Either password, passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used. |
| endpointName | String | Yes | This is the unique name of the corresponding Endpoint. |
| privateKey | String | Dependent | Fully-qualified path of the SSH private key file. Dependency: Either password, passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used. |
| osType | String | Dependent | This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used. |
| baseDirectory | String | Yes | This is a character sequence which corresponds to the base directory of the corresponding Endpoint. |
| endpointSubgroup | String | No | This is a character sequence associated with this Endpoint's corresponding sub-group. |
| passphraseCredentialId | Long | No | This is the id of the credential associated with the endpoint passphrase. Note: Only valid if a privateKey is specified. |
| passphrase | String | No | An optional passphrase used when the private key was generated. Note: Only valid if a privateKey is specified. |
| javaPath | String | Yes | This is a character sequence that specifies the java path of the corresponding Endpoint. Not required if the Endpoint is a Docker Host. |
| runAsUserName | String | No | An optional user to run as (using sudo) after establishing connection to the endpoint. Note: Only applicable when connection Type is "SSH" otherwise not used. |
| dockerHost | Boolean | No | This indicates if endpoint is docker engine. Defaults to false. |
| k8sCluster | Boolean | No | This indicates if endpoint is kubernetes engine. Defaults to false. |
| k8sContext | String | No | Name of the configured K8s context. |
...
Request
| Attributes | Type | Required | Description |
|---|---|---|---|
| Id | URL | Yes | URL parameter to specify which endpoint to replace |
| description | String | No | A description of the Endpoint. |
| connectiontype | String | Yes | This specifies the connection Type. "SSH" or "LOCALHOST" |
| isActive | Boolean | No | This is a Boolean that tracks whether or not the Endpoint is active. Default is true. |
| endpointAddress | String | No | This is a String associated with the address of the endpoint. |
| endpointPort | String | Dependent | This is a port associated with an SSH connection. Dependency: Mandatory when connectionType is "SSH", otherwise not used. |
| password | String | Dependent | This is a character sequence used to access the corresponding remote connection. Dependency: Either password, passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used. |
| passwordCredentialId | Long | Dependent | This is the id of the credential associated with the endpoint password. Dependency: Either password, passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used. |
| endpointName | String | Yes | This is the unique name of the corresponding Endpoint. |
| privateKey | String | Dependent | Fully-qualified path of the SSH private key file. Dependency: Either password, passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used. |
| osType | String | Dependent | This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used. |
| baseDirectory | String | Yes | This is a character sequence which corresponds to the base directory of the corresponding Endpoint. |
| endpointSubgroup | String | No | This is a character sequence associated with this Endpoint's corresponding sub-group. |
| passphraseCredentialId | Long | No | This is the id of the credential associated with the endpoint passphrase. Note: Only valid if a privateKey is specified. |
| passphrase | String | No | An optional passphrase used when the private key was generated. Note: Only valid if a privateKey is specified. |
| javaPath | String | Yes | This is a character sequence that specifies the java path of the corresponding Endpoint. Not required if the Endpoint is a Docker Host. |
| runAsUserName | String | No | An optional user to run as (using sudo) after establishing connection to the endpoint. Note: Only applicable when connection Type is "SSH" otherwise not used. |
| dockerHost | Boolean | No | This indicates if endpoint is docker engine. Defaults to false. |
| k8sCluster | Boolean | No | This indicates if endpoint is kubernetes engine. Defaults to false. |
| k8sContext | String | No | Name of the configured K8s context. |
| Include Page | ||||
|---|---|---|---|---|
|
...
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "newDescription",
"userName": "newUserName",
"password": "newPassword",
"passwordCredentialId": 74839,
"isActive": true,
"privateKey": "newPrivateKey",
"endpointName": "GoodPost3",
"osType": "UNIX",
"connectionType": "SSH",
"javaPath": "ServerJavaHome",
"endpointAddress": "endpointAddress",
"baseDirectory": "ServerInstallRoot + '/localhost'",
"passphrase": "passphrase",
"passphraseCredentialId": 29084,
"endpointId": null,
"endpointGroup": "endpointGroup",
"endpointPort": null,
"runAsUserName": "runAsUserName",
"endpointSubgroup": "endpointSubgroup"
} |
PATCH
This PATCH service will update an existing endpoint with the information passed through a JSON object. If an attribute is not provided, it will not be updated in the Endpoint.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/topology/endpoint/{Id} |
...
| Attributes | Type | Required | Description |
|---|---|---|---|
| Id | URL | Yes | URL parameter to specify which endpoint to patch |
| description | String | No | A description of the Endpoint. |
| connectiontype | String | No | This specifies the connection Type. "SSH" or "LOCALHOST" |
| isActive | Boolean | No | This is a Boolean that tracks whether or not the Endpoint is active. Default is true. |
| endpointAddress | String | No | This is a String associated with the address of the endpoint. |
| endpointPort | String | No | This is a port associated with an SSH connection. Note: Only applicable when connectionType is "SSH", otherwise not used. |
| password | String | No | This is a character sequence used to access the corresponding remote connection. Note: Only applicable when connectionType is "SSH" otherwise not used. |
| passwordCredentialId | Long | No | This is the id of the credential associated with the endpoint password. Note: Only applicable when connectionType is "SSH" otherwise not used. |
| endpointName | String | Yes | This is the unique name of the corresponding Endpoint. |
| privateKey | String | No | Fully-qualified path of the SSH private key file. Note: Only applicable when connectionType is "SSH" otherwise not used. |
| osType | String | No | This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. Note: Only applicable when connectionType is "SSH" otherwise not used. |
| baseDirectory | String | No | This is a character sequence which corresponds to the base directory of the corresponding Endpoint. |
| endpointSubgroup | String | No | This is a character sequence associated with this Endpoint's corresponding sub-group. |
| passphraseCredentialId | Long | No | This is the id of the credential associated with the endpoint passphrase. Note: Only valid if a privateKey is specified, or already configured for endpoint. |
| passphrase | String | No | An optional passphrase used when the private key was generated. Note: Only valid if a privateKey is specified, or already configured for endpoint. |
| javaPath | String | No | This is a character sequence that specifies the java path of the corresponding Endpoint. |
| runAsUserName | String | No | An optional user to run as (using sudo) after establishing connection to the endpoint. Note: Only applicable when connection Type is "SSH" otherwise not used. |
| dockerHost | Boolean | No | This indicates if endpoint is docker engine. Defaults to false. |
| k8sCluster | Boolean | No | This indicates if endpoint is kubernetes engine. Defaults to false. |
| k8sContext | String | No | Name of the configured K8s context. |
...