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

theme	Eclipse
title	Endpoint 13910

{
"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

theme	Eclipse
title	Endpoint GET Return JSON

{
"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

title	API URL

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}

...

Info

title	API URL

http://host:port/flexdeploy/rest/v1/topology/endpoint

...

Request

...

Response Codes

HTTP CodeDescription200Endpoint was found and returned400Bad request401Unauthorized500Unexpected internal server error

Example

If the POST request receives the following JSON endpoint object,

Code Block

theme	Eclipse
title	POST JSON

{
"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 BlockthemeEclipsetitleEndpoint POST Return

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

	REST V1 Endpoint Response
	REST V1 Endpoint Response

Response Codes

HTTP Code	Description
200	Endpoint was found and returned
400	Bad request
401	Unauthorized
500	Unexpected internal server error

Example

If the POST request receives the following JSON endpoint object,

Code Block

theme	Eclipse
title	POST JSON

{
"password": "*****myPassword",
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "GoodPost",
"connectionType": "SSH",
"endpointAddress": "NotNeeded00",
"endpointId": 13922null,
"endpointSubgroup": "subGroupTester",
"endpointPort": "1",
"endpointGroup": "endpointGroup",
"runAsUserName": "TestInput",
"osType": "UNIX",
"javaPath": "ServerJavaHome",
"passphrase": "*****"
}

PUT

This PUT service will update all attributes of an Endpoint with the given Id based on the attributes of a JSON objects parameter values.

Info

title	API URL

http://host:port/flexdeploy/rest/v1/topology/endpoint/{Id}

Include PageREST V1 Endpoint RequestREST V1 Endpoint Request

": "ServerJavaHome",
"passphrase": "myPassphrase"
}

The following endpoint object would then be created as a new row in the database

Code Block

theme	Eclipse
title	Endpoint POST Return JSON

{
"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

This PUT service will update all attributes of an Endpoint with the given Id based on the attributes of a JSON objects parameter values.

Info

title	API URL

http://host:port/flexdeploy/rest/v1/topology/endpoint/{Id}

Request

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

	REST V1 Endpoint Response
	REST V1 Endpoint Response

...

Code Block

theme	Eclipse
title	Endpoint PUT Return JSON

{
   "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

title	API URL

http://host:port/flexdeploy/rest/v1/topology/endpoint/{Id}

Request

Attributes	Type	Required	Description
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.
endpointId	Long	No	This is a number associated with the identification number of an existing Endpoint.
password	String	No	This is a character sequence used to access the corresponding remote connection.
endpointName	String	No	This is the unique name of the corresponding Endpoint. Must be unique.
privateKey	String	No	This is a character sequence associated with the corresponding remote connection.
osType	String	No	This is a character sequence which corresponds to the operating system type used in the corresponding remote connection.
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.
passphrase	String	No	This is a character sequence associated with the correspond remote connection.
javaPath	String	No	This is a character sequence that specifies the java path of the corresponding Endpoint.
runAsUserName	String	No	This is a character sequence that specifies the runAsUserName variable.

...

Versions Compared

Old Version 38

New Version 39

Key

GET (Using Query Parameters)

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

Examples:

To Specify the name parameter only:

To Specify the name and group parameters:

To Specify the name, address and group parameters:

Request

Response Codes

Example

Response Codes

Example

PUT

PUT

Request

PATCH

Request

Page Comparison

Versions Compared

Old Version 38

New Version 39

Key

GET (Using Query Parameters)

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

Examples:

To Specify the name parameter only:

To Specify the name and group parameters:

To Specify the name, address and group parameters:

Request

Response Codes

Example

Response Codes

Example

PUT

PUT

Request

PATCH

Request