Anchor

	Top
	Top

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

Attributes	Type	Description
Descriptiondescription	String	This is a description of the Endpoint.
Connection TypeconnectionType	String	This specifies the connection Type. MANDATORY: "SSH" or "LOCALHOST"
isActive	Boolean	This is a Boolean that tracks whether or not the Endpoint is active.
Endpoint AddressendpointAddress	String	This is a String associated with the address of the endpoint.
Endpoint PortendpointPort	String	This is a port associated with an SSH connection. DEPENDENT: Mandatory when connectionType is "SSH", otherwise not used.
Endpoint IdendpointId	Long	This is a number associated with the identification number of an existing Endpoint.
Passwordpassword	String	This is a character sequence used to access the corresponding remote connection. DEPENDENT: mandatory when connectionType is "SSH" otherwise not used.
Endpoint NameendpointName	String	This is the unique name of the corresponding Endpoint. UNIQUE
Private KeyprivateKey	String	This is a character sequence associated with the corresponding remote connection. DEPENDENT: Mandatory when connectionType is "SSH" otherwise not used.
OS TypeosType	String	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.
Base DirectorybaseDirectory	String	This is a character sequence which corresponds to the base directory of the corresponding Endpoint. MANDATORY
Endpoint Sub GroupendpointSubgroup	String	This is a character sequence associated with this Endpoint's corresponding sub-group.
Passphrasepassphrase	String	This is a character sequence associated with the correspond remote connection. DEPENDENT: Mandatory when connectionType is "SSH" otherwise not used.
Java PathjavaPath	String	This is a character sequence that specifies the java path of the corresponding Endpoint. MANDATORY
Run As User NamerunAsUserName	String	This is a character sequence that specifies the runAsUserName variable. Dependent: Mandatory when connection Type is "SSH" otherwise not used.

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/topology/endpoint?

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

Use '&' between successive query parameters:

name={name}

address={address}

group={group}

subgroup={subgroup}

Examples:

To Specify the name parameter only:

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

To Specify the name and group parameters:

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

To Specify the name, address and group parameters:

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

...

Parameter	Required	Type	Description
Namename	No	URL	This is a URL query parameter for the name which is used to search the endpoints.
Addressaddress	No	URL	This is a URL query parameter for the address which is used to search the endpoints.
Groupgroup	No	URL	This is a URL query parameter for the group which is used to search the endpoints.
Sub Groupsubgroup	No	URL	This is a URL query parameter for the sub group which is used to search the endpoints.

Response Codes

...

Attributes	Type	Required	Description
Descriptiondescription	String	No	A description of the Endpoint.
Connection Typeconnectiontype	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.
Endpoint AddressendpointAddress	String	No	This is a String associated with the address of the endpoint.
Endpoint PortendpointPort	String	Dependent	This is a port associated with an SSH connection. Dependency: Mandatory when connectionType is "SSH", otherwise not used.
Endpoint IdendpointId	Long	No	This is a number associated with the identification number of an existing Endpoint.
Passwordpassword	String	Dependent	This is a character sequence used to access the corresponding remote connection. Dependency: mandatory when connectionType is "SSH" otherwise not used.
Endpoint NameendpointName	String	Yes	This is the unique name of the corresponding Endpoint. Must be unique.
Private KeyprivateKey	String	Dependent	This is a character sequence associated with the corresponding remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
OS TypeosType	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.
Base DirectorybaseDirectory	String	Yes	This is a character sequence which corresponds to the base directory of the corresponding Endpoint.
Endpoint Sub GroupendpointSubgroup	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group.
Passphrasepassphrase	String	Dependent	This is a character sequence associated with the correspond remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
Java PathjavaPath	String	Yes	This is a character sequence that specifies the java path of the corresponding Endpoint.
Run As User NamerunAsUserName	String	Dependent	This is a character sequence that specifies the runAsUserName variable. Dependency: Mandatory when connection Type is "SSH" otherwise not used.

...

Parameters

Attributes	Type	Required	Description
Descriptiondescription	String	No	A description of the Endpoint.
Connection TypeconnectionType	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.
Endpoint AddressendpointAddress	String	No	This is a String associated with the address of the endpoint.
Endpoint PortendpointPort	String	Dependent	This is a port associated with an SSH connection. Dependency: Mandatory when connectionType is "SSH", otherwise not used.
Endpoint IdendpointId	Long	No	This is a number associated with the identification number of an existing Endpoint.
Passwordpassword	String	Dependent	This is a character sequence used to access the corresponding remote connection. Dependency: mandatory when connectionType is "SSH" otherwise not used.
Endpoint NameendpointName	String	Yes	This is the unique name of the corresponding Endpoint. Must be unique.
Private KeyprivateKey	String	Dependent	This is a character sequence associated with the corresponding remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
OS TypeosType	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.
Base DirectorybaseDirectory	String	Yes	This is a character sequence which corresponds to the base directory of the corresponding Endpoint.
Endpoint Sub GroupendpointSubgroup	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group.
Passphrasepassphrase	String	Dependent	This is a character sequence associated with the correspond remote connection. Dependency: Mandatory when connectionType is "SSH" otherwise not used.
Java PathjavaPath	String	Yes	This is a character sequence that specifies the java path of the corresponding Endpoint.
Run As User NamerunAsUserName	String	Dependent	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
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/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

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

...

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 it's value is null it will not be updated in the Endpoint.

Info

title	API URL

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

Parameters

Attributes	Type	Required	Description

Description

description

String

No

A description of the Endpoint.

Connection Type

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.

Endpoint Address

endpointAddress

String

No

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

Endpoint Port

endpointPort

String

Dependent

This is a port associated with an SSH connection.

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

Endpoint Id

endpointId

Long

No

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

Password

password

String

Dependent

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

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

Endpoint Name

endpointName

String

Yes

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

Private Key

privateKey

String

Dependent

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

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

OS Type

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.

Base Directory

baseDirectory

String

Yes

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

Endpoint Sub Group

endpointSubgroup

String

No

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

Passphrase

passphrase

String

Dependent

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

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

Java Path

javaPath

String

Yes

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

Run As User Name

runAsUserName

String

Dependent

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
200	Endpoint was found and updated
400	Bad request
401	Unauthorized
404	Endpoint not found
500	Unexpected internal server error

...

Versions Compared

Old Version 11

New Version 12

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:

Response Codes

Parameters

Response Codes

PATCH

Parameters

Response Codes

Page Comparison

Versions Compared

Old Version 11

New Version 12

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:

Response Codes

Parameters

Response Codes

PATCH

Parameters

Response Codes