EndPoint API

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.

Authentication - Use Basic Authentication for this API.

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.

API URL

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

Request

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

Response

Attributes
Type
Description
descriptionString

This is a description of the Endpoint.

connectionTypeString

This specifies the connection Type.

isActiveBoolean

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

endpointAddressString

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

endpointPortString

This is a port associated with an SSH connection.

endpointIdLong

This is an identification number of an existing Endpoint.

passwordString

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

endpointNameString

This is the unique name of the corresponding Endpoint.

privateKeyString

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

osTypeString

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

baseDirectoryString

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

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

An optional passphrase used when the private key was generated.

javaPathString

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

runAsUserNameString

An optional user to run as (using sudo) after establishing connection to the endpoint.

dockerHostBooleanThis indicates if endpoint is docker engine.
k8sClusterBoolean

This indicates if endpoint is kubernetes engine.

k8sContextStringName of the configured K8s context.

Response Codes

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

Example

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

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

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

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.

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}

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

Request

Parameter
Required
Type
Description
endpointNameNoQuery - StringContains ignore case search
endpointAddressNoQuery - StringEquals ignore case search
endpointGroupNoQuery - StringEquals ignore case search
endpointSubgroupNoQuery - StringEquals ignore case search

Response

Attributes
Type
Description
descriptionString

This is a description of the Endpoint.

connectionTypeString

This specifies the connection Type.

isActiveBoolean

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

endpointAddressString

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

endpointPortString

This is a port associated with an SSH connection.

endpointIdLong

This is an identification number of an existing Endpoint.

passwordString

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

endpointNameString

This is the unique name of the corresponding Endpoint.

privateKeyString

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

osTypeString

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

baseDirectoryString

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

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

An optional passphrase used when the private key was generated.

javaPathString

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

runAsUserNameString

An optional user to run as (using sudo) after establishing connection to the endpoint.

dockerHostBooleanThis indicates if endpoint is docker engine.
k8sClusterBoolean

This indicates if endpoint is kubernetes engine.

k8sContextStringName of the configured K8s context.

Response Codes

HTTP CodeDescription
200Search successful and results returned
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
500Unexpected internal server error

Example

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

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

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

POST

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

API URL

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

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.

passwordStringDependent

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

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

endpointNameStringYes

This is the unique name of the corresponding Endpoint.

privateKeyStringDependent

Fully-qualified path of the SSH private key file.

Dependency: Either password or privateKey is required 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.
passphraseStringNo

An optional passphrase used when the private key was generated. 

Note: Only valid if a privateKey is specified.

javaPathStringYes

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

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.

Response

Attributes
Type
Description
descriptionString

This is a description of the Endpoint.

connectionTypeString

This specifies the connection Type.

isActiveBoolean

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

endpointAddressString

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

endpointPortString

This is a port associated with an SSH connection.

endpointIdLong

This is an identification number of an existing Endpoint.

passwordString

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

endpointNameString

This is the unique name of the corresponding Endpoint.

privateKeyString

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

osTypeString

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

baseDirectoryString

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

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

An optional passphrase used when the private key was generated.

javaPathString

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

runAsUserNameString

An optional user to run as (using sudo) after establishing connection to the endpoint.

dockerHostBooleanThis indicates if endpoint is docker engine.
k8sClusterBoolean

This indicates if endpoint is kubernetes engine.

k8sContextStringName of the configured K8s context.

Response Codes

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

Example

If the POST request receives the following JSON endpoint object,

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

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

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.

API URL

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

Request

AttributesTypeRequiredDescription
IdURLYesURL parameter to specify which endpoint to replace
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.

passwordStringDependent

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

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

endpointNameStringYes

This is the unique name of the corresponding Endpoint.

privateKeyStringDependent

Fully-qualified path of the SSH private key file.

Dependency: Either password or privateKey is required 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.
passphraseStringNo

An optional passphrase used when the private key was generated. 

Note: Only valid if a privateKey is specified.

javaPathStringYes

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

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.

Response

Attributes
Type
Description
descriptionString

This is a description of the Endpoint.

connectionTypeString

This specifies the connection Type.

isActiveBoolean

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

endpointAddressString

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

endpointPortString

This is a port associated with an SSH connection.

endpointIdLong

This is an identification number of an existing Endpoint.

passwordString

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

endpointNameString

This is the unique name of the corresponding Endpoint.

privateKeyString

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

osTypeString

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

baseDirectoryString

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

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

An optional passphrase used when the private key was generated.

javaPathString

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

runAsUserNameString

An optional user to run as (using sudo) after establishing connection to the endpoint.

dockerHostBooleanThis indicates if endpoint is docker engine.
k8sClusterBoolean

This indicates if endpoint is kubernetes engine.

k8sContextStringName of the configured K8s context.

Response Codes

HTTP Code
Description
201Endpoint was created successfully
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
404Endpoint not found
500Unexpected internal server error

Example

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

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/v1/topology/endpoint/11101

And the PUT request receives the following JSON endpoint object,

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.

Endpoint 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 not provided, it will not be updated in the Endpoint.

API URL

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

Request

AttributesTypeRequiredDescription
IdURLYesURL parameter to specify which endpoint to patch
descriptionStringNoA description of the Endpoint.
connectiontypeStringNo

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

This is a port associated with an SSH connection.

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

passwordStringNo

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

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

endpointNameStringYes

This is the unique name of the corresponding Endpoint.

privateKeyStringNo

Fully-qualified path of the SSH private key file.

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

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.

baseDirectoryStringNo

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

An optional passphrase used when the private key was generated. 

Note: Only valid if a privateKey is specified, or already configured for endpoint.

javaPathStringNo

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

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.

Response

Attributes
Type
Description
descriptionString

This is a description of the Endpoint.

connectionTypeString

This specifies the connection Type.

isActiveBoolean

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

endpointAddressString

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

endpointPortString

This is a port associated with an SSH connection.

endpointIdLong

This is an identification number of an existing Endpoint.

passwordString

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

endpointNameString

This is the unique name of the corresponding Endpoint.

privateKeyString

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

osTypeString

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

baseDirectoryString

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

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

An optional passphrase used when the private key was generated.

javaPathString

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

runAsUserNameString

An optional user to run as (using sudo) after establishing connection to the endpoint.

dockerHostBooleanThis indicates if endpoint is docker engine.
k8sClusterBoolean

This indicates if endpoint is kubernetes engine.

k8sContextStringName of the configured K8s context.

Response Codes

HTTP Code
Description
200Endpoint was found and updated
400Bad request
401Authentication failure
403Authorization failure (no access to resource)
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

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

Endpoint 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

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