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",
"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"
} |
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": "*****",
"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": "*****"
} |
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} |
...
Parameters
| 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. |
| endpointId | Long | No | This is a number associated with the identification number of an existing Endpoint. |
| password | String | Dependent | This is a character sequence used to access the corresponding remote connection. Dependency: mandatory when connectionType is "SSH" otherwise not used. |
| endpointName | String | Yes | This is the unique name of the corresponding Endpoint. Must be unique. |
| privateKey | String | Dependent | This is a character sequence associated with the corresponding remote connection. Dependency: Mandatory 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. |
| passphrase | String | Dependent | This is a character sequence associated with the correspond remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used. |
| javaPath | String | Yes | This is a character sequence that specifies the java path of the corresponding Endpoint. |
| runAsUserName | String | Dependent | This is a character sequence that specifies the runAsUserName variable. Dependency: Mandatory when connection Type is "SSH" otherwise not used. |
| Include Page | ||||
|---|---|---|---|---|
|
Response Codes
HTTP Code | Description |
|---|---|
| 201 | Endpoint was created successfully |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Endpoint not found |
| 500 | Unexpected internal server error |
...
| title | API URL |
|---|
...
Example
If we had an endpoint in our database with an Id of 11101 and had the following attributes
...
| Code Block | ||
|---|---|---|
| ||
{
"description": "newDescription",
"userName": "newUserName",
"password": "newPassword",
"isActive": true,
"privateKey": "newPrivateKey",
"endpointName": "GoodPost3",
"osType": "UNIX",
"connectionType": "SSH",
"javaPath": "ServerJavaHome",
"endpointAddress": "endpointAddress",
"baseDirectory": "ServerInstallRoot + '/localhost'",
"passphrase": "passphrase",
"endpointId": null,
"endpointGroup": "endpointGroup",
"endpointPort": null,
"runAsUserName": "runAsUserName",
"endpointSubgroup": "endpointSubgroup"
} |
...
...
PATCH
...
PATCH
This PATCH service will update an existing endpoint with the information passed through a JSON object. If an attribute is absent of its value is null it will not be updated in the Endpoint.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/topology/endpoint/{Id} |
Parameters
...
Response Codes
| 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. |
| endpointId | Long | No | This is a number associated with the identification number of an existing Endpoint. |
| password | String | Dependent | This is a character sequence used to access the corresponding remote connection. Dependency: mandatory when connectionType is "SSH" otherwise not used. |
| endpointName | String | Yes | This is the unique name of the corresponding Endpoint. Must be unique. |
| privateKey | String | Dependent | This is a character sequence associated with the corresponding remote connection. Dependency: Mandatory 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. |
| passphrase | String | Dependent | This is a character sequence associated with the correspond remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used. |
| javaPath | String | Yes | This is a character sequence that specifies the java path of the corresponding Endpoint. |
| runAsUserName | String | Dependent | This is a character sequence that specifies the runAsUserName variable. Dependency: Mandatory when connection Type is "SSH" otherwise not used. |
| Include Page | ||||
|---|---|---|---|---|
|
Response Codes
HTTP Code | Description |
|---|---|
| 200 | Endpoint was found and updated |
| 400 | Bad request |
| 401 | Unauthorized |
| 404 | Endpoint not found |
| 500 | Unexpected internal server error |
Example
If we had an endpoint in our database with an Id of 13909 and had the following attributes
| Code Block | ||
|---|---|---|
| ||
{
"password": null,
"description": null,
"userName": null,
"privateKey": null,
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "NotPatchedYet",
"connectionType": "LOCALHOST",
"endpointAddress": "localhost",
"endpointId": 13909,
"endpointSubgroup": null,
"endpointPort": null,
"endpointGroup": "TheGroup",
"runAsUserName": null,
"osType": null,
"javaPath": "ServerJavaHome",
"passphrase": null
} |
When we run a PATCH request at the following URL
http://host:port/flexdeploy/rest/v1/topology/endpoint/13909
And the PATCH request receives the following JSON environment object,
| Code Block | ||
|---|---|---|
| ||
{
"endpointName": "PatchedEndpoint",
"endpointId": 12005,
"endpointGroup": null
} |
The PATCH request would then update the environment with Id 13909 (id is passed through the URL) and return the following JSON environment object
| Code Block | ||
|---|---|---|
| ||
{
"password": null,
"description": null,
"userName": null,
"privateKey": null,
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "PatchedEndpoint",
"connectionType": "LOCALHOST",
"endpointAddress": "localhost",
"endpointId": 13909,
"endpointSubgroup": null,
"endpointPort": null,
"endpointGroup": "TheGroup",
"runAsUserName": null,
"osType": null,
"javaPath": "ServerJavaHome",
"passphrase": null
} |