Base URL for Environment REST API
http://host:port/flexdeploy/rest/topology/endpoint
Jump To:
Overview:
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.
Each function returns a JSON Endpoint object. An Endpoint object has these attributes:
| Attributes | Type | Description |
|---|---|---|
| Description | String | This is a description of the Endpoint. |
| Connection Type | String | This specifies the connection Type. MANDATORY: "SSH" or "LOCALHOST" |
| isActive | Boolean | This is a Boolean that tracks whether or not the Endpoint is active. |
| Endpoint Address | String | This is a String associated with the address of the endpoint. |
| Endpoint Port | String | This is a port associated with an SSH connection. DEPENDENT: Mandatory when connectionType is "SSH", otherwise not used. |
| Endpoint Id | Long | This is a number associated with the identification number of an existing Endpoint. |
| Password | String | This is a character sequence used to access the corresponding remote connection. DEPENDENT: mandatory when connectionType is "SSH" otherwise not used. |
| Endpoint Name | String | This is the unique name of the corresponding Endpoint. UNIQUE |
| Private Key | String | This is a character sequence associated with the corresponding remote connection. DEPENDENT: Mandatory when connectionType is "SSH" otherwise not used. |
| OS Type | String | This is a character sequence which corresponds to the operating system type used in the corresponding remote connection. DEPENDENT: Mandatory when connectionType is "SSH" otherwise not used. |
| Base Directory | String | This is a character sequence which corresponds to the base directory of the corresponding Endpoint. MANDATORY |
| Endpoint Sub Group | String | This is a character sequence associated with this Endpoint's corresponding sub-group. |
| Passphrase | String | This is a character sequence associated with the correspond remote connection. DEPENDENT: Mandatory when connectionType is "SSH" otherwise not used. |
| Java Path | String | This is a character sequence that specifies the java path of the corresponding Endpoint. MANDATORY |
| Run As User Name | String | This is a character sequence that specifies the runAsUserName variable. Dependent: Mandatory when connection Type is "SSH" otherwise not used. |
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/topology/endpoint/{Id}
Parameters
Parameter | Required | Type | Description |
|---|---|---|---|
| Id | Yes | URL | This is a URL parameter for the Id which is used to find and return an Endpoint |
TODO: return codes table for each method and add parameter tables to PATCH etc.
GET by 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/topology/endpoint?
Append the following character sequences to the above URL to specify Query parameters.
Use '&' between successive query parameters:
name={name}
address={address}
group={group}
subgroup={subgroup}
Examples:
To Specify the name parameter only:
http://host:port/flexdeploy/rest/topology/endpoint?name={name}
To Specify the name and group parameters:
http://host:port/flexdeploy/rest/topology/endpoint?name={name}&group={group}
To Specify the name, address and group parameters:
http://host:port/flexdeploy/rest/topology/endpoint?name={name}&address={address}&group={group}
The query parameters are not case sensitive. Searching by name=NAME is the same as searching by name=name.
Parameters
Parameter | Required | Type | Description |
|---|---|---|---|
| Name | No | URL | This is a URL query parameter for the name which is used to search the endpoints. |
| Address | No | URL | This is a URL query parameter for the address which is used to search the endpoints. |
| Group | No | URL | This is a URL query parameter for the group which is used to search the endpoints. |
| Sub Group | No | URL | This is a URL query parameter for the sub group which is used to search the endpoints. |
POST
This POST service will create a new Endpoint with the same attributes as the given JSON object.
API URL
Parameters
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.
{
"description": "description",
"userName": "userName",
"password": "password",
"isActive": true,
"privateKey": "privateKey",
"endpointName": "GoodPost3",
"osType": null,
"connectionType": "SSH",
"javaPath": "ServerJavaHome",
"endpointAddress": "endpointAddress",
"baseDirectory": "ServerInstallRoot + '/localhost'",
"passphrase": "passphrase",
"endpointId": 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 absent of it's value is null it will not be updated in the Endpoint.