Versions Compared

Key

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

...

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)

...

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  the following JSON environment endpoint 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

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

Info
titleAPI URL

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

Request

endpointIdLongNo number associated with the identification number of an existing Endpoint.This is a character sequence used to access the corresponding mandatory Must be unique.This is a character sequence associated with the corresponding remote connection Mandatory

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

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

This is a character sequence that specifies the runAsUserName variable.

Dependency: Mandatory Kubernetes
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

passwordStringDependent

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

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 EndpointNot required if the Endpoint is a Docker Host.

runAsUserNameStringDependentNo

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.

Include Page
REST V1 Endpoint Response
REST V1 Endpoint Response

...

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

.This is a number associated with the identification number of an existing Endpoint mandatory Must be unique.This is a character sequence associated with the corresponding remote connection Mandatory

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

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

This is a character sequence that specifies the runAsUserName variable.

Dependency: Mandatory
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

endpointIdLongNo

.

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

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.

runAsUserNameStringDependentNo

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.
k8sContextStringNoKubernetes Name of the configured K8s context.

Include Page
REST V1 Endpoint Response
REST V1 Endpoint Response

...

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

Info
titleAPI URL

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

Request

endpointIdLong number associated with the identification number of an existing Endpoint.This is a character sequence used to access the corresponding remote connectionNo Must be unique.This is a character sequence associated with the corresponding remote connection system type used in the corresponding remote connectionThis is a character sequence associated with the correspond remote connection the java path of the corresponding Endpoint.This is a character sequence that specifies the runAsUserName variable
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

passwordStringNo

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

runAsUserNameStringNo

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.
k8sContextStringNoKubernetes Name of the configured K8s context.

Include Page
REST V1 Endpoint Response
REST V1 Endpoint Response

...

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

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

The PATCH request would then update the environment endpoint with Id 13909 (id is passed through the URL) 13909 and return the  the following JSON environment endpoint 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
}