Rest API – Service Groups

Retrieve

To retrieve the current information about a Service Group as a JSON document, send a GET request with the following URL format:

http://localhost:38050/web_services/servicegroup?account=firescope&name=Orders

Note: Don’t forget to change the domain name (localhost) and query parameter values (account, and name) to match your environment and data.

Search

Searching provides for the ability to return multiple results in a single call using various filter criteria. To accomplish this, a GET request is sent with a parameter search=true. Every other field besides account is optional and is used to further filter the results. Pagination is mandatory and accomplished using the page and size parameters. The JSON response will wrap the result list and also display the page and the size. The size in the response represents the number of results actually returned, not the size in the request. The response does not contain a count of the total number of pages or the total number of records for performance reasons. The client is expected to keep querying, increasing the page each time, until the result size is less than the requested size, indicating no more results.

http://localhost:38050/web_services/...age=0&size=100

Note: Don’t forget to change the domain name (localhost) and query parameter values (account, logicalgroup, name, page and size) to match your environment and data.

{
   "account_id": "firescope",
   "entity": "servicegroup",
   "page": 0,
   "size": 2,
   "results": [
      {
         "account_id": "firescope",
         "name": "Orders",
         "servicegrouptypeid": 1,
         "logicalgroup": [ "Windows Servers", "Databases" ]
      },
      {
         "account_id": "firescope",
         "name": "Sales",
         "servicegrouptypeid": 1,
         "logicalgroup": [ "Databases" ]
      }
   ]
 }

Create or Update

To create or update a Service Group, POST a JSON document with the specific information for that Service Group to the following

URL: http://localhost:38050/web_services/servicegroup

Note: Don’t forget to change the domain name (localhost)to match your environment and data.

Use the following example as a guide.

{
  "account_id" : "firescope",
  "name" : "Orders",
  "servicegrouptypeid" : 1
  "ci" : [
    {"edge_device" : "edge1", "ci" : "mysql"},
    {"edge_device" : "edge2", "ci" : "apache"}
  ],
  "logicalgroup" : ["Windows Servers", "Databases"]
}

Delete

To delete a Service Group, send an HTTP DELETE request with the same query parameters as the GET request.See the Retrieve for the URL format and query parameter descriptions.