Versions Compared

Key

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

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.

...

Request

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

Include Page
REST V1 Endpoint V1 Response
REST V1 Endpoint V1 Response

Response Codes

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

Example

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

Code Block
themeEclipse
titleEndpoint 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
themeEclipse
titleEndpoint 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": "*****"
}

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

Request

Parameter
Required
Type
Description
endpointNameNoURLThis is a URL query parameter for the name which is used to search the endpoints.
endpointAddressNoURLThis is a URL query parameter for the address which is used to search the endpoints.
endpointGroupNoURLThis is a URL query parameter for the group which is used to search the endpoints.
endpointSubgroupNoURLThis is a URL query parameter for the sub group which is used to search the endpoints.

Include Page
REST V1 Endpoint V1 Response
REST V1 Endpoint V1 Response

Response Codes

HTTP CodeDescription
200Endpoint was found and returned
400Bad request
401Unauthorized
500Unexpected 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
languagejs
themeEclipse
titleEndpoint - 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
themeEclipse
titleEndpoint 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
themeEclipse
titleEndpoint 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
}
]

POST

...

Info
titleAPI URL

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

Request

...

Response Codes

HTTP CodeDescription200Endpoint was found
AttributesTypeRequiredDescription
descriptionStringNoA 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.

...

dockerHostBooleanNoThis indicates if endpoint is docker engine.
k8sClusterBooleanNoThis indicates if endpoint is kubernetes engine.
k8sContextStringNoKubernetes context.

Include Page
REST V1 Endpoint Response
REST V1 Endpoint Response

Response Codes

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

PUT

...

Info
titleAPI URL

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

Request

AttributesTypeRequiredDescription
descriptionStringNoA 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.

Include PageREST Endpoint V1 ResponseREST Endpoint V1 Response

Response Codes

dockerHostBooleanNoThis indicates if endpoint is docker engine.
k8sClusterBooleanNoThis indicates if endpoint is kubernetes engine.
k8sContextStringNoKubernetes context.

Include Page
REST V1 Endpoint Response
REST V1 Endpoint Response

Response Codes

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

...

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

Code Block
themeEclipse
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": 11101,
   "endpointGroup": "endpointGroup",
   "endpointPort": null,
   "runAsUserName": "runAsUserName",
   "endpointSubgroup": "endpointSubgroup"
}

...

And the PUT request receives the following JSON endpoint object,

Code Block
themeEclipse
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
themeEclipse
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"
}

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

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

Request

AttributesTypeRequiredDescription
descriptionStringNoA description of the Endpoint.
connectiontypeString
Yes
No

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.
endpointPortString
Dependent
No

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.
passwordString
Dependent
No

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

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

.

endpointNameString
Yes
No

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

privateKeyString
Dependent
No

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

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

osTypeString
Dependent
No

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.

baseDirectoryString
Yes
No

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.
passphraseString
Dependent
No

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

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

javaPathString
Yes
No

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

runAsUserNameString
Dependent
No

This is a character sequence that specifies the runAsUserName variable

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

.

dockerHostBooleanNoThis indicates if endpoint is docker engine.
k8sClusterBooleanNoThis indicates if endpoint is kubernetes engine.
k8sContextStringNoKubernetes context.

Include Page
REST V1 Endpoint V1 Response
REST V1 Endpoint V1 Response

Response Codes

HTTP Code
Description
200Endpoint was found and updated
400Bad request
401Unauthorized
404Endpoint not found
500Unexpected internal server error

Example

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

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

And the PATCH request receives the following JSON environment object,

Code Block
themeEclipse
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
themeEclipse
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
}