Versions Compared

Old Version 4

changes.mady.by.user Tyler Georgia

Saved on

compared with

New Version 5

changes.mady.by.user Tyler Georgia

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Anchor
Top
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
titleAPI 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}

...

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

Example

If the POST request receives the following JSON endpoint object,

Code Block
titlePOST 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
titleEndpoint 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

...

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

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


Parameters

AttributesTypeRequiredDescription
DescriptionStringNoA description of the Endpoint.
Connection TypeStringYes

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. 

Endpoint AddressStringNoThis is a String associated with the address of the endpoint.
Endpoint PortStringDependent

This is a port associated with an SSH connection.

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

Endpoint IdLongNoThis 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.

Endpoint NameStringYes

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

Private KeyStringDependent

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

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

OS TypeStringDependent

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 DirectoryStringYes

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

Endpoint Sub GroupStringNoThis 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.

Java PathStringYes

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

Run As User NameStringDependent

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
201Environment was created successfully
400Bad request
401Unauthorized
404Environment not found
500Unexpected internal server error


Info
titleAPI URL

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

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

Code Block
titleEndPoint 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": null11101,
   "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
titleEndpoint 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
titleEndpoint 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"
}

...

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

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

...

HTTP Code
Description
200Environment was found and updated
400Bad request
401Unauthorized
404Environment not found
500Unexpected internal server error
Code Block
titleEndpoint PATCH JSON

Example

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

Code Block
titleEndpoint 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/topology/endpoint/13909

And the PATCH request receives the following JSON environment object,

Code Block
titleEndpoint 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

Code Block
titleEndpoint 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

}



Back to Top

...