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",
    "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
{
    "password"endpointId": 13910,
    "endpointName": "GOODPOST1",
    "description": "*****description",
    "passwordCredentialIdisActive": 12345true,
    "descriptionconnectionType": "descriptionSSH",
    "userNameosType": "userNameUNIX",
    "privateKeyendpointAddress": "privateKeyNotNeeded00",
    "isActiveendpointPort": true"1",
    "baseDirectory": "ServerInstallRoot + '/localhost'",
   	 "isBaseDirectoryExpression": "N",
    "endpointNamejavaPath": "GOODPOST1ServerJavaHome",
    "connectionTypeisJavaPathExpression": "SSHN",
 	   "isJavaPathExpressionuserName": "NuserName",
    "endpointAddresspassword": "NotNeeded00*****",
    "endpointIdpasswordCredentialId": 1391012345,
    "endpointSubgroupprivateKey": "subGroupTesterprivateKey",
    "endpointPortpassphrase": "1*****",
    "endpointGrouppassphraseCredentialId": "endpointGroup"54321,
    "runAsUserName": "TestInput",
    "osTypeendpointGroup": "UNIXendpointGroup",
    "javaPathendpointSubgroup": "ServerJavaHome",
    "passphrase": "*****",
    "passphraseCredentialId": 54321
subGroupTester"
}

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}

...

descriptionA description Allowed for backward compatibility, as this is replaced by passwordCredentialId. Only
AttributesTypeRequiredDescription
endpointNameStringNoYes

This is the unique name of the corresponding Endpoint.

connectiontypedescriptionStringYesThis specifies the connection Type. "SSH" or "LOCALHOST"NoA 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.

password
baseDirectoryStringDependentYes

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.

endpointNameString

Yes

This is the unique name of the corresponding Endpoint.

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.

osTypepassphraseCredentialIdStringLongDependentNopassphraseCredentialIdLongNo

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.

This is the id of the credential associated with the 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.
javaPathrunAsUserNameStringYes

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

runAsUserNameStringNoAn optional user to run No

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
REST V1 Endpoint Response
REST V1 Endpoint Response

...

Info
titleAPI URL

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

Request

AttributesTypeRequiredDescription
IdURLYesURL parameter to specify which endpoint to replace
description
endpointNameString
NoA description
Yes

This is the unique name of the corresponding Endpoint.

connectiontype
descriptionString
YesThis specifies the connection Type. "SSH" or "LOCALHOST"
NoA 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.

password
baseDirectoryString
DependentAllowed for backward compatibility, as this is replaced by passwordCredentialId. Only
Yes

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.

endpointNameString

Yes

This is the unique name of the corresponding Endpoint.

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.

osType
passphraseCredentialId
String
Long
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.

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.passphraseCredentialIdLongNoThis is the id of the credential associated with the

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.
javaPathAn optional user to run
runAsUserNameString
Yes

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

runAsUserNameStringNo
No

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
REST V1 Endpoint Response
REST V1 Endpoint Response

...

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

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
descriptionendpointNameStringNoA description Yes

This is the unique name of the corresponding Endpoint.

connectiontypedescriptionStringNoThis specifies the connection Type. "SSH" or "LOCALHOST"A description of the Endpoint.
isActiveBooleanNo

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

endpointAddressconnectiontypeStringNo

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.

passwordbaseDirectoryStringNoAllowed for backward compatibility, as this is replaced by passwordCredentialId. Only password

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

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

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

endpointNameStringYes

This is the unique name of the corresponding Endpoint.

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.

endpointSubgroup

not used.

privateKeyStringNoThis is a character sequence associated with this Endpoint's corresponding sub-group

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.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.
endpointSubgroupStringNoThis is a character sequence associated with this Endpoint's corresponding sub-group.

Include Page
REST V1 Endpoint Response
REST V1 Endpoint Response

...