Anchor

	Top
	Top

...

Each function returns a JSON endpoint object. The endpoint object has these attributes:

Insert excerpt

	Topology API
	Topology API

AttributesTypeDescriptiondescriptionString

This is a description of the Endpoint.

OPTIONAL

connectionTypeString

This specifies the connection Type.

MANDATORY: "SSH" or "LOCALHOST"

isActiveBoolean

This is a Boolean that tracks whether or not the Endpoint is active.

MANDATORY

endpointAddressString

This is a String associated with the address of the endpoint.

DEPENDENT: Mandatory when connectionType is "SSH", otherwise not used.

endpointPortString

This is a port associated with an SSH connection.

DEPENDENT: Mandatory when connectionType is "SSH", otherwise not used.

endpointIdLong

This is a number associated with the identification number of an existing Endpoint.

UNIQUE

passwordString

This is a character sequence used to access the corresponding remote connection.

DEPENDENT: Optional when connectionType is "SSH" otherwise not used.

endpointNameString

This is the unique name of the corresponding Endpoint.

UNIQUE

privateKeyString

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

DEPENDENT: Optional when connectionType is "SSH" otherwise not used.

osTypeString

This is a character sequence which corresponds to the operating system type used in the corresponding remote connection.

DEPENDENT: Mandatory when connectionType is "SSH" otherwise not used.

baseDirectoryString

This is a character sequence which corresponds to the base directory of the corresponding Endpoint.

MANDATORY

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

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

DEPENDENT: Optional when connectionType is "SSH" otherwise not used.

javaPathString

This is a character sequence that specifies the java path of the corresponding Endpoint.

MANDATORY

runAsUserNameString

This is a character sequence that specifies the runAsUserName variable.

DEPENDENT: Optional when connection Type is "SSH" otherwise not used.

Back to Top

...

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.

Info

title	API URL

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

Parameters

Parameter

Required

Type

Description

IdYesURLThis is a URL parameter for the Id which is used to find and return an Endpoint

Response Codes

HTTP CodeDescription200Endpoint was found and returned400Bad request401Unauthorized500Unexpected internal server error

Example

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

Code BlocktitleEndpoint 13910

nopanel	true

Back to Top

...

Anchor

	GET
	GET

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.

Info

title	API URL

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

Parameters

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

Code Block

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

title	Endpoint GET Return JSON

{

"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

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": "*****"

}

Back To Top

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}

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

Parameters

...

Parameter

...

Required

...

Type

...

Description

...

Response Codes

...

Example

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

Code Block

theme	Eclipse
title	Endpoint - 14517

{ "description": null, "password": null, "userName": null, "isActive": true, "privateKey": null, "baseDirectory": "

Back To Top

...

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}

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

Parameters

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

Code Block

theme	Eclipse
title	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
}

Code Block

theme	Eclipse
title	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

Code Block

title	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
}
]

Back to Top

...

POST

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

Info

title	API URL

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

Parameters

AttributesTypeRequiredDescriptiondescriptionStringNoA description of the Endpoint.connectiontypeStringYes

This specifies the connection Type. 'SSH' or 'LOCALHOST'

isActiveBooleanNo

This is a Boolean that tracks whether or not the Endpoint is active. Default is true.

endpointAddressStringNoThis is a String associated with the address of the endpoint.endpointPortStringDependent

This is a port associated with an SSH connection.

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

endpointIdLongNoThis is a number associated with the identification number of an existing Endpoint.passwordStringDependent

This is a character sequence used to access the corresponding remote connection.

Dependency: mandatory when connectionType is "SSH" otherwise not used.

endpointNameStringYes

This is the unique name of the corresponding Endpoint. Must be unique.

privateKeyStringDependent

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

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

osTypeStringDependent

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.

baseDirectoryStringYes

This is a character sequence which corresponds to the base directory of the corresponding Endpoint.

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

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

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

javaPathStringYes

This is a character sequence that specifies the java path of the corresponding Endpoint.

runAsUserNameStringDependent

This is a character sequence that specifies the runAsUserName variable.

Dependency: Mandatory when connection Type is "SSH" otherwise not used.

HTTP CodeDescription200Endpoint was found and returned400Bad request401Unauthorized500Unexpected internal server error

Example

If the POST request receives the following JSON endpoint object,

Code Block

title	POST JSON

{

"password": "myPassword",
"description": "description",
"userName": "userName",
"privateKey": "privateKey"
"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

title	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": "GoodPostRaddison Hotel",
"connectionTypeendpointAddress": "SSHlocalhost",
"endpointAddressendpointId": "NotNeeded00"14518,
"endpointIdpassphrase": null,
"endpointSubgroupconnectionType": "subGroupTesterLOCALHOST",
"endpointPort": "1"null,
"endpointGroup": "endpointGroupGermany",
"runAsUserNameendpointSubgroup": "TestInputBerlin",
"osTyperunAsUserName": "UNIX",
"javaPath": "ServerJavaHome",
"passphrase": "myPassphrase"

}

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

Code Block

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": "*****"

}

Back to Top

...

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}

Parameters

AttributesTypeRequiredDescriptiondescriptionStringNoA description of the Endpoint.connectionTypeStringYes

This specifies the connection Type. 'SSH' or 'LOCALHOST'

isActiveBooleanNo

This is a Boolean that tracks whether or not the Endpoint is active. Default is true.

endpointAddressStringNoThis is a String associated with the address of the endpoint.endpointPortStringDependent

This is a port associated with an SSH connection.

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

endpointIdLongNoThis is a number associated with the identification number of an existing Endpoint.passwordStringDependent

This is a character sequence used to access the corresponding remote connection.

Dependency: mandatory when connectionType is "SSH" otherwise not used.

endpointNameStringYes

This is the unique name of the corresponding Endpoint. Must be unique.

privateKeyStringDependent

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

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

osTypeStringDependent

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.

baseDirectoryStringYes

This is a character sequence which corresponds to the base directory of the corresponding Endpoint.

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

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

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

javaPathStringYes

This is a character sequence that specifies the java path of the corresponding Endpoint.

runAsUserNameStringDependent

This is a character sequence that specifies the runAsUserName variable.

Dependency: Mandatory when connection Type is "SSH" otherwise not used.

Response Codes

HTTP Code

Description

201Endpoint was created successfully400Bad request401Unauthorized404Endpoint not found500Unexpected internal server error

Info

title	API URL

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

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

Code Block

title	EndPoint Attributes as JSON

{
   null
}
]

Back to Top

Anchor

	POST
	POST

POST

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

Info

title	API URL

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

Parameters

Insert excerpt

	Topology API
	Topology API
nopanel	true

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.

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

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 Block

title	Endpoint POST Return JSON

{

"password": "*****",
"description": "description",
  
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"passwordbaseDirectory": "password",
   "isActive"ServerInstallRoot + '/localhost'",
"endpointName": true"GoodPost",
   "privateKeyconnectionType": "privateKeySSH",
   "endpointNameendpointAddress": "GoodPost3NotNeeded00",
   "osTypeendpointId": null13922,
  
"connectionTypeendpointSubgroup": "SSHsubGroupTester",
   "javaPathendpointPort": "ServerJavaHome1",
   "endpointAddressendpointGroup": "endpointAddressendpointGroup",
   "baseDirectoryrunAsUserName": "ServerInstallRoot + '/localhost'TestInput",
  
"passphraseosType": "passphraseUNIX",
   "endpointIdjavaPath": 11101"ServerJavaHome",
   "endpointGrouppassphrase": "endpointGroup",
   "endpointPort": null,
   "runAsUserName": "runAsUserName",
   "endpointSubgroup": "endpointSubgroup"
}

When we run a PUT request at the following

*****"

}

Back to Top

Anchor

	PUT
	PUT

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}

Parameters

Insert excerpt

	Topology API
	Topology API
nopanel	true

Response Codes

HTTP Code	Description
201	Endpoint was created successfully
400	Bad request
401	Unauthorized
404	Endpoint not found
500	Unexpected internal server error

Info

title	API URL

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

endpoint/11101And the PUT request receives the following JSON endpoint object,

endpoint/{Id}

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

Code Block

title	Endpoint PUT Receive EndPoint Attributes as JSON

{
   "description": "newDescriptiondescription",
   "userName": "newUserNameuserName",
   "password": "newPasswordpassword",
   "isActive": true,
   "privateKey": "newPrivateKeyprivateKey",
   "endpointName": "GoodPost3",
   "osType": "UNIX"null,
   "connectionType": "SSH",
   "javaPath": "ServerJavaHome",
   "endpointAddress": "endpointAddress",
   "baseDirectory": "ServerInstallRoot + '/localhost'",
   "passphrase": "passphrase",
   "endpointId": null11101,
   "endpointGroup": "endpointGroup",
   "endpointPort": null,
   "runAsUserName": "runAsUserName",
   "endpointSubgroup": "endpointSubgroup"
}

The When we run a PUT request would then update the endpoint with Id 11101 and return at the following URL

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

And the PUT request receives the following JSON endpoint object.,

Code Block

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

Code Block

title	Endpoint PUT Return JSON

{
   "endpointGroupdescription": "endpointGroupnewDescription",
   "endpointPortuserName": null"newUserName",
   "runAsUserNamepassword": "runAsUserNamenewPassword",
   "endpointSubgroup": "endpointSubgroup"
}

Back to Top

...

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}

Parameters

...

This specifies the connection Type. 'SSH' or 'LOCALHOST'

...

This is a Boolean that tracks whether or not the Endpoint is active. Default is true.

...

This is a port associated with an SSH connection.

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

...

This is a character sequence used to access the corresponding remote connection.

Dependency: mandatory when connectionType is "SSH" otherwise not used.

...

This is the unique name of the corresponding Endpoint. Must be unique.

...

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

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

...

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.

...

This is a character sequence which corresponds to the base directory of the corresponding Endpoint.

...

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 java path of the corresponding Endpoint.

...

This is a character sequence that specifies the runAsUserName variable.

...

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

Back to Top

Anchor

	PATCH
	PATCH

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}

Parameters

Insert excerpt

	Topology API
	Topology API
nopanel	true

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

...

Page Comparison

Versions Compared

Old Version 17

New Version 18

Key

GET

GET by ID

Parameters

Response Codes

Example

GET

GET by ID

Parameters

Response Codes

Example

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:

Parameters

Response Codes

Example

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:

Parameters

Response Codes

Example

POST

Parameters

Example

PUT

Parameters

Response Codes

POST

Parameters

Example

PUT

Parameters

Response Codes

PATCH

Parameters

PATCH

Parameters

Response Codes