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.

Authentication - Use Basic Authentication for this API.

GET

There are two implementations of GET. One will find an Endpoint with the given Id and return the JSON representation of the Endpoint. The other will find a list of Endpoints matching the parameters supplied to it.

GET by ID

This GET service will find an Endpoint with the given Id and return the JSON representation of the object.

API URL

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

Request

Parameter	Required	Type	Description
Id	Yes	URL	This is a URL parameter for the Id which is used to find and return an Endpoint

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 a number associated with the 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	This is a character sequence associated with the correspond remote connection.
javaPath	String	This is a character sequence that specifies the java path of the corresponding Endpoint.
runAsUserName	String	This is a character sequence that specifies the runAsUserName variable.
dockerHost	Boolean	This indicates if endpoint is docker engine.
k8sCluster	Boolean	This indicates if endpoint is kubernetes engine.
k8sContext	String	Kubernetes context.

Response Codes

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

Example

If we had an endpoint in our database with an Id of 13901 and had the following attributes

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

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.

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}

The query parameters are not case sensitive. Searching by name=NAME is the same as searching by name=name.

Request

Parameter	Required	Type	Description
endpointName	No	URL	This is a URL query parameter for the name which is used to search the endpoints.
endpointAddress	No	URL	This is a URL query parameter for the address which is used to search the endpoints.
endpointGroup	No	URL	This is a URL query parameter for the group which is used to search the endpoints.
endpointSubgroup	No	URL	This is a URL query parameter for the sub group which is used to search the endpoints.

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 a number associated with the 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	This is a character sequence associated with the correspond remote connection.
javaPath	String	This is a character sequence that specifies the java path of the corresponding Endpoint.
runAsUserName	String	This is a character sequence that specifies the runAsUserName variable.
dockerHost	Boolean	This indicates if endpoint is docker engine.
k8sCluster	Boolean	This indicates if endpoint is kubernetes engine.
k8sContext	String	Kubernetes context.

Response Codes

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

Example

If we had an endpoints in our database with a Ids of 14517, and 14518 and the following attributes

Endpoint - 14517

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

Endpoint 14518

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

Endpoint GET Return JSON

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

This POST service will create a new Endpoint with the same attributes as the given JSON object.

API URL

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

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.
dockerHost	Boolean	No	This indicates if endpoint is docker engine.
k8sCluster	Boolean	No	This indicates if endpoint is kubernetes engine.
k8sContext	String	No	Kubernetes context.

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 a number associated with the 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	This is a character sequence associated with the correspond remote connection.
javaPath	String	This is a character sequence that specifies the java path of the corresponding Endpoint.
runAsUserName	String	This is a character sequence that specifies the runAsUserName variable.
dockerHost	Boolean	This indicates if endpoint is docker engine.
k8sCluster	Boolean	This indicates if endpoint is kubernetes engine.
k8sContext	String	Kubernetes context.

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,

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

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.

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.
dockerHost	Boolean	No	This indicates if endpoint is docker engine.
k8sCluster	Boolean	No	This indicates if endpoint is kubernetes engine.
k8sContext	String	No	Kubernetes context.

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 a number associated with the 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	This is a character sequence associated with the correspond remote connection.
javaPath	String	This is a character sequence that specifies the java path of the corresponding Endpoint.
runAsUserName	String	This is a character sequence that specifies the runAsUserName variable.
dockerHost	Boolean	This indicates if endpoint is docker engine.
k8sCluster	Boolean	This indicates if endpoint is kubernetes engine.
k8sContext	String	Kubernetes context.

Response Codes

HTTP Code	Description
201	Endpoint was created successfully
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 11101 and had the following attributes

EndPoint Attributes as JSON

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

When we run a PUT request at the following URL

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

And the PUT request receives the following JSON endpoint object,

Endpoint PUT Receive 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"
}

The PUT request would then update the endpoint with Id 11101 and return the following JSON endpoint object.

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.

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.
dockerHost	Boolean	No	This indicates if endpoint is docker engine.
k8sCluster	Boolean	No	This indicates if endpoint is kubernetes engine.
k8sContext	String	No	Kubernetes context.

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 a number associated with the 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	This is a character sequence associated with the correspond remote connection.
javaPath	String	This is a character sequence that specifies the java path of the corresponding Endpoint.
runAsUserName	String	This is a character sequence that specifies the runAsUserName variable.
dockerHost	Boolean	This indicates if endpoint is docker engine.
k8sCluster	Boolean	This indicates if endpoint is kubernetes engine.
k8sContext	String	Kubernetes context.

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

Endpoint PATCH JSON

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

Endpoint PATCH input JSON

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

Endpoint PATCH Return JSON

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

Browser not supported