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} |
...
If we had an endpoints in our database with a Ids of 14517, and 14518 and the following attributes
| Code Block | ||||||
|---|---|---|---|---|---|---|
| ||||||
{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Motel6",
"endpointAddress": "localhost",
"endpointId": 14517,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Munich"
"runAsUserName": null
} |
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Raddison Hotel",
"endpointAddress": "localhost",
"endpointId": 14518,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Berlin",
"runAsUserName": null
} |
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/v1/topology/endpoint?endpointGroup=Germany
The GET request would return the following JSON environment object
| Code Block | ||||
|---|---|---|---|---|
| ||||
[
{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Motel6",
"endpointAddress": "localhost",
"endpointId": 14517,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Munich"
"runAsUserName": null
},
{
"description": null,
"password": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Raddison Hotel",
"endpointAddress": "localhost",
"endpointId": 14518,
"passphrase": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Berlin",
"runAsUserName": null
}
] |
POST
...
Example
If the POST request receives the following JSON endpoint object,
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"password": "myPassword",
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "GoodPost",
"connectionType": "SSH",
"endpointAddress": "NotNeeded00",
"endpointId": null,
"endpointSubgroup": "subGroupTester",
"endpointPort": "1",
"endpointGroup": "endpointGroup",
"runAsUserName": "TestInput",
"osType": "UNIX",
"javaPath": "ServerJavaHome",
"passphrase": "myPassphrase"
} |
The following endpoint object would then be created as a new row in the database
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"password": "*****",
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "GoodPost",
"connectionType": "SSH",
"endpointAddress": "NotNeeded00",
"endpointId": 13922,
"endpointSubgroup": "subGroupTester",
"endpointPort": "1",
"endpointGroup": "endpointGroup",
"runAsUserName": "TestInput",
"osType": "UNIX",
"javaPath": "ServerJavaHome",
"passphrase": "*****"
} |
PUT
...
If we had an endpoint in our database with an Id of 11101 and had the following attributes
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
"description": "description",
"userName": "userName",
"password": "password",
"isActive": true,
"privateKey": "privateKey",
"endpointName": "GoodPost3",
"osType": null,
"connectionType": "SSH",
"javaPath": "ServerJavaHome",
"endpointAddress": "endpointAddress",
"baseDirectory": "ServerInstallRoot + '/localhost'",
"passphrase": "passphrase",
"endpointId": 11101,
"endpointGroup": "endpointGroup",
"endpointPort": null,
"runAsUserName": "runAsUserName",
"endpointSubgroup": "endpointSubgroup"
} |
...
And the PUT request receives the following JSON endpoint object,
| 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"
} |
The PUT request would then update the endpoint with Id 11101 and return the following JSON endpoint object.
| 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
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} |
...
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
} |