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 |
|---|---|---|---|
| Id | Yes | URL | This is a URL parameter for the Id which is used to find and return an Endpoint |
Response
Attributes | Type | Description |
|---|---|---|
| endpointId | Long | This is an identification number of an existing Endpoint. |
| endpointName | String | This is the unique name of the corresponding Endpoint. |
| description | String | This is a description of the Endpoint. |
| isActive | Boolean | This is a Boolean that tracks whether or not the Endpoint is active. |
| connectionType | String | This specifies the connection Type. |
| osType | String | This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. |
| endpointAddress | String | This is a String associated with the address of the endpoint. |
| endpointPort | String | This is a port associated with an SSH connection. |
| baseDirectory | String | This is a character sequence which corresponds to the base directory of the corresponding Endpoint. |
| isBaseDirectoryExpression | String | "Y" if the base directory is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N". |
| javaPath | String | This is a character sequence that specifies the java path of the corresponding Endpoint. |
| isJavaPathExpression | String | "Y" if the Java path is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N". |
| password | String | Kept for backward compatibility. It will be either ***** or null depending on whether passwordCredentialId is set or not. |
| passwordCredentialId | Long | This is the credential id associated with the endpoint password. |
| privateKey | String | Fully-qualified path of the SSH private key file. |
| passphrase | String | Kept for backward compatibility. It will be either ***** or null depending on whether passphraseCredentialId is set or not. |
| passphraseCredentialId | Long | This is the credential id associated with the endpoint passphrase. |
| runAsUserName | String | An optional user to run as (using sudo) after establishing connection to the endpoint. |
| dockerHost | Boolean | This indicates if endpoint is docker engine. |
| k8sCluster | Boolean | This indicates if endpoint is kubernetes engine. |
| k8sContext | String | Name of the configured K8s context. |
| endpointGroup | String | This is a character sequence associated with this Endpoint's corresponding group. |
| endpointSubgroup | String | This is a character sequence associated with this Endpoint's corresponding sub-group. |
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Endpoint was found and returned |
| 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 13901 and had the following attributes
{
"passwordCredentialId": 12345,
"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",
"passphraseCredentialId": 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
{
"password": "*****",
"passwordCredentialId": 12345,
"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": "*****",
"passphraseCredentialId": 54321
}
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 |
|---|---|---|---|
| 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 |
Response
Attributes | Type | Description |
|---|---|---|
| endpointId | Long | This is an identification number of an existing Endpoint. |
| endpointName | String | This is the unique name of the corresponding Endpoint. |
| description | String | This is a description of the Endpoint. |
| isActive | Boolean | This is a Boolean that tracks whether or not the Endpoint is active. |
| connectionType | String | This specifies the connection Type. |
| osType | String | This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. |
| endpointAddress | String | This is a String associated with the address of the endpoint. |
| endpointPort | String | This is a port associated with an SSH connection. |
| baseDirectory | String | This is a character sequence which corresponds to the base directory of the corresponding Endpoint. |
| isBaseDirectoryExpression | String | "Y" if the base directory is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N". |
| javaPath | String | This is a character sequence that specifies the java path of the corresponding Endpoint. |
| isJavaPathExpression | String | "Y" if the Java path is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N". |
| password | String | Kept for backward compatibility. It will be either ***** or null depending on whether passwordCredentialId is set or not. |
| passwordCredentialId | Long | This is the credential id associated with the endpoint password. |
| privateKey | String | Fully-qualified path of the SSH private key file. |
| passphrase | String | Kept for backward compatibility. It will be either ***** or null depending on whether passphraseCredentialId is set or not. |
| passphraseCredentialId | Long | This is the credential id associated with the endpoint passphrase. |
| runAsUserName | String | An optional user to run as (using sudo) after establishing connection to the endpoint. |
| dockerHost | Boolean | This indicates if endpoint is docker engine. |
| k8sCluster | Boolean | This indicates if endpoint is kubernetes engine. |
| k8sContext | String | Name of the configured K8s context. |
| endpointGroup | String | This is a character sequence associated with this Endpoint's corresponding group. |
| endpointSubgroup | String | This is a character sequence associated with this Endpoint's corresponding sub-group. |
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
{
"description": null,
"passwordCredentialId": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Motel6",
"endpointAddress": "localhost",
"endpointId": 14517,
"passphrase": null,
"passphraseCredentialId": null,
"connectionType": "LOCALHOST",
"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",
"endpointAddress": "localhost",
"endpointId": 14518,
"passphrase": null,
"passphraseCredentialId": 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
[
{
"description": null,
"password": null,
"passwordCredentialId": null,
"userName": null,
"isActive": true,
"privateKey": null,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"osType": null,
"javaPath": "ServerJavaHome",
"endpointName": "Motel6",
"endpointAddress": "localhost",
"endpointId": 14517,
"passphrase": null,
"passphraseCredentialId": null,
"connectionType": "LOCALHOST",
"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",
"endpointAddress": "localhost",
"endpointId": 14518,
"passphrase": null,
"passphraseCredentialId": null,
"connectionType": "LOCALHOST",
"endpointPort": null,
"endpointGroup": "Germany",
"endpointSubgroup": "Berlin",
"runAsUserName": null
}
]
Test (using GET)
API URL
http://host:port/flexdeploy/rest/v1/topology/endpoint/test
This GET service will test 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 |
Response
| Attributes | Type | Description |
|---|---|---|
| message | String | If the test failed, the message will provide more information on why it failed. Otherwise, the message will be ‘Connection to Endpoint [name] was successful' |
| successful | Boolean | Whether or not the test was successful |
| 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
Assuming we have an endpoint setup like the following, and it is a valid endpoint
{
"passwordCredentialId": 12345,
"description": "description",
"userName": "userName",
"privateKey": "privateKey",
"isActive": true,
"baseDirectory": "ServerInstallRoot + '/localhost'",
"endpointName": "GOODPOST1",
"connectionType": "SSH",
"endpointAddress": "hostname:port",
"endpointId": 13910,
"endpointSubgroup": "subGroupTester",
"endpointPort": "1",
"endpointGroup": "endpointGroup",
"runAsUserName": "TestInput",
"osType": "UNIX",
"javaPath": "ServerJavaHome",
"passphrase": "Passphrase",
"passphraseCredentialId": 54321
}
When we run a GET request at the following URL
http://host:port/flexdeploy/rest/v1/topology/endpoint/test/13901
The GET request would return the following JSON testresult object
{
"message": "Test was successful",
"successful": true
}
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
| Attributes | Type | Required | Description |
|---|---|---|---|
| description | String | No | A description of the Endpoint. |
| connectiontype | String | Yes | This specifies the connection Type. "SSH" or "LOCALHOST" |
| isActive | Boolean | No | This is a Boolean that tracks whether or not the Endpoint is active. Default is true. |
| 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. |
| 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 passwordCredentialId, or privateKey is required when connectionType is "SSH" otherwise not used. |
| endpointName | String | Yes | This is the unique name of the corresponding Endpoint. |
| privateKey | 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. |
| 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. |
| 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. |
| 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. |
Response
Attributes | Type | Description |
|---|---|---|
| endpointId | Long | This is an identification number of an existing Endpoint. |
| endpointName | String | This is the unique name of the corresponding Endpoint. |
| description | String | This is a description of the Endpoint. |
| isActive | Boolean | This is a Boolean that tracks whether or not the Endpoint is active. |
| connectionType | String | This specifies the connection Type. |
| osType | String | This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. |
| endpointAddress | String | This is a String associated with the address of the endpoint. |
| endpointPort | String | This is a port associated with an SSH connection. |
| baseDirectory | String | This is a character sequence which corresponds to the base directory of the corresponding Endpoint. |
| isBaseDirectoryExpression | String | "Y" if the base directory is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N". |
| javaPath | String | This is a character sequence that specifies the java path of the corresponding Endpoint. |
| isJavaPathExpression | String | "Y" if the Java path is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N". |
| password | String | Kept for backward compatibility. It will be either ***** or null depending on whether passwordCredentialId is set or not. |
| passwordCredentialId | Long | This is the credential id associated with the endpoint password. |
| privateKey | String | Fully-qualified path of the SSH private key file. |
| passphrase | String | Kept for backward compatibility. It will be either ***** or null depending on whether passphraseCredentialId is set or not. |
| passphraseCredentialId | Long | This is the credential id associated with the endpoint passphrase. |
| runAsUserName | String | An optional user to run as (using sudo) after establishing connection to the endpoint. |
| dockerHost | Boolean | This indicates if endpoint is docker engine. |
| k8sCluster | Boolean | This indicates if endpoint is kubernetes engine. |
| k8sContext | String | Name of the configured K8s context. |
| endpointGroup | String | This is a character sequence associated with this Endpoint's corresponding group. |
| endpointSubgroup | String | This is a character sequence associated with this Endpoint's corresponding sub-group. |
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,
{
"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
{
"password": "*****",
"passwordCredentialId": 74839,
"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": "*****",
"passphraseCredentialId": 29084
}
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
| Attributes | Type | Required | Description |
|---|---|---|---|
| Id | URL | Yes | URL parameter to specify which endpoint to replace |
| description | String | No | A description of the Endpoint. |
| connectiontype | String | Yes | This specifies the connection Type. "SSH" or "LOCALHOST" |
| isActive | Boolean | No | This is a Boolean that tracks whether or not the Endpoint is active. Default is true. |
| 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. |
| 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. |
| endpointName | String | Yes | This is the unique name of the corresponding Endpoint. |
| privateKey | 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. |
| 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. |
| 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. |
| 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. |
Response
Attributes | Type | Description |
|---|---|---|
| endpointId | Long | This is an identification number of an existing Endpoint. |
| endpointName | String | This is the unique name of the corresponding Endpoint. |
| description | String | This is a description of the Endpoint. |
| isActive | Boolean | This is a Boolean that tracks whether or not the Endpoint is active. |
| connectionType | String | This specifies the connection Type. |
| osType | String | This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. |
| endpointAddress | String | This is a String associated with the address of the endpoint. |
| endpointPort | String | This is a port associated with an SSH connection. |
| baseDirectory | String | This is a character sequence which corresponds to the base directory of the corresponding Endpoint. |
| isBaseDirectoryExpression | String | "Y" if the base directory is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N". |
| javaPath | String | This is a character sequence that specifies the java path of the corresponding Endpoint. |
| isJavaPathExpression | String | "Y" if the Java path is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N". |
| password | String | Kept for backward compatibility. It will be either ***** or null depending on whether passwordCredentialId is set or not. |
| passwordCredentialId | Long | This is the credential id associated with the endpoint password. |
| privateKey | String | Fully-qualified path of the SSH private key file. |
| passphrase | String | Kept for backward compatibility. It will be either ***** or null depending on whether passphraseCredentialId is set or not. |
| passphraseCredentialId | Long | This is the credential id associated with the endpoint passphrase. |
| runAsUserName | String | An optional user to run as (using sudo) after establishing connection to the endpoint. |
| dockerHost | Boolean | This indicates if endpoint is docker engine. |
| k8sCluster | Boolean | This indicates if endpoint is kubernetes engine. |
| k8sContext | String | Name of the configured K8s context. |
| endpointGroup | String | This is a character sequence associated with this Endpoint's corresponding group. |
| endpointSubgroup | String | This is a character sequence associated with this Endpoint's corresponding sub-group. |
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
{
"description": "description",
"userName": "userName",
"passwordCredentialId": 74839,
"isActive": true,
"privateKey": "privateKey",
"endpointName": "GoodPost3",
"osType": null,
"connectionType": "SSH",
"javaPath": "ServerJavaHome",
"endpointAddress": "endpointAddress",
"baseDirectory": "ServerInstallRoot + '/localhost'",
"passphrase": "passphrase",
"passphraseCredentialId": 29084,
"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,
{
"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"
}
The PUT request would then update the endpoint with Id 11101 and return the following JSON endpoint object.
{
"description": "newDescription",
"userName": "newUserName",
"password": "newPassword",
"passwordCredentialId": 74839,
"isActive": true,
"privateKey": "newPrivateKey",
"endpointName": "GoodPost3",
"osType": "UNIX",
"connectionType": "SSH",
"javaPath": "ServerJavaHome",
"endpointAddress": "endpointAddress",
"baseDirectory": "ServerInstallRoot + '/localhost'",
"passphrase": "passphrase",
"passphraseCredentialId": 29084,
"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
| Attributes | Type | Required | Description |
|---|---|---|---|
| Id | URL | Yes | URL parameter to specify which endpoint to patch |
| description | String | No | A description of the Endpoint. |
| connectiontype | String | No | This specifies the connection Type. "SSH" or "LOCALHOST" |
| isActive | Boolean | No | This is a Boolean that tracks whether or not the Endpoint is active. Default is true. |
| endpointAddress | String | No | This is a String associated with the address of the endpoint. |
| endpointPort | String | No | This is a port associated with an SSH connection. Note: Only applicable when connectionType is "SSH", otherwise not used. |
| 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 the id of the credential associated with the endpoint password. Note: Only applicable when connectionType is "SSH" otherwise not used. |
| endpointName | String | Yes | This is the unique name of the corresponding Endpoint. |
| privateKey | String | No | Fully-qualified path of the SSH private key file. Note: Only applicable when connectionType is "SSH" otherwise not used. |
| osType | String | No | 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. |
| baseDirectory | 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. |
| 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. |
Response
Attributes | Type | Description |
|---|---|---|
| endpointId | Long | This is an identification number of an existing Endpoint. |
| endpointName | String | This is the unique name of the corresponding Endpoint. |
| description | String | This is a description of the Endpoint. |
| isActive | Boolean | This is a Boolean that tracks whether or not the Endpoint is active. |
| connectionType | String | This specifies the connection Type. |
| osType | String | This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. |
| endpointAddress | String | This is a String associated with the address of the endpoint. |
| endpointPort | String | This is a port associated with an SSH connection. |
| baseDirectory | String | This is a character sequence which corresponds to the base directory of the corresponding Endpoint. |
| isBaseDirectoryExpression | String | "Y" if the base directory is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N". |
| javaPath | String | This is a character sequence that specifies the java path of the corresponding Endpoint. |
| isJavaPathExpression | String | "Y" if the Java path is a Groovy Expression "N" if it isn't. This cannot be set manually through the API, it will automatically be set to "N". |
| password | String | Kept for backward compatibility. It will be either ***** or null depending on whether passwordCredentialId is set or not. |
| passwordCredentialId | Long | This is the credential id associated with the endpoint password. |
| privateKey | String | Fully-qualified path of the SSH private key file. |
| passphrase | String | Kept for backward compatibility. It will be either ***** or null depending on whether passphraseCredentialId is set or not. |
| passphraseCredentialId | Long | This is the credential id associated with the endpoint passphrase. |
| runAsUserName | String | An optional user to run as (using sudo) after establishing connection to the endpoint. |
| dockerHost | Boolean | This indicates if endpoint is docker engine. |
| k8sCluster | Boolean | This indicates if endpoint is kubernetes engine. |
| k8sContext | String | Name of the configured K8s context. |
| endpointGroup | String | This is a character sequence associated with this Endpoint's corresponding group. |
| endpointSubgroup | String | This is a character sequence associated with this Endpoint's corresponding sub-group. |
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
{
"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,
{
"endpointName": "PatchedEndpoint",
"endpointGroup": null
}
The PATCH request would then update the endpoint with Id 13909 and return the following JSON endpoint object
{
"password": null,
"passwordCredentialId": 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,
"passphraseCredentialId": null
}