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.
...
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 |
| Include Page | ||||
|---|---|---|---|---|
|
Response Codes
| HTTP Code | Description |
|---|---|
| 200 | Endpoint was found and returned |
| 400 | Bad request |
| 401 | Unauthorized |
| 500 | Unexpected internal server error |
Example
...
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 | ||
|---|---|---|
| ||
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} |
...
PATCH
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 it will not be updated in the Endpoint.
| Info | ||
|---|---|---|
| ||
http://host:port/flexdeploy/rest/v1/topology/endpoint/{Id} |
...