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, 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",
"passwordCredentialId": 12345,
"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",
"passphraseCredentialId": 54321
}

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": "*****"*",
"passwordCredentialId": 12345,
"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": "*****",
"passphraseCredentialId": 54321
}

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}

...

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

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

Code Block

theme	Eclipse
title	Endpoint 14518

{
"description": null,
"password": null,
"passwordCredentialId": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Raddison Hotel",
"endpointAddress": "localhost",
"endpointId": 14518,
"passphrase": null,
"passphraseCredentialId": 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

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",
"endpointAddress": "localhost",
"endpointId": 14517,
"passphrase": null,
"passphraseCredentialId": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Munich"
"runAsUserName": null
},
{
"description": null,
"password": null,
"passwordCredentialId": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Raddison Hotel",
"endpointAddress": "localhost",
"endpointIdendpointId": 14518,
"passphrase": 14518null,
"passphrasepassphraseCredentialId": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Berlin",
"runAsUserName": null
}
]

POST

...

Info

title	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.

endpointIdLongNo

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

: Either password, passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used.

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.

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

Fully-qualified path of the SSH private key file.

Dependency:

Mandatory

Either password, passwordCredentialId, or privateKey is required 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

NoThis is a character sequence associated with this Endpoint's corresponding sub-group

This is a character sequence associated with the correspond remote connection.

Dependency: Mandatory when connectionType is "SSH" otherwise not used

No

This is a character sequence associated with this Endpoint's corresponding sub-group.

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

Dependent

No

An optional passphrase used when the private key was generated.

Note: Only valid if a privateKey is specified.

javaPath

String

Yes

This is a character sequence that specifies the java path of the

corresponding Endpoint

This is a character sequence that specifies the runAsUserName variable.

Dependency: Mandatory

corresponding Endpoint. Not required if the Endpoint is a Docker Host.
runAsUserName	String

Dependent

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

Kubernetes

Name of the configured K8s context.

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
}

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": "*****",
"passwordCredentialId": 74839,
"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": "*****"*",
"passphraseCredentialId": 29084
}

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

No.Dependency: mandatory . Must be uniqueThis is a character sequence associated with the corresponding remote connection Mandatory

This is a character sequence associated with the correspond remote connection.

Dependency: Mandatory when connectionType is "SSH" otherwise not used

This is a character sequence that specifies the runAsUserName variable.

Dependency: Mandatory

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	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: Either password, passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used.
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.
endpointName	String	Yes	This is the unique name of the corresponding Endpoint	.
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.
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.
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	Dependent	No	An optional passphrase used when the private key was generated. Note: Only valid if a privateKey is specified.
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.
runAsUserName	String	Dependent	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	Kubernetes Name of the configured K8s context.

Include Page

	REST V1 Endpoint Response
	REST V1 Endpoint Response

...

Code Block

theme	Eclipse
title	EndPoint Attributes as JSON

{
   "description": "description",
   "userName": "userName",
   "password": "password",
   "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"
}

...

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

...

Code Block

theme	Eclipse
title	Endpoint PUT Return JSON

{
   "description": "newDescription",
   "userName": "newUserName",
   "password": "newUserNamenewPassword",
   "passwordpasswordCredentialId": "newPassword"74839,
   "isActive": true,
   "privateKey": "newPrivateKey",
   "endpointName": "GoodPost3",
   "osType": "UNIX",
   "connectionType": "SSH",
   "javaPath": "ServerJavaHome",
   "endpointAddress": "endpointAddress",
   "baseDirectory": "ServerInstallRoot + '/localhost'",
   "passphrase": "passphrase",
   "passphraseCredentialId": 29084,
   "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 not provided, it will not be updated in the Endpoint.

Info

title	API URL

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

Request

Long

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

Note: Only applicable when connectionType is "SSH", otherwise not used.
password	String	No	This is a

number associated with the identification number of an existing Endpoint.passwordString

character sequence used to access the corresponding remote connection.

Note: Only applicable when connectionType is "SSH" otherwise not used.

passwordCredentialId

Long

No

This is

a character sequence used to access the corresponding remote connection

the id of the credential associated with the endpoint password.

Note: Only applicable when connectionType is "SSH" otherwise not used.

endpointName

String

No

Yes	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

	Fully-qualified path of the SSH private key file. Note: Only applicable when connectionType is "SSH" otherwise not used.
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.
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.passphraseStringNoThis is a character sequence associated with the correspond remote connection

sub-group.
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	An optional passphrase used when the private key was generated. Note: Only valid if a privateKey is specified, or already configured for endpoint.
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

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

Kubernetes

Name of the configured K8s context.

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

{
    "password": null,
    "passwordCredentialId": null,
    "description": null,
    "userName": null,
    "privateKey": null,
    "isActive": true,
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "endpointName": "NotPatchedYet",
    "connectionType": "LOCALHOST",
    "endpointAddress": "localhost",
    "endpointId": 13909,
    "endpointSubgroup": null, null,
    "endpointPort": null,
    "endpointGroup": "TheGroup",
    "runAsUserName": null,
    "osType": null,
    "javaPath": "ServerJavaHome",
    "passphrase": null,
    "passphraseCredentialId": 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

theme	Eclipse
title	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 the following JSON environment 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",
"connectionType": "LOCALHOST",
"endpointAddress": "localhost",
"endpointId": 13909,
"endpointSubgroup": null,
"endpointPort": null,
"endpointGroup": "TheGroup",
"runAsUserName": null,
"osType": null,
"javaPath": "ServerJavaHome",
"passphrase": null,"passphraseCredentialId": null
}

Version	Old Version 45	New Version 46
Changes made by	Chandresh Patel	Emily Simon
Saved on	Mar 04, 2019	Sept 12, 2019

Page Comparison

Versions Compared

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:

POST

Request

Example

PUT

Request

PATCH

Request

Example