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

{
    "endpointId": 13910,
    "endpointName": "GOODPOST1",
    "description": "description",
    "isActive": true,
    "connectionType": "SSH",
    "osType": "UNIX",
    "endpointAddress": "NotNeeded00",
    "endpointPort": "1",
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "isBaseDirectoryExpression": "N",
    "javaPath": "ServerJavaHome",
    "isJavaPathExpression": "N",
    "userName": "userName",
    "passwordCredentialId": 12345,
    "privateKey": "privateKey",
    "runAsUserName": "TestInput",
    "endpointGroup": "endpointGroup",
    "endpointSubgroup": "subGroupTester",
	"endpointSubgroupendpointSourceScript": "subGroupTesterexport VAR1=hello"

}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v2/topology/endpoint/13901

The GET request would return the following JSON endpoint object

Code Block

theme	Eclipse
title	Endpoint GET Return JSON

{
    "endpointId": 13910,
    "endpointName": "GOODPOST1",
    "description": "description",
    "isActive": true,
    "connectionType": "SSH",
    "osType": "UNIX",
    "endpointAddress": "NotNeeded00",
    "endpointPort": "1",
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "isBaseDirectoryExpression": "N",
    "javaPath": "ServerJavaHome",
    "isJavaPathExpression": "N",
    "userName": "userName",
    "password": "*****",
    "passwordCredentialId": 12345,
    "privateKey": "privateKey",
    "passphrase": "*****",
    "passphraseCredentialId": 54321,
    "runAsUserName": "TestInput",
    "endpointGroup": "endpointGroup",
    "endpointSubgroup": "subGroupTester",
	"endpointSourceScript": "export VAR1=hello"

}

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/v2/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}

isActive={boolean}

Examples:

To Specify the name parameter only:

http://host:port/flexdeploy/rest/v2/topology/endpoint?endpointName={name}

To Specify isActive parameter Only:

http://host:port/flexdeploy/rest/v2/topology/endpoint?isActive=true

To Specify the name and group parameters:

http://host:port/flexdeploy/rest/v2/topology/endpoint?endpointName={name}&endpointGroup={group}

To Specify the name, address and group parameters:

http://host:port/flexdeploy/rest/v2/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

language	js
theme	Eclipse
title	Endpoint - 14517

{
    "endpointId": 14517,
    "endpointName": "Motel6",
    "description": null,
    "isActive": true,
    "connectionType": "LOCALHOST",
    "osType": null,
    "endpointAddress": "localhost",
    "endpointPort": null,
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "isBaseDirectoryExpression": "N",
    "javaPath": "ServerJavaHome",
    "isJavaPathExpression": "N",
    "userName": null,
    "passwordCredentialId": null,
    "privateKey": null,
    "passphrase": null,
    "passphraseCredentialId": null,
    "runAsUserName": null,
    "endpointGroup": "Germany",
    "endpointSubgroup": "Munich",
	"endpointSourceScript": "export VAR1=hello"
}

Code Block

theme	Eclipse
title	Endpoint 14518

{
    "endpointId": 14518,
    "endpointName": "Raddison Hotel",
    "description": null,
    "isActive": true,
    "connectionType": "LOCALHOST",
    "osType": null,
    "endpointAddress": "localhost",
    "endpointPort": null,
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "isBaseDirectoryExpression": "N",
    "javaPath": "ServerJavaHome",
    "isJavaPathExpression": "N",
    "userName": null,
    "passphraseCredentialId": null,
    "passwordCredentialId": null,
    "privateKey": null,
    "password": null,
    "passphrase": null,
    "runAsUserName": null,
    "endpointGroup": "Germany",
    "endpointSubgroup": "Berlin",
	"endpointSourceScript": "export VAR1=hello"
}

When we run a GET request at the following URL

http://host:port/flexdeploy/rest/v2/topology/endpoint?endpointGroup=Germany

The GET request would return the following JSON endpoint object

Code Block

theme	Eclipse
title	Endpoint GET Return JSON

[
    {
        "description": null,
        "password": null,
        "passwordCredentialId": null,
        "userName": null,
        "isActive": true,
        "privateKey": null,
        "baseDirectory": "ServerInstallRoot + '/localhost'",
        "osType": null,
        "javaPath": "ServerJavaHome",
        "endpointName": "Motel6",
		"isBaseDirectoryExpression": "N",
        "endpointAddress": "localhost",
        "endpointId": 14517,
        "passphrase": null,
        "passphraseCredentialId": null,
        "connectionType": "LOCALHOST",
		"isJavaPathExpression": "N",
        "endpointPort": null,
        "endpointGroup": "Germany",
        "endpointSubgroup": "Munich",
        "runAsUserName": null,
		"endpointSourceScript": "export VAR1=hello"
    },
    {
        "description": null,
        "password": null,
        "passwordCredentialId": null,
        "userName": null,
        "isActive": true,
        "privateKey": null,
        "baseDirectory": "ServerInstallRoot + '/localhost'",
        "osType": null,
        "javaPath": "ServerJavaHome",
        "endpointName": "Raddison Hotel",
		"isBaseDirectoryExpression": "N",
        "endpointAddress": "localhost",
        "endpointId": 14518,
        "passphrase": null,
        "passphraseCredentialId": null,
        "connectionType": "LOCALHOST",
		"isJavaPathExpression": "N",
        "endpointPort": null,
        "endpointGroup": "Germany",
        "endpointSubgroup": "Berlin",
        "runAsUserName": null,
		"endpointSourceScript": "export VAR1=hello"
    }
]

Code Blocktheme

EclipsetitleTestresult

POST

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

...

Attributes	Type	Required	Description
endpointName	String	Yes	This is the unique name of the corresponding Endpoint.
description	String	No	A description of the Endpoint.
isActive	Boolean	No	This is a Boolean that tracks whether or not the Endpoint is active. Default is true.
connectiontype	String	Yes	This specifies the connection Type. "SSH" or "LOCALHOST"
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.
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.
baseDirectory	String	Yes	This is a character sequence which corresponds to the base directory of the corresponding Endpoint.
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.
password	String	Dependent	Allowed for backward compatibility, as this is replaced by passwordCredentialId. Only password or passwordCredentialId can be provided. If password is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
passwordCredentialId	Long	Dependent	This is the id of the credential associated with the endpoint password. Dependency: Either passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used.
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.
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	Allowed for backward compatibility, as this is replaced by passphraseCredentialId. Only passphrase or passphraseCredentialId can be provided. If passphrase is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
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.
endpointSubgroup	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group.
endpointSourceScript	String	No	This is a script that will be executed when connecting to an endpoint to source variables.

Include Page

	REST V1 Endpoint Response
	REST V1 Endpoint Response

...

Example

If the POST request receives the following JSON endpoint object,

Code Block

theme	Eclipse
title	POST JSON

{
    "password": "myPassword",
    "passwordCredentialId": null,
    "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",
    "passphraseCredentialId": null,
	"endpointSourceScript": "export VAR1=hello"
}

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

Code Block

theme	Eclipse
title	Endpoint POST Return JSON

{
    "endpointId": 13922,
    "endpointName": "GoodPost",
    "description": "description",
    "isActive": true,
    "connectionType": "SSH",
    "osType": "UNIX",
    "endpointAddress": "NotNeeded00",
    "endpointPort": "1",
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "isBaseDirectoryExpression": "N",
    "javaPath": "ServerJavaHome",
    "isJavaPathExpression": "N",
    "userName": "userName",
    "passphraseCredentialId": 29084,
    "password": "*****",
    "passwordCredentialId": 74839,
    "privateKey": "privateKey",
    "passphrase": "*****",
    "runAsUserName": "TestInput",
    "endpointGroup": "endpointGroup",
    "endpointSubgroup": "subGroupTester",
	"endpointSourceScript": "export VAR1=hello"
}

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/v2/topology/endpoint/{Id}

Request

Attributes	Type	Required	Description
Id	URL	Yes	URL parameter to specify which endpoint to replace
endpointName	String	Yes	This is the unique name of the corresponding Endpoint.
description	String	No	A description of the Endpoint.
isActive	Boolean	No	This is a Boolean that tracks whether or not the Endpoint is active. Default is true.
connectiontype	String	Yes	This specifies the connection Type. "SSH" or "LOCALHOST"
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.
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.
baseDirectory	String	Yes	This is a character sequence which corresponds to the base directory of the corresponding Endpoint.
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.
password	String	Dependent	Allowed for backward compatibility, as this is replaced by passwordCredentialId. Only password or passwordCredentialId can be provided. If password is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
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.
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.
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	Allowed for backward compatibility, as this is replaced by passphraseCredentialId. Only passphrase or passphraseCredentialId can be provided. If passphrase is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
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.
endpointSubgroup	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group.
endpointSourceScript	String	No	This is a script that will be executed when connecting to an endpoint to source variables.

Include Page

	REST V1 Endpoint Response
	REST V1 Endpoint Response

...

Code Block

theme	Eclipse
title	EndPoint Attributes as JSON

{
   "description": "description",
   "userName": "userName",
   "passwordCredentialId": 74839,
   "isActive": true,
   "privateKey": "privateKey",
   "endpointName": "GoodPost3",
   "osType": null,
   "connectionType": "SSH",
   "javaPath": "ServerJavaHome",
   "endpointAddress": "endpointAddress",
   "baseDirectory": "ServerInstallRoot + '/localhost'",
   "passphrase": "passphrase",
   "passphraseCredentialId": 29084,
   "endpointId": 11101,
   "endpointGroup": "endpointGroup",
   "endpointPort": null,
   "runAsUserName": "runAsUserName",
   "endpointSubgroup": "endpointSubgroup",
   "endpointSourceScript": null
}

When we run a PUT request at the following URL

...

Code Block

theme	Eclipse
title	Endpoint PUT Receive JSON

{
   "description": "newDescription",
   "userName": "newUserName",
   "password": "newPassword",
   "passwordCredentialId": null,
   "isActive": true,
   "privateKey": "newPrivateKey",
   "endpointName": "GoodPost3",
   "osType": "UNIX",
   "connectionType": "SSH",
   "javaPath": "ServerJavaHome",
   "endpointAddress": "endpointAddress",
   "baseDirectory": "ServerInstallRoot + '/localhost'",
   "passphrase": "passphrase",
   "passphraseCredentialId": null,
   "endpointId": null,
   "endpointGroup": "endpointGroup",
   "endpointPort": null,
   "runAsUserName": "runAsUserName",
   "endpointSubgroup": "endpointSubgroup",
   "endpointSourceScript": "export VAR1=hello"
}

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

Code Block

theme	Eclipse
title	Endpoint PUT Return JSON

{
   "description": "newDescription",
   "userName": "newUserName",
   "password": "newPassword",
   "passwordCredentialId": 74839,
   "isActive": true,
   "privateKey": "newPrivateKey",
   "endpointName": "GoodPost3",
   "osType": "UNIX",
   "connectionType": "SSH",
   "isJavaPathExpression": "N",
   "javaPath": "ServerJavaHome",
   "endpointAddress": "endpointAddress",
   "baseDirectory": "ServerInstallRoot + '/localhost'",
   "passphrase": "passphrase",
   "passphraseCredentialId": 29084,
   "endpointId": null,
   "endpointGroup": "endpointGroup",
   "endpointPort": null,
   "runAsUserName": "runAsUserName",
   "isBaseDirectoryExpression": "N",
   "endpointSubgroup": "endpointSubgroup",
   "endpointSourceScript": "export VAR1=hello"
}

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

title	API URL

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

...

Attributes	Type	Required	Description
Id	URL	Yes	URL parameter to specify which endpoint to patch
endpointName	String	Yes	This is the unique name of the corresponding Endpoint.
description	String	No	A description of the Endpoint.
isActive	Boolean	No	This is a Boolean that tracks whether or not the Endpoint is active. Default is true.
connectiontype	String	No	This specifies the connection Type. "SSH" or "LOCALHOST"
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.
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.
baseDirectory	String	No	This is a character sequence which corresponds to the base directory of the corresponding Endpoint.
javaPath	String	No	This is a character sequence that specifies the java path of the corresponding Endpoint.
password	String	No	Allowed for backward compatibility, as this is replaced by passwordCredentialId. Only password or passwordCredentialId can be provided. If password is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
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.
privateKey	String	No	Fully-qualified path of the SSH private key file. Note: Only applicable when connectionType is "SSH" otherwise not used.
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	Allowed for backward compatibility, as this is replaced by passphraseCredentialId. Only passphrase or passphraseCredentialId can be provided. If passphrase is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
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.
endpointSubgroup	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group.
endpointSourceScript	String	No	This is a script that will be executed when connecting to an endpoint to source variables.

Include Page

	REST V1 Endpoint Response
	REST V1 Endpoint Response

...

Example

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

Code Block

theme	Eclipse
title	Endpoint PATCH JSON

{
    "passwordCredentialId": 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,
    "passphraseCredentialId": null,
	"endpointSourceScript": null
}

When we run a PATCH request at the following URL

http://host:port/flexdeploy/rest/v2/topology/endpoint/13909

And the PATCH request receives the following JSON endpoint object,

Code Block

theme	Eclipse
title	Endpoint PATCH input JSON

{
    "endpointName": "PatchedEndpoint",
    "endpointGroup": null
}

The PATCH request would then update the endpoint with Id 13909 and return the following JSON endpoint object

Code Block

theme	Eclipse
title	Endpoint PATCH Return JSON

{
    "password": null,
    "passwordCredentialId": null,
    "description": null,
    "userName": null,
    "privateKey": null,
    "isActive": true,
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "endpointName": "PatchedEndpoint",
    "isBaseDirectoryExpression": "N",
    "connectionType": "LOCALHOST",
	"isJavaPathExpression": "N",
    "endpointAddress": "localhost",
    "endpointId": 13909,
    "endpointSubgroup": null,
    "endpointPort": null,
    "endpointGroup": "TheGroup",
    "runAsUserName": null,
    "osType": null,
    "javaPath": "ServerJavaHome",
    "passphrase": null,
    "passphraseCredentialId": null,
	"endpointSourceScript": null
}

Versions Compared

Old Version 2

New Version Current

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 isActive parameter Only:

To Specify the name and group parameters:

To Specify the name, address and group parameters:

POST

Example

PUT

Request

PATCH

Example

Page Comparison

Versions Compared

Old Version 2

New Version Current

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 isActive parameter Only:

To Specify the name and group parameters:

To Specify the name, address and group parameters:

POST

Example

PUT

Request

PATCH

Example