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.

...

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

Code Block
themeEclipse
titleEndpoint 13910
{
    "endpointId": 13910,
    "endpointName": "GOODPOST1",
    "description": "description",
    "isActive": true,
    "connectionType": "SSH",
    "osType": "UNIX",
    "endpointAddress": "NotNeeded00",
    "endpointPort": "1",
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "isBaseDirectoryExpression": "N",
    "javaPath": "ServerJavaHome",
    "isJavaPathExpression": "N",
    "userName": "userName",
    "passwordCredentialId": 12345,
    "privateKey": "privateKey",
    "runAsUserName": "TestInput",
    "endpointGroup": "endpointGroup",
	"transferProtocol": "SCP",
    "endpointSubgroup": "subGroupTester"

}

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
{
    "endpointId": 13910,
    "endpointName": "GOODPOST1",
    "description": "description",
    "isActive": true,
    "connectionType": "SSH",
    "osType": "UNIX",
    "endpointAddress": "NotNeeded00",
    "endpointPort": "1",
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "isBaseDirectoryExpression": "N",
    "javaPath": "ServerJavaHome",
    "isJavaPathExpression": "N",
    "userName": "userName",
    "password": "*****",
    "passwordCredentialId": 12345,
    "privateKey": "privateKey",
    "passphrase": "*****",
    "passphraseCredentialId": 54321,
    "runAsUserName": "TestInput",
    "endpointGroup": "endpointGroup",
    "endpointSubgroup": "subGroupTester",
	"transferProtocol": "SCP"
}

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}

isActive={boolean}

Examples:
To Specify the name parameter only:

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

To Specify isActive parameter Only:

http://host:port/flexdeploy/rest/v1/topology/endpoint?isActive=true

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
languagejs
themeEclipse
titleEndpoint - 14517
{
    "endpointId": 14517,
    "endpointName": "Motel6",
    "description": null,
    "isActive": true,
    "connectionType": "LOCALHOST",
    "osType": null,
    "endpointAddress": "localhost",
    "endpointPort": null,
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "isBaseDirectoryExpression": "N",
    "javaPath": "ServerJavaHome",
    "isJavaPathExpression": "N",
    "userName": null,
    "passwordCredentialId": null,
    "privateKey": null,
    "passphrase": null,
    "passphraseCredentialId": null,
    "runAsUserName": null,
    "endpointGroup": "Germany",
    "endpointSubgroup": "Munich",
	"transferProtocol": "SCP"
}


Code Block
themeEclipse
titleEndpoint 14518
{
    "endpointId": 14518,
    "endpointName": "Raddison Hotel",
    "description": null,
    "isActive": true,
    "connectionType": "LOCALHOST",
    "osType": null,
    "endpointAddress": "localhost",
    "endpointPort": null,
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "isBaseDirectoryExpression": "N",
    "javaPath": "ServerJavaHome",
    "isJavaPathExpression": "N",
    "userName": null,
    "passphraseCredentialId": null,
    "passwordCredentialId": null,
    "privateKey": null,
    "password": null,
    "passphrase": null,
    "runAsUserName": null,
    "endpointGroup": "Germany",
    "endpointSubgroup": "Berlin",
	"transferProtocol": "SCP"
}

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

Code Block
themeEclipse
titleEndpoint GET Return JSON
[
    {
        "description": null,
        "password": null,
        "passwordCredentialId": null,
        "userName": null,
        "isActive": true,
        "privateKey": null,
        "baseDirectory": "ServerInstallRoot + '/localhost'",
        "osType": null,
        "javaPath": "ServerJavaHome",
        "endpointName": "Motel6",
		"isBaseDirectoryExpression": "N",
        "endpointAddress": "localhost",
        "endpointId": 14517,
        "passphrase": null,
        "passphraseCredentialId": null,
        "connectionType": "LOCALHOST",
		"isJavaPathExpression": "N",
        "endpointPort": null,
        "endpointGroup": "Germany",
        "endpointSubgroup": "Munich",
		"endpointSubgrouptransferProtocol": "MunichSCP",
        "runAsUserName": null
    },
    {
        "description": null,
        "password": null,
        "passwordCredentialId": null,
        "userName": null,
        "isActive": true,
        "privateKey": null,
        "baseDirectory": "ServerInstallRoot + '/localhost'",
        "osType": null,
        "javaPath": "ServerJavaHome",
        "endpointName": "Raddison Hotel",
		"isBaseDirectoryExpression": "N",
        "endpointAddress": "localhost",
        "endpointId": 14518,
        "passphrase": null,
        "passphraseCredentialId": null,
        "connectionType": "LOCALHOST",
		"isJavaPathExpression": "N",
        "endpointPort": null,
        "endpointGroup": "Germany",
		"transferProtocol": "SCP",
        "endpointSubgroup": "Berlin",
        "runAsUserName": null
    }
]

Test Connection (using GET)

Info
titleAPI URL

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

This GET service will test the connection to an Endpoint with the given Id and return the JSON representation of a test result.

Request

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

Include Page
FD60:REST V1 Testresult Response
FD60:REST V1 Testresult Response

Response Codes

HTTP CodeDescription
200Endpoint was found, tested and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Endpoint not found.
500Unexpected internal server error

Example

Assuming we have an endpoint setup like the following, and it is a valid endpoint

Code Block
themeEclipse
titleEndpoint 13910
{
    "endpointId": 13910,
    "endpointName": "TEST1",
    "description": "description",
    "isActive": true,
    "connectionType": "SSH",
    "osType": "UNIX",
    "endpointAddress": "hostname:port",
    "endpointPort": "1",
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "isBaseDirectoryExpression": "N",
    "javaPath": "ServerJavaHome",
    "isJavaPathExpression": "N",
    "userName": "userName",
    "passphraseCredentialId": 54321,
    "passphrase": "Passphrase",
    "passwordCredentialId": 12345,
    "privateKey": "privateKey",
    "runAsUserName": "TestInput",
    "endpointGroup": "endpointGroup",
	"transferProtocol": "SCP",
    "endpointSubgroup": "subGroupTester"
}

When we run a GET request at the following URL

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

The GET request would return the following JSON testresult object:


Code Block
themeEclipse
titleTestresult
{
    "message": "Connection to Endpoint [TEST1] was successful.",
    "successful": true
}

POST

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

...

AttributesTypeRequiredDescription
endpointNameStringYes

This is the unique name of the corresponding Endpoint.

descriptionStringNoA description of the Endpoint.
isActiveBooleanNo

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

connectiontypeStringYes

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

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.

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.

baseDirectoryStringYes

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

javaPathStringYes

This is a character sequence that specifies the java path of the corresponding Endpoint. Not required if the Endpoint is a Docker Host.

passwordStringDependentAllowed for backward compatibility, as this is replaced by passwordCredentialId. Only password or passwordCredentialId can be provided. If password is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
passwordCredentialIdLongDependent

This is the id of the credential associated with the endpoint password. 

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

privateKeyStringDependent

Fully-qualified path of the SSH private key file.

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

passphraseCredentialIdLongNo

This is the id of the credential associated with the endpoint passphrase.

Note: Only valid if a privateKey is specified.

passphraseStringNoAllowed for backward compatibility, as this is replaced by passphraseCredentialId. Only passphrase or passphraseCredentialId can be provided. If passphrase is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
runAsUserNameStringNo

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.

dockerHostBooleanNoThis indicates if endpoint is docker engine. Defaults to false.
k8sClusterBooleanNoThis indicates if endpoint is kubernetes engine. Defaults to false.
k8sContextStringNoName of the configured K8s context.
endpointSubgroupStringNoThis is a character sequence associated with this Endpoint's corresponding sub-group.

...

Example

If the POST request receives the following JSON endpoint object,

Code Block
themeEclipse
titlePOST 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",
	"transferProtocol": "SCP",
    "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
themeEclipse
titleEndpoint POST Return JSON
{
    "endpointId": 13922,
    "endpointName": "GoodPost",
    "description": "description",
    "isActive": true,
    "connectionType": "SSH",
    "osType": "UNIX",
    "endpointAddress": "NotNeeded00",
    "endpointPort": "1",
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "isBaseDirectoryExpression": "N",
    "javaPath": "ServerJavaHome",
    "isJavaPathExpression": "N",
    "userName": "userName",
    "passphraseCredentialId": 29084,
    "password": "*****",
    "passwordCredentialId": 74839,
    "privateKey": "privateKey",
    "passphrase": "*****",
    "runAsUserName": "TestInput",
    "endpointGroup": "endpointGroup",
    "endpointSubgroup": "subGroupTester",
	"transferProtocol": "SCP"
}

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.

...

Request

AttributesTypeRequiredDescription
IdURLYesURL parameter to specify which endpoint to replace
endpointNameStringYes

This is the unique name of the corresponding Endpoint.

descriptionStringNoA description of the Endpoint.
isActiveBooleanNo

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

connectiontypeStringYes

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

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.

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.

baseDirectoryStringYes

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

javaPathStringYes

This is a character sequence that specifies the java path of the corresponding Endpoint. Not required if the Endpoint is a Docker Host.

passwordStringDependentAllowed for backward compatibility, as this is replaced by passwordCredentialId. Only password or passwordCredentialId can be provided. If password is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
passwordCredentialIdLongDependent

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.

privateKeyStringDependent

Fully-qualified path of the SSH private key file.

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

passphraseCredentialIdLongNo

This is the id of the credential associated with the endpoint passphrase.

Note: Only valid if a privateKey is specified.

passphraseStringNoAllowed for backward compatibility, as this is replaced by passphraseCredentialId. Only passphrase or passphraseCredentialId can be provided. If passphrase is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
runAsUserNameStringNo

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.

dockerHostBooleanNoThis indicates if endpoint is docker engine. Defaults to false.
k8sClusterBooleanNoThis indicates if endpoint is kubernetes engine. Defaults to false.
k8sContextStringNoName of the configured K8s context.
endpointSubgroupStringNoThis is a character sequence associated with this Endpoint's corresponding sub-group.

Include Page
FD60:REST V1 Endpoint Response
FD60:REST V1 Endpoint Response

...

Code Block
themeEclipse
titleEndpoint 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",
   "transferProtocol": "SCP"
}

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",
   "passwordCredentialId": 74839,
   "isActive": true,
   "privateKey": "newPrivateKey",
   "endpointName": "GoodPost3",
   "osType": "UNIX",
   "connectionType": "SSH",
   "isJavaPathExpression": "N",
   "javaPath": "ServerJavaHome",
   "endpointAddress": "endpointAddress",
   "baseDirectory": "ServerInstallRoot + '/localhost'",
   "passphrase": "passphrase",
   "passphraseCredentialId": 29084,
   "endpointId": null,
   "endpointGroup": "endpointGroup",
   "endpointPort": null,
   "runAsUserName": "runAsUserName",
   "isBaseDirectoryExpression": "N",
   "endpointSubgroup": "endpointSubgroup",
   "transferProtocol": "SCP"
}

PATCH

This PATCH service will update an existing endpoint with the information passed through a JSON object. If an attribute is not provided, it will not be updated in the Endpoint.

Info
titleAPI URL

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

...

AttributesTypeRequiredDescription
IdURLYesURL parameter to specify which endpoint to patch
endpointNameStringYes

This is the unique name of the corresponding Endpoint.

descriptionStringNoA description of the Endpoint.
isActiveBooleanNo

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

connectiontypeStringNo

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

osTypeStringNo

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.

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

This is a port associated with an SSH connection.

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

baseDirectoryStringNo

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

javaPathStringNo

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

passwordStringNoAllowed for backward compatibility, as this is replaced by passwordCredentialId. Only password or passwordCredentialId can be provided. If password is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
passwordCredentialIdLongNo

This is the id of the credential associated with the endpoint password. 

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

privateKeyStringNo

Fully-qualified path of the SSH private key file.

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

passphraseCredentialIdLongNo

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.

passphraseStringNoAllowed for backward compatibility, as this is replaced by passphraseCredentialId. Only passphrase or passphraseCredentialId can be provided. If passphrase is provided, it will be updated on corresponding credential only if credential is stored in Local credential store.
runAsUserNameStringNo

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.

dockerHostBooleanNoThis indicates if endpoint is docker engine. Defaults to false.
k8sClusterBooleanNoThis indicates if endpoint is kubernetes engine. Defaults to false.
k8sContextStringNoName of the configured K8s context.
endpointSubgroupStringNoThis is a character sequence associated with this Endpoint's corresponding sub-group.

...

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
{
    "passwordCredentialId": 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,
    "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 endpoint object,

Code Block
themeEclipse
titleEndpoint PATCH input JSON
{
    "endpointName": "PatchedEndpoint",
    "endpointGroup": null
}

The PATCH request would then update the endpoint with Id 13909 and return the following JSON endpoint object

Code Block
themeEclipse
titleEndpoint PATCH Return JSON
{
    "password": null,
    "passwordCredentialId": null,
    "description": null,
    "userName": null,
    "privateKey": null,
    "isActive": true,
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "endpointName": "PatchedEndpoint",
    "isBaseDirectoryExpression": "N",
    "connectionType": "LOCALHOST",
	"isJavaPathExpression": "N",
    "endpointAddress": "localhost",
    "endpointId": 13909,
    "endpointSubgroup": null,
    "transferProtocol": "SCP",
    "endpointPort": null,
    "endpointGroup": "TheGroup",
    "runAsUserName": null,
    "osType": null,
    "javaPath": "ServerJavaHome",
    "passphrase": null,
    "passphraseCredentialId": null
}