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.

Table of Contents

maxLevel	2

GET

There are two three implementations of GET. One will find an Endpoint with the given Id and return the JSON representation of the Endpoint. The other next one will find a list of Endpoints matching the parameters supplied to it. The last one will test the connection to an endpoint.

GET by ID

This GET service will find an Endpoint with the given Id and return the JSON representation of the object.

...

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

Code Block

theme	Eclipse
title	Endpoint 13910

{
    "passwordCredentialIdendpointId": 1234513910,
    "descriptionendpointName": "descriptionGOODPOST1",
    "userNamedescription": "userNamedescription",
    "privateKeyisActive": "privateKey"true,
    "isActiveconnectionType": true"SSH",
    "baseDirectoryosType": "ServerInstallRoot + '/localhost'UNIX",
    "endpointNameendpointAddress": "GOODPOST1NotNeeded00",
    "connectionTypeendpointPort": "SSH1",
    "endpointAddressbaseDirectory": "NotNeeded00ServerInstallRoot + '/localhost'",
    "endpointIdisBaseDirectoryExpression": 13910"N",
    "endpointSubgroupjavaPath": "subGroupTesterServerJavaHome",
    "endpointPortisJavaPathExpression": "1N",
    "endpointGroupuserName": "endpointGroupuserName",
    "runAsUserNamepasswordCredentialId": "TestInput"12345,
    "osTypeprivateKey": "UNIXprivateKey",
    "javaPathrunAsUserName": "ServerJavaHomeTestInput",
    "passphraseendpointGroup": "PassphraseendpointGroup",
    "passphraseCredentialIdendpointSubgroup": "subGroupTester"
54321
}

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

theme	Eclipse
title	Endpoint GET Return JSON

{
    "passwordendpointId": "*****"13910,
    "passwordCredentialIdendpointName": 12345"GOODPOST1",
    "description": "description",
    "userNameisActive": "userName"true,
    "privateKeyconnectionType": "privateKeySSH",
    "isActiveosType": true"UNIX",
    "baseDirectoryendpointAddress": "ServerInstallRoot + '/localhost'NotNeeded00",
    "endpointNameendpointPort": "GOODPOST11",
    "connectionTypebaseDirectory": "SSHServerInstallRoot + '/localhost'",
    "endpointAddressisBaseDirectoryExpression": "NotNeeded00N",
    "endpointIdjavaPath": 13910"ServerJavaHome",
    "endpointSubgroupisJavaPathExpression": "subGroupTesterN",
    "endpointPortuserName": "1userName",
    "endpointGrouppassword": "*****",
    "endpointGrouppasswordCredentialId": 12345,
    "runAsUserNameprivateKey": "TestInputprivateKey",
    "osTypepassphrase": "UNIX"*****",
    "passphraseCredentialId": 54321,
    "javaPathrunAsUserName": "ServerJavaHomeTestInput",
    "passphraseendpointGroup": "*****endpointGroup",
    "passphraseCredentialIdendpointSubgroup": 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

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

isActive={boolean}

Examples:

To Specify the name parameter only:

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

To Specify

the name and

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}

...

Request

Parameter	Required	Type	Description
endpointName	No	Query - String	Contains ignore case search
endpointAddress	No	Query - String	Equals ignore case search
endpointGroup	No	Query - String	Equals ignore case search
endpointSubgroup	No	Query - String	Equals ignore case search
isActive	No	Query - Boolean	Returns endpoints where isActive field matches parameter.

Include Page

	REST V1 Endpoint Response
	REST V1 Endpoint Response

Response Codes

HTTP Code	Description
200	Search successful and results returned
400	Bad request
401	Authentication failure
403	Authorization failure (no access to resource)
500	Unexpected 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

language	js
theme	Eclipse
title	Endpoint - 14517

{
    "descriptionendpointId": null14517,
    "passwordCredentialIdendpointName": null"Motel6",
    "userNamedescription": null,
    "isActive": true,
    "privateKey"connectionType": "LOCALHOST",
    "osType": null,
    "baseDirectoryendpointAddress": "ServerInstallRoot + '/localhost'",
    "osTypeendpointPort": null,
    "javaPathbaseDirectory": "ServerJavaHomeServerInstallRoot + '/localhost'",
    "endpointNameisBaseDirectoryExpression": "Motel6N",
    "endpointAddressjavaPath": "localhostServerJavaHome",
    "endpointIdisJavaPathExpression": 14517"N",
    "passphraseuserName": null,
    "passphraseCredentialIdpasswordCredentialId": null,
    "connectionTypeprivateKey": null,
    "LOCALHOSTpassphrase": null,
    "endpointPortpassphraseCredentialId": null,
    "endpointGrouprunAsUserName": "Germany"null,
    "endpointSubgroupendpointGroup": "MunichGermany",
    "runAsUserNameendpointSubgroup": null"Munich"
}

Code Block

theme	Eclipse
title	Endpoint 14518

{
    "descriptionendpointId": null14518,
    "passwordendpointName": null"Raddison Hotel",
    "passwordCredentialIddescription": null,
    "userNameisActive": nulltrue,
    "isActiveconnectionType": true"LOCALHOST",
    "privateKeyosType": null,
    "baseDirectoryendpointAddress": "localhost",
    "endpointPort": null,
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "osTypeisBaseDirectoryExpression": null"N",
    "javaPath": "ServerJavaHome",
    "endpointNameisJavaPathExpression": "Raddison HotelN",
    "endpointAddressuserName": "localhost"null,
    "endpointIdpassphraseCredentialId": 14518null,
    "passphrasepasswordCredentialId": null,
    "passphraseCredentialIdprivateKey": null,
    "connectionTypepassword": "LOCALHOST"null,
    "endpointPortpassphrase": null,
    "endpointGrouprunAsUserName": "Germany"null,
    "endpointSubgroupendpointGroup": "BerlinGermany",
    "runAsUserNameendpointSubgroup": null"Berlin"
}

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

theme	Eclipse
title	Endpoint 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",
        "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",
        "endpointSubgroup": "Berlin",
        "runAsUserName": null
    }
]

POST

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

Test Connection (using GET)

Info

title	API URL

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

...

Request

AttributesTypeRequiredDescriptiondescriptionStringNoA 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

/{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
Id	Yes	URL	This is a URL parameter for the Id which is used to find and return an Endpoint

Include Page

	REST V1 Testresult Response
	REST V1 Testresult Response

Response Codes

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

Example

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

Code Block

theme	Eclipse
title	Endpoint 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",
    "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

theme	Eclipse
title	Testresult

{
    "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.

Info

title	API URL

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

Request

Attributes	Type	Required	Description
endpointName	String	Yes	This is the unique name of the corresponding Endpoint.
description	String	No	A description of the Endpoint.
isActive	Boolean	No	This is a Boolean that tracks whether or not the Endpoint is active. Default is true.
connectiontype	String	Yes	This specifies the connection Type. "SSH" or "LOCALHOST"
osType	String	Dependent	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.
endpointAddress	String	No	This is a String associated with the address of the endpoint.
endpointPort	String	Dependent	This is a port associated with an SSH connection. Dependency: Mandatory when connectionType is "SSH", otherwise not used.
baseDirectory	String	Yes	This is a character sequence which corresponds to the base directory of the corresponding Endpoint.
javaPath	String	Yes	This is a character sequence that specifies the java path of the corresponding Endpoint. Not required if the Endpoint is a Docker Host.
password	String	Dependent	Allowed 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.
passwordCredentialId	Long	Dependent	privateKey	String	Dependent	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.
endpointName	String	Yes	This is the unique name of the corresponding Endpoint.
Fully-qualified path of the SSH private key file.. Dependency: Either password, Either passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used.
osTypeprivateKey	String	Dependent	This is a character sequence which corresponds to the operating system type used in the corresponding remote connectionFully-qualified path of the SSH private key file. Dependency: Mandatory Either password, passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used.
baseDirectory	String	Yes	This is a character sequence which corresponds to the base directory of the corresponding Endpoint.
endpointSubgroup	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group used.
passphraseCredentialId	Long	No	This is the id of the credential associated with the endpoint passphrase. Note: Only valid if a privateKey is specified.
passphrase	String	No	Allowed 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.	javaPath	String	Yes	This is a character sequence that specifies the java path of the corresponding Endpoint. Not required if the Endpoint is a Docker Host.
runAsUserName	String	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.
dockerHost	Boolean	No	This indicates if endpoint is docker engine. Defaults to false.
k8sCluster	Boolean	No	This indicates if endpoint is kubernetes engine. Defaults to false.
k8sContext	String	No	Name of the configured K8s context.
endpointSubgroup	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group.

Include Page

	REST V1 Endpoint Response
	REST V1 Endpoint Response

Response Codes

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

Example

If the POST request receives the following JSON endpoint object,

Code Block

theme	Eclipse
title	POST 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",
    "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

theme	Eclipse
title	Endpoint POST Return JSON

{
    "endpointId": 13922,
    "endpointName": "GoodPost",
    "passworddescription": "*****description",
    "passwordCredentialIdisActive": 74839true,
    "descriptionconnectionType": "descriptionSSH",
    "userNameosType": "userNameUNIX",
    "privateKeyendpointAddress": "privateKeyNotNeeded00",
    "isActiveendpointPort": true"1",
    "baseDirectory": "ServerInstallRoot + '/localhost'",
    "endpointNameisBaseDirectoryExpression": "GoodPostN",
    "connectionTypejavaPath": "SSHServerJavaHome",
    "endpointAddressisJavaPathExpression": "NotNeeded00N",
    "endpointIduserName": 13922"userName",
    "endpointSubgrouppassphraseCredentialId": "subGroupTester"29084,
    "endpointPortpassword": "1*****",
    "endpointGrouppasswordCredentialId": "endpointGroup"74839,
    "runAsUserNameprivateKey": "TestInputprivateKey",
    "osTypepassphrase": "UNIX*****",
    "javaPathrunAsUserName": "ServerJavaHomeTestInput",
    "passphraseendpointGroup": "*****endpointGroup",
    "passphraseCredentialIdendpointSubgroup": 29084"subGroupTester",
}

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.

Info

title	API URL

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

Request

Attributes	Type	Required	Description
Id	URL	Yes	URL parameter to specify which endpoint to replace

description

endpointName

String

NoA description

Yes	This is the unique name of the corresponding Endpoint.

connectiontype

description

String

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

No	A description of the Endpoint.
isActive	Boolean	No	This is a Boolean that tracks whether or not the Endpoint is active. Default is true.

endpointAddress

connectiontype

String

No

Yes

This

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

specifies the connection Type. "SSH" or "LOCALHOST"
osType	String	Dependent	This is a

port associated with an SSH

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

Dependency: Mandatory when connectionType is "SSH"

,

otherwise not used.

passwordpasswordCredentialIdLong

endpointAddress

String

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

No	This is a String associated with the address of the endpoint.
endpointPort	String	Dependent	This is

the id of the credential

a port associated with

the endpoint password.

an SSH connection.

Dependency:

Either password, passwordCredentialId, or privateKey is required

Mandatory when connectionType is "SSH", otherwise not used.

endpointName

baseDirectory

String

Yes

This is

the unique name

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

privateKeyosTypeStringDependent

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

Dependency: Mandatory

javaPath

String

Dependent

Fully-qualified path of the SSH private key file.

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

Yes

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

password

String

Dependent

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

passwordCredentialId

Long

Dependent

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.

baseDirectory

privateKey

String

Yes

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

Dependent

Fully-qualified path of the SSH private key file.

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

passphraseCredentialId

Long

No

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

Note: Only valid if a privateKey is specified.

passphrase

String

No

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

javaPathStringYes

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

runAsUserName	String	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.
dockerHost	Boolean	No	This indicates if endpoint is docker engine. Defaults to false.
k8sCluster	Boolean	No	This indicates if endpoint is kubernetes engine. Defaults to false.
k8sContext

StringNoName of the configured K8s context

String	No	Name of the configured K8s context.
endpointSubgroup	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group.

Include Page

	REST V1 Endpoint Response
	REST V1 Endpoint Response

Response Codes

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

Example

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

...

Code Block

theme	Eclipse
title	Endpoint 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

title	API URL

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

Request

Attributes	Type	Required	Description
Id	URL	Yes	URL parameter to specify which endpoint to patch
descriptionendpointName	String	No	A description Yes	This is the unique name of the corresponding Endpoint.
connectiontypedescription	String	NoThis	specifies the connection Type. "SSH" or "LOCALHOST"A description of the Endpoint.
isActive	Boolean	No	This is a Boolean that tracks whether or not the Endpoint is active. Default is true.
endpointAddressconnectiontype	String	No	This is a String associated with the address of the endpoint.endpointPort specifies the connection Type. "SSH" or "LOCALHOST"
osType	String	No	This is a port associated with an SSH 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.
passwordendpointAddress	String	No	Allowed 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.	passwordCredentialId	LongThis is a String associated with the address of the endpoint.
endpointPort	String	No	This is the id of the credential a port associated with the endpoint password. an SSH connection. Note: Only applicable when connectionType is "SSH", otherwise not used.
endpointNamebaseDirectory	String	YesNo	This is the unique name a character sequence which corresponds to the base directory of the corresponding Endpoint.
privateKeyjavaPath	String	No	Fully-qualified This is a character sequence that specifies the java path of the SSH private key file. Note: Only applicable when connectionType is "SSH" otherwise not used.	osType	String corresponding Endpoint.
password	String	No	Allowed 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.
passwordCredentialId	Long	No	This is a character sequence which corresponds to the operating system type used in the corresponding remote connection.the id of the credential associated with the endpoint password. Note: Only applicable when connectionType is "SSH" otherwise not used.
baseDirectoryprivateKey	String	No	This is a character sequence which corresponds to the base directory of the corresponding Endpoint.	endpointSubgroup	String	No	This 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.
passphraseCredentialId	Long	No	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.
passphrase	String	No	Allowed 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.	javaPath	String	No	This is a character sequence that specifies the java path of the corresponding Endpoint.
runAsUserName	String	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.
dockerHost	Boolean	No	This indicates if endpoint is docker engine. Defaults to false.
k8sCluster	Boolean	No	This indicates if endpoint is kubernetes engine. Defaults to false.
k8sContext	String	No	Name of the configured K8s context.
endpointSubgroup	String	No	This is a character sequence associated with this Endpoint's corresponding sub-group.

Include Page

	REST V1 Endpoint Response
	REST V1 Endpoint Response

Response Codes

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

Example

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

Code Block

theme	Eclipse
title	Endpoint 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

theme	Eclipse
title	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

Code Block

theme	Eclipse
title	Endpoint 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,
    "endpointPort": null,
    "endpointGroup": "TheGroup",
    "runAsUserName": null,
    "osType": null,
    "javaPath": "ServerJavaHome",
    "passphrase": null,
    "passphraseCredentialId": null
}

Versions Compared

Old Version 51

New Version Current

Key

GET

GET by ID

GET (Using Query Parameters)

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

Examples:

To Specify the name parameter only:

To Specify

isActive parameter Only:

To Specify the name and group parameters:

To Specify the name, address and group parameters:

Request

Response Codes

Example

POST

Test Connection (using GET)

Request

Request

Response Codes

Example

POST

Request

Response Codes

Example

PUT

Request

Response Codes

Example

PATCH

Request

Response Codes

Example

Page Comparison

Versions Compared

Old Version 51

New Version Current

Key

GET

GET by ID

GET (Using Query Parameters)

Append the following character sequences to the above URL to specify Query parameters.

Use '&' between successive query parameters:

Examples:

To Specify the name parameter only:

To Specify

isActive parameter Only:

To Specify the name and group parameters:

To Specify the name, address and group parameters:

Request

Response Codes

Example

POST

Test Connection (using GET)

Request

Request

Response Codes

Example

POST

Request

Response Codes

Example

PUT

Request

Response Codes

Example

PATCH

Request

Response Codes

Example