Riverbed Cascade Profiler REST API.
Created May 22, 2019 at 06:52 PM

Overview

Overview

The documentation pages in this section describe the RESTful APIs included with Cascade Profiler and Cascade Express products. It is assumed that the reader has practical knowledge of RESTful APIs, so the documentation does not go into detail about what REST is and how to use it. Instead the documentation focuses on what data can be accessed and how to access it.

The primary focus of the current version of the API is on providing access to reporting data. The following information can be accessed via the API:

  • Reporting data (traffic data, service data, event list data, and user data)
  • Information about network devices
  • Control over SDN virtual network settings (SDN virtual network settings are a licensed feature)
  • Information about system users

Details about REST resources can be found in the Resources section. This overview continues with how to run reports and retrieve data from them.

Running a report

The steps for running a report are described below. An easy way to learn how to run reports and get data is to use the Demo Reports section of this documentation. In that section a number of example reports are listed. If you click on any of the examples, the report will run along with a listing on the right side of the screen for each step in the process. It displays the REST resource, HTTP method, headers and body for both the request and response.

Follow these steps to run a report:

1. Create a new report by posting report criteria to the server.

A criteria structure in either JSON or XML is submitted to the server using the HTTP POST method. The resource to which the criteria structure is posted is called /profiler/1.0/reporting/reports. The details are described in the Resources section of this documentation.

A key part of the report criteria is the ID of the template that should be used to run the report. A special system template ID 184 that provides a high degree of flexibility is used in demo reports in this documentation. Additionally, any template that is saved via the user interface of the product can be used to run a report. In order to save a template, the ID of that template must be passed in the report criteria structure instead of 184. A template can be configured via the user interface, saved via the product and then used in the REST API to generate reports and retrieve them in a rendered form or in raw data form. Once a template is saved, its ID can be obtained via the /api/profiler/1.0/reporting/templates REST resource.

2. Poll report status until the report completes.

It may take a while for a report to complete. While the report is running, the client must poll for report status to know when the report completes. When the call to create a new report succeeds, it returns the URL for the newly created report. That URL may look similar to /profiler/1.0/reporting/reports/1000, which is the ID of the new report.

The general way to describe this in REST documentation is /profiler/1.0/reporting/reports/{id} so this documentation uses that syntax throughout. Note that the client does not need to know that {id} is really an ID of a report. Instead the client should treat a given report, for example /profiler/1.0/reporting/reports/1000, as a REST resource without parsing the parts of the URL.

The status of a report can be obtained by executing a GET method on the report URL. The client should wait while the report is running and until the status turns to state.

3. Retrieve the report data.

Once the report completes, the client can retrieve its data or the rendered version of the report in a number of formats.

The following resources can be used to retrieve a rendered version of the report:

  • /profiler/1.0/reporting/reports/{id}/view.pdf
  • /profiler/1.0/reporting/reports/{id}/view.csv
These are for PDF and CSV versions respectively.

If the client is a script that needs access to raw data, the /profiler/1.0/reporting/reports/{id}/queries resource can be used with the GET method to obtain the list of elements (queries) first. The data shown in a typical report on the user interface may come from more than one query, which is why the report structure needs to be determined first. However, the system template 184 described above will have only one query and is easy to use for simple scripts.

Each query resource provides metadata about the query, such as the list of columns with descriptions of what the columns are.

Once the query is chosen, the /profiler/1.0/reporting/reports/{id}/queries/{id} resource can be used to get the report data.

The simple overview provided above cannot substitute for full documentation and it is not intended to do so. Please refer to Demo Reports section to see how reports are run. Look at the Coding Examples under General Information and explore Resources section of this documentation for more information.

Authentication

All REST requests must be authenticated. The Authentication section of the Common 1.0 API describes which authentication methods are presently supported. There are also examples that show how to use each of the different authentication methods.

/api/profiler/1.2 to /api/profiler/1.3 Changelog

Added the following resources:

  • /api/profiler/1.3/services
  • /api/profiler/1.3/reporting/templates/builtin
  • /api/profiler/1.3/reporting/templates/{template_id}/livedata
  • /api/profiler/1.3/users/tacacs/test_server
  • /api/profiler/1.3/users/tacacs/test_user
  • /api/profiler/1.3/host_group_types/{id}/favorite
For more information please read the Resources documentation.

Added the following methods to existing resources:

  • GET /api/profiler/1.3/steelheads/oauth_code
For more information please read the Resources documentation.

Other changes:

  • Added device name to /api/profiler/1.3/interfaces

Running a report: Sample PHP script

Run a report to get bytes and packets for the top 20 hosts using the application WEB. Use BASIC Authentication.

<?php

define('HOST', '127.0.0.1'); // IP address of Profiler
define('BASIC_AUTH', 'admin:admin');

// Timeframe
$end   = time() - 3*60; 
$start = $end   - 5*60;

// Lib functions

// HTTP POST
function do_POST($url, $string, &$info) {
  $curl = curl_init();
  curl_setopt($curl, CURLOPT_URL, $url);
  curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC ) ;
  curl_setopt($curl, CURLOPT_USERPWD, BASIC_AUTH);
  curl_setopt($curl, CURLOPT_SSLVERSION,3);
  curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, FALSE);
  curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 2);
  curl_setopt($curl, CURLOPT_HEADER, true);
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
  curl_setopt($curl, CURLOPT_POST,           1);
  curl_setopt($curl, CURLOPT_POSTFIELDS,     $string);
  $output = curl_exec($curl);
  $info   = curl_getinfo($curl);
  curl_close($curl);

  $headers = substr($output, 0, $info['header_size']);
  $headers = explode("\n", $headers);
  $info['headers'] = $headers;
  $body = substr($output, $info['header_size']);
  return $body;
}

// HTTP GET
function do_GET($url, &$info) {
  $curl = curl_init();
  curl_setopt($curl, CURLOPT_URL, $url);
  curl_setopt($curl, CURLOPT_HTTPAUTH, CURLAUTH_BASIC ) ;
  curl_setopt($curl, CURLOPT_USERPWD, BASIC_AUTH);
  curl_setopt($curl, CURLOPT_SSLVERSION,3);
  curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, FALSE);
  curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 2);
  curl_setopt($curl, CURLOPT_HEADER, true);
  curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($curl, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));
  curl_setopt($curl, CURLOPT_HTTPGET, true);
  $output = curl_exec($curl);
  $info   = curl_getinfo($curl);
  curl_close($curl);

  $headers = substr($output, 0, $info['header_size']);
  $headers = explode("\n", $headers);
  $info['headers'] = $headers;
  $body = substr($output, $info['header_size']);
  return $body;
}

// Finds and returns HTTP header
function get_header($headers, $header) {
  foreach($headers as $h) {
    if (strpos($h, $header . ':') !== false)
      return trim(substr($h, 10));
  }
  echo "Unable to find {$header} header!\n";
  exit;
}

// Locates a column by id and returns the name
function find_column_name_by_id($columns, $id) {
  foreach ($columns as $c) {
    if ($c['id'] == $id)
      return $c['name'];
  }
  return 'Unknown';
}

// CSV helper
function echo_csv($headers, $rows) {
  echo implode(',', $headers) . "\n";
  foreach ($rows as $row)
    echo implode(',', $row) . "\n";
}

// End lib functions

$struct = 
  array('template_id' => 184,
        'criteria'    => Array('time_frame' => array('start' => $start,
                                                     'end'   => $end),
                               'traffic_expression' => 'app WEB',
                               'query' => array('realm'       => 'traffic_summary',
                                                'group_by'    => 'hos',
                                                'sort_column' => 33,
                                                'columns'     => array(6, 33, 34))));

$json    = json_encode($struct);
$columns = $struct['criteria']['query']['columns'];

// Post to run the report
$url = 'https://' . HOST . '/api/profiler/1.0/reporting/reports.json';
echo "Run report:\nPOST {$url}\n{$json}\n\n";
$info = array();
do_POST($url, $json, $info);
if ($info['http_code'] != 201) {
  echo "Unable to run report!\n";
  exit(1);
}
$location = get_header($info['headers'], 'Location');
echo "Generated: {$location}\n\n";
$status_url = 'https://' . HOST . '' . $location . '.json';

// Wait for it to complete
echo "Please wait\n";
while (true) {
  $info = array();
  $output = do_GET($status_url, $info);
  $s = json_decode($output, 1);
  print " Percent completed {$s['percent']}, seconds remaining {$s['remaining_seconds']}...\n";
  if ($s['status'] == 'completed') {
    echo "Completed\n\n";
    break;
  }
  sleep(1);
}

// Get all quesries (In this exampe it is only one)
$queries_url = 'https://' . HOST . '' . $location . '/queries.json';
$output = do_GET($queries_url, $info);
$queries = json_decode($output, 1);

// Print the data from all queries
foreach ($queries as $q) {
  $query_id = $q['id'];
  $data_url = 'https://' . HOST . '' . $location . '/queries/' . $query_id . '.json?offset=0&limit=20&columns=' . join(',', $columns);
  $info = array();
  $output = do_GET($data_url, $info);
  $data = json_decode($output, 1);

  $h = array();
  foreach ($columns as $c)
    $h[] = find_column_name_by_id($q['columns'], $c);

  echo_csv($h, $data['data']);
  echo "\n";
}

?>

Running a report: Sample Python script

Run a report to get bytes and packets for the top 20 hosts using the application WEB. Use BASIC Authentication.

from urlparse import urlparse
import base64
import logging
import httplib
import json
import time
import sys

HOST       = '127.0.0.1'
BASIC_AUTH = 'admin:admin'

end   = int(time.time() - 3*60)
start = int(end - 5*60);

# Lib functions

def do_POST(url, string):
    '''HTTP POST'''

    conn = httplib.HTTPSConnection(HOST, 443)

    headers = {"Authorization"  : "Basic %s" % base64.b64encode(BASIC_AUTH),
               "Content-Length" : str(len(string)),
               "Content-Type"   : "application/json"}

    conn.request('POST', url, body=string, headers=headers)

    res = conn.getresponse()

    info = {"status"  : res.status,
            "headers" : res.getheaders()}

    data = res.read()
    conn.close()
    return data, info

def do_GET(url):
    '''HTTP GET'''

    conn = httplib.HTTPSConnection(HOST, 443)

    headers = {"Authorization"  : "Basic %s" % base64.b64encode(BASIC_AUTH),
               "Content-Length" : 0,
               "Content-Type"   : "application/json"}

    conn.request('GET', url, body="", headers=headers)

    res = conn.getresponse()

    info = {"status"  : res.status,
            "headers" : res.getheaders()}

    data = res.read()
    conn.close()
    return data, info

def get_header(headers, header):
  '''Finds and returns HTTP header'''
  for i in headers:
    if (i[0] == header):
      return i[1]
  return ""

def find_column_name_by_id(columns, cid):
  '''Locates a column by id and returns the name'''
  for c in columns:
    if (c['id'] == cid):
      return c['name']
  return 'Unknown'

def echo_csv(headers, rows):
  '''CSV helper'''
  print ','.join(headers)
  for row in rows:
    print ','.join(row)

# End lib functions

struct = {
    "template_id" : 184,
    "criteria" : {
        "time_frame" : {
            "start" : start,
            "end"   : end
            },
        "traffic_expression" : "app WEB",
        "query" : {
            "realm"      : "traffic_summary",
            "group_by"   : "hos",
            "sort_column": 33,
            "columns"    : [6, 33, 34]
            }
        }
    }

to_post = json.dumps(struct)
columns = struct["criteria"]["query"]["columns"]

# Post to run the report
url = "https://%s/api/profiler/1.0/reporting/reports.json" % HOST
print "Run report:"
print "POST %s" % url
print "%s" % to_post

output, info = do_POST(url, to_post)
if (info['status'] is not 201):
  print "Unable to run report"
  sys.exit(1)

location = get_header(info['headers'], 'location')
print ""
print "Generated: %s" % location
print ""

status_url = "https://%s%s.json" % (HOST, location)

# Wait for it to complete
print "Please wait"
while (True):
  output, info = do_GET(status_url)
  s = json.loads(output)
  print "Percent completed %s, seconds remaining %s..." % (s["percent"], s["remaining_seconds"])
  if (s["status"] == "completed"):
    print "Completed"
    break
  time.sleep(1)

# Get all quesries (In this exampe it is only one)
queries_url = "https://%s%s/queries.json" % (HOST, location)

output, info = do_GET(queries_url)
queries = json.loads(output)

# Print the data from all queries
for q in queries:
  query_id = q['id'];
  columns_str = ','.join([repr(i) for i in columns])
  data_url = "https://%s%s/queries/%s.json?offset=0&limit=20&columns=%s" % (HOST, location, query_id, columns_str)
  output, info = do_GET(data_url)
  data = json.loads(output)

  h = []
  for c in columns:
    h.append(find_column_name_by_id(q["columns"], c))

  print ""  
  echo_csv(h, data["data"])

Running a report: Sample Perl script

Run a report to get bytes and packets for the top 20 hosts using the application WEB. Use BASIC Authentication.

#!/usr/bin/perl
use strict;
use warnings;

use LWP::UserAgent;
use HTTP::Request;
use List::MoreUtils qw(firstidx);
use JSON qw( encode_json decode_json );

use constant HOST     => '127.0.0.1';
use constant LOGIN    => 'admin';
use constant PASSWORD => 'admin';

our $ua = LWP::UserAgent->new;
$ua->agent("ProfilerScript/0.1");

our $API_BASE = "https://127.0.0.1";

sub _request($) 
{
  my $req = shift;

  $req->header('Accept' => 'application/json');
  $req->authorization_basic(LOGIN, PASSWORD);

  my $res = $ua->request($req);

  return {
    code    => $res->code,
    status  => $res->status_line,
    headers => $res->headers(),
    data    => decode_json($res->content)
  };
}

sub GET($) 
{
  my $req = HTTP::Request->new(GET => $API_BASE . shift);
  return _request($req);
}

sub POST($$) 
{
  my $req = HTTP::Request->new(POST => $API_BASE . shift);
  $req->content_type('application/json');
  $req->content(encode_json(shift));

  return _request($req);
}

my $end   = time();
my $start = $end - 5 * 60;

my $struct = { 
  template_id => 184, 
  criteria    => { 
    time_frame => { 
      start => $start, 
      end   => $end 
    }, 
    traffic_expression => "app WEB", 
    query => { 
      realm        => "traffic_summary", 
      group_by     => "hos", 
      sort_column  => 33, 
      columns      => [6, 33, 34] 
    } 
  } 
};

print "Running report... ";

my $response = POST('/api/profiler/1.0/reporting/reports', $struct);
die "Unable to run report. $response->{data}->{error_text}" unless $response->{code} == 201;

my $loc = $response->{headers}->header('Location');

while (1) 
{
  $response = GET($loc);
  printf "\rRunning report, %3d%% done, %d seconds remaining...   ", 
    $response->{data}->{percent}, 
    $response->{data}->{remaining_seconds};

  last if $response->{data}->{status} eq 'completed';
  sleep(1);
};

print "\nLoading data...\n";

$response = GET($loc . '/queries');
die "Unable to load queries. $response->{data}->{error_text}" unless $response->{code} == 200;

foreach my $query (@{$response->{data}})
{
  my @columns = @{$struct->{criteria}->{query}->{columns}};
  my $columns = join ',', @columns;

  my $data_response = GET("$loc/queries/$query->{id}?offset=0&limit=20&columns=$columns");
  die "Unable to load data. $response->{data}->{error_text}" unless $response->{code} == 200;

  my @indices = map { my $id = $_; firstidx { $_->{id} == $id } @{$query->{columns}} } @columns;

  print join ",", map { qq~"$query->{columns}->[$_]->{name}"~; } @indices;
  print "\n";

  foreach my $row (@{$data_response->{data}->{data}}) {
    print join ",", @$row;
    print "\n";
  }
}

Running a report: Sample .Net/C# code

Run a report to get bytes and packets for the top 20 hosts using the application WEB. Use BASIC Authentication.

Program.cs:

using System;
using System.Collections.Generic;
using System.Net;
using System.Runtime.Serialization.Json;
using System.Text;
using System.IO;
using System.Net.Security;
using System.Security.Cryptography.X509Certificates;
using System.Linq;
using System.Threading;
using System.Web.Script.Serialization;

namespace CascadeRestClient
{
    public class ReportUpdate
    {
        public string status { get; set; }
        public string user_id { get; set; }
        public string name { get; set; }
        public string percent { get; set; }
        public string id { get; set; }
        public string remaining_seconds { get; set; }
        public string run_time { get; set; }
        public string saved { get; set; }
        public string template_id { get; set; }
        public string size { get; set; }
    }

    public class Column
    {
        public string strid { get; set; }
        public string metric { get; set; }
        public string rate { get; set; }
        public string statistic { get; set; }
        public int id { get; set; }
        public string unit { get; set; }
        public string category { get; set; }
        public string severity { get; set; }
        public string area { get; set; }
        public bool @internal { get; set; }
        public string role { get; set; }
        public string cli_srv { get; set; }
        public string type { get; set; }
        public bool available { get; set; }
        public string direction { get; set; }
        public string comparison { get; set; }
        public bool sortable { get; set; }
        public string name { get; set; }
        public string comparison_parameter { get; set; }
        public bool has_others { get; set; }
        public bool context { get; set; }
        public string name_type { get; set; }
    }

    public class QueryResult
    {
        public string direction { get; set; }
        public string actual_log { get; set; }
        public int actual_t0 { get; set; }
        public bool sort_desc { get; set; }
        public string area { get; set; }
        public string metric { get; set; }
        public int sort_col { get; set; }
        public string parent_id { get; set; }
        public string rate { get; set; }
        public string group_by { get; set; }
        public string role { get; set; }
        public List&lt;Column&gt; columns { get; set; }
        public string statistic { get; set; }
        public string type { get; set; }
        public string id { get; set; }
        public string unit { get; set; }
        public int actual_t1 { get; set; }
    }

    public class QueryData
    {
        public List&lt;List&lt;string&gt;&gt; data { get; set; }
        public int data_size { get; set; }
        public List&lt;string&gt; totals { get; set; }
    }

    class Program
    {
        static string BASIC_AUTH = "admin:admin";

        // callback used to validate the self-gen certificate in an SSL conversation
        private static bool ValidateRemoteCertificate(object sender, X509Certificate cert, X509Chain chain, SslPolicyErrors policyErrors)
        {
            return true;
            /*
            X509Certificate2 certv2 = new X509Certificate2(cert);
            if (certv2.GetNameInfo(X509NameType.SimpleName,true) == "www.riverbed.com")
                return true;

            return false;
             */
        }

        static void Main(string[] args)
        {
            if (args.Length == 0 || string.IsNullOrWhiteSpace(args[0]))
            {
                Console.WriteLine("Usage: CascadeRestClient hostname");
                return;
            }
            try
            {
                //Code to allow run with self-signed certificates
                // validate cert by calling a function
                ServicePointManager.ServerCertificateValidationCallback += new RemoteCertificateValidationCallback(ValidateRemoteCertificate);

                //Starting to run rest 
                string rootUrl = "https://" + args[0];
                string requestUrl = rootUrl + "/api/profiler/1.0/reporting/reports.json";
                string location;

                int start = (int)((DateTime.Now - new DateTime(1970, 1, 1).ToLocalTime()).TotalSeconds) - 8*60; //8 minutes before in unix time
                int end = start + 5*60; //3 minutes before in unix time

                var jsondata = new
                {
                    template_id = 184,
                    criteria = new
                    {
                        time_frame = new
                        {
                            start = start,
                            end = end
                        },

                        traffic_expression = "app WEB",
                        query = new
                        {
                            realm = "traffic_summary",
                            group_by = "hos",
                            sort_column = 33,
                            columns = new List&lt;int&gt; { 6, 33, 34 }
                        }
                    }
                };

                //Serialize anomymous type to json
                JavaScriptSerializer serializer = new JavaScriptSerializer();
                string postData = serializer.Serialize(jsondata);

                Console.WriteLine("Run report:");
                Console.WriteLine("POST " + requestUrl);
                Console.WriteLine(postData + Environment.NewLine);

                // Post to run the report
                var runReportResponse = MakeRequest&lt;ReportUpdate&gt;(requestUrl, WebRequestMethods.Http.Post, out location, postData);
                Console.WriteLine("Generated " + location + Environment.NewLine);
                requestUrl = rootUrl + location;
                Console.WriteLine("Please wait");
                while (runReportResponse.status != "completed")
                {
                    runReportResponse = MakeRequest&lt;ReportUpdate&gt;(requestUrl + ".json", WebRequestMethods.Http.Get, out location);
                    Console.WriteLine(string.Format("Percent completed {0}, seconds remaining {1}",runReportResponse.percent, runReportResponse.remaining_seconds));
                    Thread.Sleep(1000);
                }
                Console.WriteLine("Completed"+ Environment.NewLine);

                // Get all quesries (In this example it is only one)
                var getQueriesResponse = MakeRequest&lt;List&lt;QueryResult&gt;&gt;(requestUrl +"/queries.json", WebRequestMethods.Http.Get, out location);
                string columns = jsondata.criteria.query.columns.Select(c=&gt;c.ToString()).Aggregate((i, j) =&gt; i + "," + j);
                // Print the data from all queries
                foreach (var query in getQueriesResponse) {
                    var qr = MakeRequest&lt;QueryData&gt;(requestUrl + "/queries/" + query.id + ".json?offset=0&amp;limit=20&amp;columns=" + columns,
                                                   WebRequestMethods.Http.Get, out location);
                    string columnList = jsondata.criteria.query.columns.Select(c=&gt;query.columns.Where(col =&gt; col.id == c).First().name)
                                                              .Aggregate((l,r) =&gt; l + "," + r);
                    Console.WriteLine(columnList);

                    foreach (var dr in qr.data)
                    {
                        Console.WriteLine(dr.Aggregate((i, j) =&gt; i + ',' + j));
                    }
                }
            }
            catch (Exception e)
            {
                Console.WriteLine(e.Message);
            }
        }


        private static string Base64Encode(string toEncode)
        {
            byte[] toEncodeAsBytes
            = System.Text.ASCIIEncoding.ASCII.GetBytes(toEncode);
            return System.Convert.ToBase64String(toEncodeAsBytes);
        }

        /// &lt;summary&gt;
        /// Make request
        /// &lt;/summary&gt;
        /// &lt;typeparam name="T"&gt;return type&lt;/typeparam&gt;
        /// &lt;param name="requestUrl"&gt;url for request&lt;/param&gt;
        /// &lt;param name="action"&gt;Http Verb, Get, Post etc&lt;/param&gt;
        /// &lt;param name="location"&gt;location returned from response header &lt;/param&gt;
        /// &lt;param name="requestData"&gt;Data posted&lt;/param&gt;
        /// &lt;returns&gt;&lt;/returns&gt;
        private static T MakeRequest&lt;T&gt;(string requestUrl, string action, out string location, string requestData = null) where T : class
        {
            HttpWebRequest request = WebRequest.Create(requestUrl) as HttpWebRequest;
            request.Headers.Add("Authorization: Basic " + Base64Encode(BASIC_AUTH));
            request.ContentType = "application/json";
            request.Method = action;
            if (requestData == null)
            {
                request.ContentLength = 0;
            }
            else
            {
                ASCIIEncoding encoding = new ASCIIEncoding();
                byte[] byte1 = encoding.GetBytes(requestData);
                request.ContentLength = byte1.Length;
                using (Stream newStream = request.GetRequestStream())
                {
                    newStream.Write(byte1, 0, byte1.Length);
                }
            }

            using (HttpWebResponse response = request.GetResponse() as HttpWebResponse)
            {
                if (response.StatusCode != HttpStatusCode.OK &amp;&amp; response.StatusCode != HttpStatusCode.Created)
                    throw new Exception(String.Format(
                    "Unable to run report! StatusCode={0}, Description={1}",
                    response.StatusCode,
                    response.StatusDescription));
                location = response.Headers[HttpResponseHeader.Location];
                DataContractJsonSerializer jsonSerializer = new DataContractJsonSerializer(typeof(T));
                object objResponse = jsonSerializer.ReadObject(response.GetResponseStream());
                return objResponse as T;
            }
        }
    }
}

CascadeRestClient.csproj:

&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;Project ToolsVersion="4.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003"&gt;
  &lt;PropertyGroup&gt;
    &lt;Configuration Condition=" '$(Configuration)' == '' "&gt;Debug&lt;/Configuration&gt;
    &lt;Platform Condition=" '$(Platform)' == '' "&gt;x86&lt;/Platform&gt;
    &lt;ProductVersion&gt;8.0.30703&lt;/ProductVersion&gt;
    &lt;SchemaVersion&gt;2.0&lt;/SchemaVersion&gt;
    &lt;ProjectGuid&gt;{4ED69347-523B-46AB-B259-47EF60D4F13A}&lt;/ProjectGuid&gt;
    &lt;OutputType&gt;Exe&lt;/OutputType&gt;
    &lt;AppDesignerFolder&gt;Properties&lt;/AppDesignerFolder&gt;
    &lt;RootNamespace&gt;CascadeRestClient&lt;/RootNamespace&gt;
    &lt;AssemblyName&gt;CascadeRestClient&lt;/AssemblyName&gt;
    &lt;TargetFrameworkVersion&gt;v4.0&lt;/TargetFrameworkVersion&gt;
    &lt;TargetFrameworkProfile&gt;
    &lt;/TargetFrameworkProfile&gt;
    &lt;FileAlignment&gt;512&lt;/FileAlignment&gt;
  &lt;/PropertyGroup&gt;
  &lt;PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|x86' "&gt;
    &lt;PlatformTarget&gt;x86&lt;/PlatformTarget&gt;
    &lt;DebugSymbols&gt;true&lt;/DebugSymbols&gt;
    &lt;DebugType&gt;full&lt;/DebugType&gt;
    &lt;Optimize&gt;false&lt;/Optimize&gt;
    &lt;OutputPath&gt;bin\Debug\&lt;/OutputPath&gt;
    &lt;DefineConstants&gt;DEBUG;TRACE&lt;/DefineConstants&gt;
    &lt;ErrorReport&gt;prompt&lt;/ErrorReport&gt;
    &lt;WarningLevel&gt;4&lt;/WarningLevel&gt;
  &lt;/PropertyGroup&gt;
  &lt;PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|x86' "&gt;
    &lt;PlatformTarget&gt;x86&lt;/PlatformTarget&gt;
    &lt;DebugType&gt;pdbonly&lt;/DebugType&gt;
    &lt;Optimize&gt;true&lt;/Optimize&gt;
    &lt;OutputPath&gt;bin\Release\&lt;/OutputPath&gt;
    &lt;DefineConstants&gt;TRACE&lt;/DefineConstants&gt;
    &lt;ErrorReport&gt;prompt&lt;/ErrorReport&gt;
    &lt;WarningLevel&gt;4&lt;/WarningLevel&gt;
  &lt;/PropertyGroup&gt;
  &lt;ItemGroup&gt;
    &lt;Reference Include="System" /&gt;
    &lt;Reference Include="System.Core" /&gt;
    &lt;Reference Include="System.Runtime.Serialization" /&gt;
    &lt;Reference Include="System.Web.Extensions"&gt;
      &lt;HintPath&gt;..\..\..\..\..\..\..\Program Files (x86)\Reference Assemblies\Microsoft\Framework\.NETFramework\v4.0\System.Web.Extensions.dll&lt;/HintPath&gt;
    &lt;/Reference&gt;
    &lt;Reference Include="System.Xml.Linq" /&gt;
    &lt;Reference Include="System.Data.DataSetExtensions" /&gt;
    &lt;Reference Include="Microsoft.CSharp" /&gt;
    &lt;Reference Include="System.Data" /&gt;
    &lt;Reference Include="System.Xml" /&gt;
  &lt;/ItemGroup&gt;
  &lt;ItemGroup&gt;
    &lt;Compile Include="Program.cs" /&gt;
    &lt;Compile Include="Properties\AssemblyInfo.cs" /&gt;
  &lt;/ItemGroup&gt;
  &lt;Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" /&gt;
  &lt;!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
       Other similar extension points exist, see Microsoft.Common.targets.
  &lt;Target Name="BeforeBuild"&gt;
  &lt;/Target&gt;
  &lt;Target Name="AfterBuild"&gt;
  &lt;/Target&gt;
  --&gt;
&lt;/Project&gt;

Resources

Protocols: Get protocol

Get information on one protocol.

GET https://{device}/api/profiler/1.3/protocols/{proto}
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "id": number,
    "name": string
  }
]

Example:
[
  {
    "id": 6, 
    "name": "tcp"
  }, 
  {
    "id": 17, 
    "name": "udp"
  }
]
Property Name Type Description Notes
CProtocols <array of <object>> List of Protocols objects.
CProtocols[CProtocol] <object> Object representing Protocol information. Optional
CProtocols[CProtocol].id <number> ID of the Protocol. Optional
CProtocols[CProtocol].name <string> Name of the Protocol. Optional

Protocols: List protocols

Get a list of all supported protocols.

GET https://{device}/api/profiler/1.3/protocols
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "id": number,
    "name": string
  }
]

Example:
[
  {
    "id": 6, 
    "name": "tcp"
  }, 
  {
    "id": 17, 
    "name": "udp"
  }
]
Property Name Type Description Notes
CProtocols <array of <object>> List of Protocols objects.
CProtocols[CProtocol] <object> Object representing Protocol information. Optional
CProtocols[CProtocol].id <number> ID of the Protocol. Optional
CProtocols[CProtocol].name <string> Name of the Protocol. Optional

Services: Delete existing business service

Delete existing business service.

DELETE https://{device}/api/profiler/1.3/services/{service_id}
Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

Services: Create and commit a new business service

Create and commit a new business service.

POST https://{device}/api/profiler/1.3/services
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "alert_notification": {
    "high_enabled": string,
    "low_alert_recipient": string,
    "low_enabled": string,
    "high_alert_recipient": string
  },
  "components": [
    {
      "id": number,
      "definition": {
        "snat_type": string,
        "vips": [
          {
            "port": number,
            "protocol": number,
            "ipaddr": string
          }
        ],
        "load_balancer": number,
        "outside_hosts": [
          string
        ],
        "manual": string,
        "within_hosts": [
          string
        ],
        "snats": [
          string
        ]
      },
      "name": string,
      "type": string
    }
  ],
  "segments": [
    {
      "alert_notification": string,
      "id": number,
      "definition": [
        string
      ],
      "client_component_id": number,
      "status": string,
      "locations": [
        {
          "host_group_type_id": number,
          "host_group_id": number,
          "location_id": number
        }
      ],
      "server_component_name": string,
      "name": string,
      "type": string,
      "monitored_metrics": [
        {
          "id": number
        }
      ],
      "location_type": string,
      "server_component_id": number,
      "client_component_name": string
    }
  ],
  "id": number,
  "description": string,
  "name": string,
  "locked_by_user_id": number,
  "policies": [
    {
      "id": number,
      "tuning_parameters": {
        "id": number,
        "tolerance_high": number,
        "name": string,
        "tolerance_low": number,
        "noise_floor": string,
        "duration": number,
        "trigger_on_decreases": string,
        "trigger_on_increases": string
      },
      "name": string
    }
  ]
}

Example:
{
  "components": [
    {
      "definition": {
        "within_hosts": [
          "10.100.120.110", 
          "10.100.120.111", 
          "10.100.120.112"
        ]
      }, 
      "type": "LBRS", 
      "name": "WebFarm", 
      "id": 135
    }, 
    {
      "definition": {
        "within_hosts": [
          "0.0.0.0/0"
        ]
      }, 
      "type": "END_USERS", 
      "name": "EndUsers", 
      "id": 136
    }, 
    {
      "definition": {
        "within_hosts": [
          "10.100.203.130", 
          "10.100.203.131"
        ]
      }, 
      "type": "LBRS", 
      "name": "DBFarm", 
      "id": 137
    }, 
    {
      "definition": {
        "within_hosts": [
          "10.100.100.10"
        ]
      }, 
      "type": "SERVERS", 
      "name": "LDAP-Servers", 
      "id": 138
    }, 
    {
      "definition": {
        "load_balancer": 1, 
        "vips": [
          {
            "ipaddr": "10.100.120.100", 
            "protocol": 6, 
            "port": 80
          }, 
          {
            "ipaddr": "10.100.120.100", 
            "protocol": 6, 
            "port": 443
          }
        ], 
        "snat_type": "ALWAYS", 
        "manual": false, 
        "snats": [
          "10.100.120.108"
        ]
      }, 
      "type": "LBVS", 
      "name": "WebVIP", 
      "id": 139
    }, 
    {
      "definition": {
        "load_balancer": 1, 
        "vips": [
          {
            "ipaddr": "10.100.202.120", 
            "protocol": 0, 
            "port": 0
          }
        ], 
        "snat_type": "ALWAYS", 
        "manual": false, 
        "snats": [
          "10.100.202.128"
        ]
      }, 
      "type": "LBVS", 
      "name": "DB-VIP", 
      "id": 140
    }
  ], 
  "description": "Finance application", 
  "id": 192, 
  "alert_notification": {
    "low_alert_recipient": "* Log Only", 
    "high_alert_recipient": "* Log Only", 
    "high_enabled": false, 
    "low_enabled": false
  }, 
  "policies": [
    {
      "id": 352321689, 
      "name": "FinancePortal_Web-LB_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321690, 
      "name": "FinancePortal_Web-LB_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321691, 
      "name": "FinancePortal_Web-LB_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321692, 
      "name": "FinancePortal_Web-LB_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321721, 
      "name": "FinancePortal_DB-LB_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321722, 
      "name": "FinancePortal_DB-LB_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321723, 
      "name": "FinancePortal_DB-LB_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321724, 
      "name": "FinancePortal_DB-LB_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321725, 
      "name": "FinancePortal_Web_Seattle_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321726, 
      "name": "FinancePortal_Web_LosAngeles_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321727, 
      "name": "FinancePortal_Web_Phoenix_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321728, 
      "name": "FinancePortal_Web_Columbus_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321729, 
      "name": "FinancePortal_Web_Austin_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321730, 
      "name": "FinancePortal_Web_Philadelphia_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321731, 
      "name": "FinancePortal_Web_Hartford_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321732, 
      "name": "FinancePortal_Web_Seattle_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321733, 
      "name": "FinancePortal_Web_LosAngeles_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321734, 
      "name": "FinancePortal_Web_Phoenix_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321735, 
      "name": "FinancePortal_Web_Columbus_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321736, 
      "name": "FinancePortal_Web_Austin_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321737, 
      "name": "FinancePortal_Web_Philadelphia_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321738, 
      "name": "FinancePortal_Web_Hartford_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321739, 
      "name": "FinancePortal_Web_Seattle_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321740, 
      "name": "FinancePortal_Web_LosAngeles_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321741, 
      "name": "FinancePortal_Web_Phoenix_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321742, 
      "name": "FinancePortal_Web_Columbus_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321743, 
      "name": "FinancePortal_Web_Austin_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321744, 
      "name": "FinancePortal_Web_Philadelphia_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321745, 
      "name": "FinancePortal_Web_Hartford_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321746, 
      "name": "FinancePortal_Web_Seattle_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321747, 
      "name": "FinancePortal_Web_LosAngeles_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321748, 
      "name": "FinancePortal_Web_Phoenix_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321749, 
      "name": "FinancePortal_Web_Columbus_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321750, 
      "name": "FinancePortal_Web_Austin_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321751, 
      "name": "FinancePortal_Web_Philadelphia_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321752, 
      "name": "FinancePortal_Web_Hartford_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321753, 
      "name": "FinancePortal_DB_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321754, 
      "name": "FinancePortal_DB_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321755, 
      "name": "FinancePortal_DB_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321756, 
      "name": "FinancePortal_DB_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321757, 
      "name": "FinancePortal_LDAP_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321758, 
      "name": "FinancePortal_LDAP_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321759, 
      "name": "FinancePortal_LDAP_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321760, 
      "name": "FinancePortal_LDAP_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }
  ], 
  "segments": [
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "WebVIP", 
      "name": "Web-LB", 
      "server_component_name": "WebFarm", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 186, 
      "server_component_id": 135, 
      "alert_notification": false, 
      "client_component_id": 139
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "DB-VIP", 
      "name": "DB-LB", 
      "server_component_name": "DBFarm", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 141, 
      "server_component_id": 137, 
      "alert_notification": false, 
      "client_component_id": 140
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "EndUsers", 
      "name": "Web", 
      "server_component_name": "WebVIP", 
      "type": "FRONT_END", 
      "locations": [
        {
          "host_group_type_id": 102, 
          "location_id": 174, 
          "host_group_id": 0
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 175, 
          "host_group_id": 1
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 176, 
          "host_group_id": 2
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 177, 
          "host_group_id": 3
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 178, 
          "host_group_id": 5
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 179, 
          "host_group_id": 6
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 180, 
          "host_group_id": 7
        }
      ], 
      "monitored_metrics": [], 
      "id": 173, 
      "server_component_id": 139, 
      "alert_notification": false, 
      "client_component_id": 136, 
      "location_type": "SUBSET"
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "WebFarm", 
      "name": "DB", 
      "server_component_name": "DB-VIP", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 147, 
      "server_component_id": 140, 
      "alert_notification": false, 
      "client_component_id": 135
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "WebFarm", 
      "name": "LDAP", 
      "server_component_name": "LDAP-Servers", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 153, 
      "server_component_id": 138, 
      "alert_notification": false, 
      "client_component_id": 135
    }
  ], 
  "name": "Service_A"
}
Property Name Type Description Notes
ServiceConfig <object> Object representing a business service.
ServiceConfig.alert_notification <object> Alert notification flag.
ServiceConfig.alert_notification.
high_enabled
<string> High alert enabled flag.
ServiceConfig.alert_notification.
low_alert_recipient
<string> Low alert recipient.
ServiceConfig.alert_notification.
low_enabled
<string> Low alert enabled flag.
ServiceConfig.alert_notification.
high_alert_recipient
<string> High alert recipient.
ServiceConfig.components <array of <object>> Service components.
ServiceConfig.components
[ServiceComponent]
<object> Components defined for this business service. Optional
ServiceConfig.components
[ServiceComponent].id
<number> Service component id. Optional
ServiceConfig.components
[ServiceComponent].definition
<object> Service component definition.
ServiceConfig.components
[ServiceComponent].definition.
snat_type
<string> Snat type. Optional; Values: NOT_USED, SOMETIMES, ALWAYS
ServiceConfig.components
[ServiceComponent].definition.vips
<array of <object>> Vips if any. Optional
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer]
<object> Load balancer virtual server. Optional
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer].port
<number> Port.
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer].protocol
<number> Protocol.
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer].ipaddr
<string> IP address.
ServiceConfig.components
[ServiceComponent].definition.
load_balancer
<number> Load balancer if any. Optional
ServiceConfig.components
[ServiceComponent].definition.
outside_hosts
<array of <string>> Hosts/subnets excluded from component definition if any. Optional
ServiceConfig.components
[ServiceComponent].definition.
outside_hosts[item]
<string> Host/subnet string. Optional
ServiceConfig.components
[ServiceComponent].definition.manual
<string> Manual flag. Optional
ServiceConfig.components
[ServiceComponent].definition.
within_hosts
<array of <string>> Hosts/subnets included into component definition. Optional
ServiceConfig.components
[ServiceComponent].definition.
within_hosts[item]
<string> Host/subnet string. Optional
ServiceConfig.components
[ServiceComponent].definition.snats
<array of <string>> Snats if any. Optional
ServiceConfig.components
[ServiceComponent].definition.snats
[item]
<string> Host/subnet string. Optional
ServiceConfig.components
[ServiceComponent].name
<string> Service component name.
ServiceConfig.components
[ServiceComponent].type
<string> Service component type. Values: END_USERS, SERVERS, LBVS, LBRS
ServiceConfig.segments <array of <object>> Service segments.
ServiceConfig.segments[ServiceSegment] <object> Segments defined for this business service. Optional
ServiceConfig.segments[ServiceSegment].
alert_notification
<string> Alert notification flag.
ServiceConfig.segments[ServiceSegment].
id
<number> Service segment id. Optional
ServiceConfig.segments[ServiceSegment].
definition
<array of <string>> Segment definition.
ServiceConfig.segments[ServiceSegment].
definition[item]
<string> Service segment definition. Optional
ServiceConfig.segments[ServiceSegment].
client_component_id
<number> Client component id. Optional
ServiceConfig.segments[ServiceSegment].
status
<string> Service segment status. Optional; Values: ADDED, DROPPED, UNDECIDED
ServiceConfig.segments[ServiceSegment].
locations
<array of <object>> Segment locations. Optional
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation]
<object> Segment locations. Optional
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation].
host_group_type_id
<number> Host group type id.
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation].
host_group_id
<number> Host group id.
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation].location_id
<number> Location id. Optional
ServiceConfig.segments[ServiceSegment].
server_component_name
<string> Server component name.
ServiceConfig.segments[ServiceSegment].
name
<string> Service segment name.
ServiceConfig.segments[ServiceSegment].
type
<string> Service segment type. Optional; Values: FRONT_END, BACK_END
ServiceConfig.segments[ServiceSegment].
monitored_metrics
<array of <object>> Monitored segment metrics.
ServiceConfig.segments[ServiceSegment].
monitored_metrics[SegmentMetric]
<object> Segment metrics. Optional
ServiceConfig.segments[ServiceSegment].
monitored_metrics[SegmentMetric].id
<number> Metric id.
ServiceConfig.segments[ServiceSegment].
location_type
<string> Location type. Optional; Values: ALL, SUBSET
ServiceConfig.segments[ServiceSegment].
server_component_id
<number> Server component id. Optional
ServiceConfig.segments[ServiceSegment].
client_component_name
<string> Client component name.
ServiceConfig.id <number> Service id. Optional
ServiceConfig.description <string> Service description.
ServiceConfig.name <string> Service name.
ServiceConfig.locked_by_user_id <number> Account id of the user currently editing this Service if any. Optional
ServiceConfig.policies <array of <object>> Service policies.
ServiceConfig.policies[ServicePolicy] <object> Policies defined for this business service. Optional
ServiceConfig.policies[ServicePolicy].id <number> Service policy id. Optional
ServiceConfig.policies[ServicePolicy].
tuning_parameters
<object> Tuning parameters.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.id
<number> Service policy parameter id.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.tolerance_high
<number> Service policy high tolerance threshold.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.name
<string> Service policy parameter name.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.tolerance_low
<number> Service policy low tolerance threshold.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.noise_floor
<string> Service policy noise floor.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.duration
<number> Service policy duration.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.trigger_on_decreases
<string> Service policy trigger on decreases.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.trigger_on_increases
<string> Service policy trigger on increases.
ServiceConfig.policies[ServicePolicy].
name
<string> Service policy name.
Response Body

On success, the server does not provide any body in the responses.

Services: Get components

Manage components of one business service.

GET https://{device}/api/profiler/1.3/services/{service_id}/components?offset={number}&sortby={string}&sort={string}&limit={number}
Authorization

This request requires authorization.

Parameters
Property Name Type Description Notes
offset <number> Starting element number. Optional
sortby <string> Sorting field name. Optional
sort <string> Sorting direction: 'asc' or 'desc' (default: 'asc'). Optional
limit <number> Number of rows to be returned. Optional
Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "id": number,
    "definition": {
      "snat_type": string,
      "vips": [
        {
          "port": number,
          "protocol": number,
          "ipaddr": string
        }
      ],
      "load_balancer": number,
      "outside_hosts": [
        string
      ],
      "manual": string,
      "within_hosts": [
        string
      ],
      "snats": [
        string
      ]
    },
    "name": string,
    "type": string
  }
]

Example:
[
  {
    "definition": {
      "within_hosts": [
        "1.1.1.0/24"
      ]
    }, 
    "type": "END_USERS", 
    "name": "Comp-1", 
    "id": 1000
  }, 
  {
    "definition": {
      "load_balancer": 1000, 
      "vips": [
        {
          "ipaddr": "10.0.0.0/8", 
          "protocol": 0, 
          "port": 0
        }
      ], 
      "snat_type": "SOMETIMES", 
      "manual": false, 
      "snats": [
        "10.8.0.1", 
        "10.8.0.96", 
        "10.8.0.200", 
        "10.8.0.205", 
        "10.9.0.1", 
        "10.9.0.96", 
        "10.10.8.96"
      ]
    }, 
    "type": "LBVS", 
    "name": "Comp-2", 
    "id": 1001
  }, 
  {
    "definition": {
      "within_hosts": [
        "1.1.3.0/24"
      ]
    }, 
    "type": "LBRS", 
    "name": "Comp-3", 
    "id": 1002
  }
]
Property Name Type Description Notes
ServiceComponentsList <array of <object>> List of components defined for this business service.
ServiceComponentsList[ServiceComponent] <object> Components defined for this business service. Optional
ServiceComponentsList[ServiceComponent].
id
<number> Service component id. Optional
ServiceComponentsList[ServiceComponent].
definition
<object> Service component definition.
ServiceComponentsList[ServiceComponent].
definition.snat_type
<string> Snat type. Optional; Values: NOT_USED, SOMETIMES, ALWAYS
ServiceComponentsList[ServiceComponent].
definition.vips
<array of <object>> Vips if any. Optional
ServiceComponentsList[ServiceComponent].
definition.vips[LBVirtualServer]
<object> Load balancer virtual server. Optional
ServiceComponentsList[ServiceComponent].
definition.vips[LBVirtualServer].port
<number> Port.
ServiceComponentsList[ServiceComponent].
definition.vips[LBVirtualServer].
protocol
<number> Protocol.
ServiceComponentsList[ServiceComponent].
definition.vips[LBVirtualServer].
ipaddr
<string> IP address.
ServiceComponentsList[ServiceComponent].
definition.load_balancer
<number> Load balancer if any. Optional
ServiceComponentsList[ServiceComponent].
definition.outside_hosts
<array of <string>> Hosts/subnets excluded from component definition if any. Optional
ServiceComponentsList[ServiceComponent].
definition.outside_hosts[item]
<string> Host/subnet string. Optional
ServiceComponentsList[ServiceComponent].
definition.manual
<string> Manual flag. Optional
ServiceComponentsList[ServiceComponent].
definition.within_hosts
<array of <string>> Hosts/subnets included into component definition. Optional
ServiceComponentsList[ServiceComponent].
definition.within_hosts[item]
<string> Host/subnet string. Optional
ServiceComponentsList[ServiceComponent].
definition.snats
<array of <string>> Snats if any. Optional
ServiceComponentsList[ServiceComponent].
definition.snats[item]
<string> Host/subnet string. Optional
ServiceComponentsList[ServiceComponent].
name
<string> Service component name.
ServiceComponentsList[ServiceComponent].
type
<string> Service component type. Values: END_USERS, SERVERS, LBVS, LBRS

Services: List business services

List business services.

GET https://{device}/api/profiler/1.3/services?offset={number}&sortby={string}&sort={string}&limit={number}
Authorization

This request requires authorization.

Parameters
Property Name Type Description Notes
offset <number> Starting element number. Optional
sortby <string> Sorting field name. Optional
sort <string> Sorting direction: 'asc' or 'desc' (default: 'asc'). Optional
limit <number> Number of rows to be returned. Optional
Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "id": number,
    "status": string,
    "description": string,
    "name": string,
    "error": string
  }
]

Example:
[
  {
    "status": "MONITORED", 
    "id": 64, 
    "description": "Microsoft Exchange", 
    "name": "Exchange"
  }, 
  {
    "status": "COMMITTING", 
    "id": 128, 
    "description": "", 
    "name": "Sharepoint"
  }, 
  {
    "status": "DISABLED", 
    "id": 32, 
    "description": "Application", 
    "name": "ERP"
  }
]
Property Name Type Description Notes
ServiceList <array of <object>> List of business services defined on Profiler.
ServiceList[ServiceInfo] <object> Business service defined on Profiler. Optional
ServiceList[ServiceInfo].id <number> Service id.
ServiceList[ServiceInfo].status <string> Service state. Values: MONITORED, COMMITTING, ERROR, DISABLED
ServiceList[ServiceInfo].description <string> Service description.
ServiceList[ServiceInfo].name <string> Service name.
ServiceList[ServiceInfo].error <string> Commit error if any. Optional

Services: Update existing business service

Update existing business service.

PUT https://{device}/api/profiler/1.3/services/{service_id}
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "alert_notification": {
    "high_enabled": string,
    "low_alert_recipient": string,
    "low_enabled": string,
    "high_alert_recipient": string
  },
  "components": [
    {
      "id": number,
      "definition": {
        "snat_type": string,
        "vips": [
          {
            "port": number,
            "protocol": number,
            "ipaddr": string
          }
        ],
        "load_balancer": number,
        "outside_hosts": [
          string
        ],
        "manual": string,
        "within_hosts": [
          string
        ],
        "snats": [
          string
        ]
      },
      "name": string,
      "type": string
    }
  ],
  "segments": [
    {
      "alert_notification": string,
      "id": number,
      "definition": [
        string
      ],
      "client_component_id": number,
      "status": string,
      "locations": [
        {
          "host_group_type_id": number,
          "host_group_id": number,
          "location_id": number
        }
      ],
      "server_component_name": string,
      "name": string,
      "type": string,
      "monitored_metrics": [
        {
          "id": number
        }
      ],
      "location_type": string,
      "server_component_id": number,
      "client_component_name": string
    }
  ],
  "id": number,
  "description": string,
  "name": string,
  "locked_by_user_id": number,
  "policies": [
    {
      "id": number,
      "tuning_parameters": {
        "id": number,
        "tolerance_high": number,
        "name": string,
        "tolerance_low": number,
        "noise_floor": string,
        "duration": number,
        "trigger_on_decreases": string,
        "trigger_on_increases": string
      },
      "name": string
    }
  ]
}

Example:
{
  "components": [
    {
      "definition": {
        "within_hosts": [
          "10.100.120.110", 
          "10.100.120.111", 
          "10.100.120.112"
        ]
      }, 
      "type": "LBRS", 
      "name": "WebFarm", 
      "id": 135
    }, 
    {
      "definition": {
        "within_hosts": [
          "0.0.0.0/0"
        ]
      }, 
      "type": "END_USERS", 
      "name": "EndUsers", 
      "id": 136
    }, 
    {
      "definition": {
        "within_hosts": [
          "10.100.203.130", 
          "10.100.203.131"
        ]
      }, 
      "type": "LBRS", 
      "name": "DBFarm", 
      "id": 137
    }, 
    {
      "definition": {
        "within_hosts": [
          "10.100.100.10"
        ]
      }, 
      "type": "SERVERS", 
      "name": "LDAP-Servers", 
      "id": 138
    }, 
    {
      "definition": {
        "load_balancer": 1, 
        "vips": [
          {
            "ipaddr": "10.100.120.100", 
            "protocol": 6, 
            "port": 80
          }, 
          {
            "ipaddr": "10.100.120.100", 
            "protocol": 6, 
            "port": 443
          }
        ], 
        "snat_type": "ALWAYS", 
        "manual": false, 
        "snats": [
          "10.100.120.108"
        ]
      }, 
      "type": "LBVS", 
      "name": "WebVIP", 
      "id": 139
    }, 
    {
      "definition": {
        "load_balancer": 1, 
        "vips": [
          {
            "ipaddr": "10.100.202.120", 
            "protocol": 0, 
            "port": 0
          }
        ], 
        "snat_type": "ALWAYS", 
        "manual": false, 
        "snats": [
          "10.100.202.128"
        ]
      }, 
      "type": "LBVS", 
      "name": "DB-VIP", 
      "id": 140
    }
  ], 
  "description": "Finance application", 
  "id": 192, 
  "alert_notification": {
    "low_alert_recipient": "* Log Only", 
    "high_alert_recipient": "* Log Only", 
    "high_enabled": false, 
    "low_enabled": false
  }, 
  "policies": [
    {
      "id": 352321689, 
      "name": "FinancePortal_Web-LB_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321690, 
      "name": "FinancePortal_Web-LB_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321691, 
      "name": "FinancePortal_Web-LB_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321692, 
      "name": "FinancePortal_Web-LB_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321721, 
      "name": "FinancePortal_DB-LB_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321722, 
      "name": "FinancePortal_DB-LB_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321723, 
      "name": "FinancePortal_DB-LB_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321724, 
      "name": "FinancePortal_DB-LB_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321725, 
      "name": "FinancePortal_Web_Seattle_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321726, 
      "name": "FinancePortal_Web_LosAngeles_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321727, 
      "name": "FinancePortal_Web_Phoenix_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321728, 
      "name": "FinancePortal_Web_Columbus_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321729, 
      "name": "FinancePortal_Web_Austin_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321730, 
      "name": "FinancePortal_Web_Philadelphia_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321731, 
      "name": "FinancePortal_Web_Hartford_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321732, 
      "name": "FinancePortal_Web_Seattle_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321733, 
      "name": "FinancePortal_Web_LosAngeles_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321734, 
      "name": "FinancePortal_Web_Phoenix_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321735, 
      "name": "FinancePortal_Web_Columbus_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321736, 
      "name": "FinancePortal_Web_Austin_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321737, 
      "name": "FinancePortal_Web_Philadelphia_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321738, 
      "name": "FinancePortal_Web_Hartford_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321739, 
      "name": "FinancePortal_Web_Seattle_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321740, 
      "name": "FinancePortal_Web_LosAngeles_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321741, 
      "name": "FinancePortal_Web_Phoenix_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321742, 
      "name": "FinancePortal_Web_Columbus_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321743, 
      "name": "FinancePortal_Web_Austin_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321744, 
      "name": "FinancePortal_Web_Philadelphia_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321745, 
      "name": "FinancePortal_Web_Hartford_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321746, 
      "name": "FinancePortal_Web_Seattle_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321747, 
      "name": "FinancePortal_Web_LosAngeles_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321748, 
      "name": "FinancePortal_Web_Phoenix_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321749, 
      "name": "FinancePortal_Web_Columbus_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321750, 
      "name": "FinancePortal_Web_Austin_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321751, 
      "name": "FinancePortal_Web_Philadelphia_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321752, 
      "name": "FinancePortal_Web_Hartford_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321753, 
      "name": "FinancePortal_DB_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321754, 
      "name": "FinancePortal_DB_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321755, 
      "name": "FinancePortal_DB_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321756, 
      "name": "FinancePortal_DB_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321757, 
      "name": "FinancePortal_LDAP_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321758, 
      "name": "FinancePortal_LDAP_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321759, 
      "name": "FinancePortal_LDAP_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321760, 
      "name": "FinancePortal_LDAP_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }
  ], 
  "segments": [
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "WebVIP", 
      "name": "Web-LB", 
      "server_component_name": "WebFarm", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 186, 
      "server_component_id": 135, 
      "alert_notification": false, 
      "client_component_id": 139
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "DB-VIP", 
      "name": "DB-LB", 
      "server_component_name": "DBFarm", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 141, 
      "server_component_id": 137, 
      "alert_notification": false, 
      "client_component_id": 140
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "EndUsers", 
      "name": "Web", 
      "server_component_name": "WebVIP", 
      "type": "FRONT_END", 
      "locations": [
        {
          "host_group_type_id": 102, 
          "location_id": 174, 
          "host_group_id": 0
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 175, 
          "host_group_id": 1
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 176, 
          "host_group_id": 2
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 177, 
          "host_group_id": 3
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 178, 
          "host_group_id": 5
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 179, 
          "host_group_id": 6
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 180, 
          "host_group_id": 7
        }
      ], 
      "monitored_metrics": [], 
      "id": 173, 
      "server_component_id": 139, 
      "alert_notification": false, 
      "client_component_id": 136, 
      "location_type": "SUBSET"
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "WebFarm", 
      "name": "DB", 
      "server_component_name": "DB-VIP", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 147, 
      "server_component_id": 140, 
      "alert_notification": false, 
      "client_component_id": 135
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "WebFarm", 
      "name": "LDAP", 
      "server_component_name": "LDAP-Servers", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 153, 
      "server_component_id": 138, 
      "alert_notification": false, 
      "client_component_id": 135
    }
  ], 
  "name": "Service_A"
}
Property Name Type Description Notes
ServiceConfig <object> Object representing a business service.
ServiceConfig.alert_notification <object> Alert notification flag.
ServiceConfig.alert_notification.
high_enabled
<string> High alert enabled flag.
ServiceConfig.alert_notification.
low_alert_recipient
<string> Low alert recipient.
ServiceConfig.alert_notification.
low_enabled
<string> Low alert enabled flag.
ServiceConfig.alert_notification.
high_alert_recipient
<string> High alert recipient.
ServiceConfig.components <array of <object>> Service components.
ServiceConfig.components
[ServiceComponent]
<object> Components defined for this business service. Optional
ServiceConfig.components
[ServiceComponent].id
<number> Service component id. Optional
ServiceConfig.components
[ServiceComponent].definition
<object> Service component definition.
ServiceConfig.components
[ServiceComponent].definition.
snat_type
<string> Snat type. Optional; Values: NOT_USED, SOMETIMES, ALWAYS
ServiceConfig.components
[ServiceComponent].definition.vips
<array of <object>> Vips if any. Optional
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer]
<object> Load balancer virtual server. Optional
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer].port
<number> Port.
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer].protocol
<number> Protocol.
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer].ipaddr
<string> IP address.
ServiceConfig.components
[ServiceComponent].definition.
load_balancer
<number> Load balancer if any. Optional
ServiceConfig.components
[ServiceComponent].definition.
outside_hosts
<array of <string>> Hosts/subnets excluded from component definition if any. Optional
ServiceConfig.components
[ServiceComponent].definition.
outside_hosts[item]
<string> Host/subnet string. Optional
ServiceConfig.components
[ServiceComponent].definition.manual
<string> Manual flag. Optional
ServiceConfig.components
[ServiceComponent].definition.
within_hosts
<array of <string>> Hosts/subnets included into component definition. Optional
ServiceConfig.components
[ServiceComponent].definition.
within_hosts[item]
<string> Host/subnet string. Optional
ServiceConfig.components
[ServiceComponent].definition.snats
<array of <string>> Snats if any. Optional
ServiceConfig.components
[ServiceComponent].definition.snats
[item]
<string> Host/subnet string. Optional
ServiceConfig.components
[ServiceComponent].name
<string> Service component name.
ServiceConfig.components
[ServiceComponent].type
<string> Service component type. Values: END_USERS, SERVERS, LBVS, LBRS
ServiceConfig.segments <array of <object>> Service segments.
ServiceConfig.segments[ServiceSegment] <object> Segments defined for this business service. Optional
ServiceConfig.segments[ServiceSegment].
alert_notification
<string> Alert notification flag.
ServiceConfig.segments[ServiceSegment].
id
<number> Service segment id. Optional
ServiceConfig.segments[ServiceSegment].
definition
<array of <string>> Segment definition.
ServiceConfig.segments[ServiceSegment].
definition[item]
<string> Service segment definition. Optional
ServiceConfig.segments[ServiceSegment].
client_component_id
<number> Client component id. Optional
ServiceConfig.segments[ServiceSegment].
status
<string> Service segment status. Optional; Values: ADDED, DROPPED, UNDECIDED
ServiceConfig.segments[ServiceSegment].
locations
<array of <object>> Segment locations. Optional
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation]
<object> Segment locations. Optional
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation].
host_group_type_id
<number> Host group type id.
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation].
host_group_id
<number> Host group id.
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation].location_id
<number> Location id. Optional
ServiceConfig.segments[ServiceSegment].
server_component_name
<string> Server component name.
ServiceConfig.segments[ServiceSegment].
name
<string> Service segment name.
ServiceConfig.segments[ServiceSegment].
type
<string> Service segment type. Optional; Values: FRONT_END, BACK_END
ServiceConfig.segments[ServiceSegment].
monitored_metrics
<array of <object>> Monitored segment metrics.
ServiceConfig.segments[ServiceSegment].
monitored_metrics[SegmentMetric]
<object> Segment metrics. Optional
ServiceConfig.segments[ServiceSegment].
monitored_metrics[SegmentMetric].id
<number> Metric id.
ServiceConfig.segments[ServiceSegment].
location_type
<string> Location type. Optional; Values: ALL, SUBSET
ServiceConfig.segments[ServiceSegment].
server_component_id
<number> Server component id. Optional
ServiceConfig.segments[ServiceSegment].
client_component_name
<string> Client component name.
ServiceConfig.id <number> Service id. Optional
ServiceConfig.description <string> Service description.
ServiceConfig.name <string> Service name.
ServiceConfig.locked_by_user_id <number> Account id of the user currently editing this Service if any. Optional
ServiceConfig.policies <array of <object>> Service policies.
ServiceConfig.policies[ServicePolicy] <object> Policies defined for this business service. Optional
ServiceConfig.policies[ServicePolicy].id <number> Service policy id. Optional
ServiceConfig.policies[ServicePolicy].
tuning_parameters
<object> Tuning parameters.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.id
<number> Service policy parameter id.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.tolerance_high
<number> Service policy high tolerance threshold.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.name
<string> Service policy parameter name.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.tolerance_low
<number> Service policy low tolerance threshold.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.noise_floor
<string> Service policy noise floor.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.duration
<number> Service policy duration.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.trigger_on_decreases
<string> Service policy trigger on decreases.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.trigger_on_increases
<string> Service policy trigger on increases.
ServiceConfig.policies[ServicePolicy].
name
<string> Service policy name.
Response Body

On success, the server does not provide any body in the responses.

Services: List business service

List business service.

GET https://{device}/api/profiler/1.3/services/{service_id}
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "alert_notification": {
    "high_enabled": string,
    "low_alert_recipient": string,
    "low_enabled": string,
    "high_alert_recipient": string
  },
  "components": [
    {
      "id": number,
      "definition": {
        "snat_type": string,
        "vips": [
          {
            "port": number,
            "protocol": number,
            "ipaddr": string
          }
        ],
        "load_balancer": number,
        "outside_hosts": [
          string
        ],
        "manual": string,
        "within_hosts": [
          string
        ],
        "snats": [
          string
        ]
      },
      "name": string,
      "type": string
    }
  ],
  "segments": [
    {
      "alert_notification": string,
      "id": number,
      "definition": [
        string
      ],
      "client_component_id": number,
      "status": string,
      "locations": [
        {
          "host_group_type_id": number,
          "host_group_id": number,
          "location_id": number
        }
      ],
      "server_component_name": string,
      "name": string,
      "type": string,
      "monitored_metrics": [
        {
          "id": number
        }
      ],
      "location_type": string,
      "server_component_id": number,
      "client_component_name": string
    }
  ],
  "id": number,
  "description": string,
  "name": string,
  "locked_by_user_id": number,
  "policies": [
    {
      "id": number,
      "tuning_parameters": {
        "id": number,
        "tolerance_high": number,
        "name": string,
        "tolerance_low": number,
        "noise_floor": string,
        "duration": number,
        "trigger_on_decreases": string,
        "trigger_on_increases": string
      },
      "name": string
    }
  ]
}

Example:
{
  "components": [
    {
      "definition": {
        "within_hosts": [
          "10.100.120.110", 
          "10.100.120.111", 
          "10.100.120.112"
        ]
      }, 
      "type": "LBRS", 
      "name": "WebFarm", 
      "id": 135
    }, 
    {
      "definition": {
        "within_hosts": [
          "0.0.0.0/0"
        ]
      }, 
      "type": "END_USERS", 
      "name": "EndUsers", 
      "id": 136
    }, 
    {
      "definition": {
        "within_hosts": [
          "10.100.203.130", 
          "10.100.203.131"
        ]
      }, 
      "type": "LBRS", 
      "name": "DBFarm", 
      "id": 137
    }, 
    {
      "definition": {
        "within_hosts": [
          "10.100.100.10"
        ]
      }, 
      "type": "SERVERS", 
      "name": "LDAP-Servers", 
      "id": 138
    }, 
    {
      "definition": {
        "load_balancer": 1, 
        "vips": [
          {
            "ipaddr": "10.100.120.100", 
            "protocol": 6, 
            "port": 80
          }, 
          {
            "ipaddr": "10.100.120.100", 
            "protocol": 6, 
            "port": 443
          }
        ], 
        "snat_type": "ALWAYS", 
        "manual": false, 
        "snats": [
          "10.100.120.108"
        ]
      }, 
      "type": "LBVS", 
      "name": "WebVIP", 
      "id": 139
    }, 
    {
      "definition": {
        "load_balancer": 1, 
        "vips": [
          {
            "ipaddr": "10.100.202.120", 
            "protocol": 0, 
            "port": 0
          }
        ], 
        "snat_type": "ALWAYS", 
        "manual": false, 
        "snats": [
          "10.100.202.128"
        ]
      }, 
      "type": "LBVS", 
      "name": "DB-VIP", 
      "id": 140
    }
  ], 
  "description": "Finance application", 
  "id": 192, 
  "alert_notification": {
    "low_alert_recipient": "* Log Only", 
    "high_alert_recipient": "* Log Only", 
    "high_enabled": false, 
    "low_enabled": false
  }, 
  "policies": [
    {
      "id": 352321689, 
      "name": "FinancePortal_Web-LB_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321690, 
      "name": "FinancePortal_Web-LB_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321691, 
      "name": "FinancePortal_Web-LB_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321692, 
      "name": "FinancePortal_Web-LB_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321721, 
      "name": "FinancePortal_DB-LB_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321722, 
      "name": "FinancePortal_DB-LB_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321723, 
      "name": "FinancePortal_DB-LB_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321724, 
      "name": "FinancePortal_DB-LB_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321725, 
      "name": "FinancePortal_Web_Seattle_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321726, 
      "name": "FinancePortal_Web_LosAngeles_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321727, 
      "name": "FinancePortal_Web_Phoenix_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321728, 
      "name": "FinancePortal_Web_Columbus_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321729, 
      "name": "FinancePortal_Web_Austin_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321730, 
      "name": "FinancePortal_Web_Philadelphia_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321731, 
      "name": "FinancePortal_Web_Hartford_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321732, 
      "name": "FinancePortal_Web_Seattle_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321733, 
      "name": "FinancePortal_Web_LosAngeles_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321734, 
      "name": "FinancePortal_Web_Phoenix_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321735, 
      "name": "FinancePortal_Web_Columbus_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321736, 
      "name": "FinancePortal_Web_Austin_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321737, 
      "name": "FinancePortal_Web_Philadelphia_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321738, 
      "name": "FinancePortal_Web_Hartford_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321739, 
      "name": "FinancePortal_Web_Seattle_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321740, 
      "name": "FinancePortal_Web_LosAngeles_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321741, 
      "name": "FinancePortal_Web_Phoenix_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321742, 
      "name": "FinancePortal_Web_Columbus_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321743, 
      "name": "FinancePortal_Web_Austin_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321744, 
      "name": "FinancePortal_Web_Philadelphia_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321745, 
      "name": "FinancePortal_Web_Hartford_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321746, 
      "name": "FinancePortal_Web_Seattle_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321747, 
      "name": "FinancePortal_Web_LosAngeles_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321748, 
      "name": "FinancePortal_Web_Phoenix_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321749, 
      "name": "FinancePortal_Web_Columbus_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321750, 
      "name": "FinancePortal_Web_Austin_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321751, 
      "name": "FinancePortal_Web_Philadelphia_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321752, 
      "name": "FinancePortal_Web_Hartford_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321753, 
      "name": "FinancePortal_DB_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321754, 
      "name": "FinancePortal_DB_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }, 
    {
      "id": 352321755, 
      "name": "FinancePortal_DB_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321756, 
      "name": "FinancePortal_DB_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321757, 
      "name": "FinancePortal_LDAP_Effncy_TCPRsts", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "rsts", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 5
      }
    }, 
    {
      "id": 352321758, 
      "name": "FinancePortal_LDAP_Effncy_TCPRetransBW", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "retransbw", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 9
      }
    }, 
    {
      "id": 352321759, 
      "name": "FinancePortal_LDAP_Conn_ActiveConns", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "conns_active", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 11
      }
    }, 
    {
      "id": 352321760, 
      "name": "FinancePortal_LDAP_UserExp_RspTime", 
      "tuning_parameters": {
        "noise_floor": 0, 
        "name": "resp", 
        "trigger_on_increases": true, 
        "trigger_on_decreases": false, 
        "duration": 1, 
        "tolerance_high": 8, 
        "tolerance_low": 7, 
        "id": 4
      }
    }
  ], 
  "segments": [
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "WebVIP", 
      "name": "Web-LB", 
      "server_component_name": "WebFarm", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 186, 
      "server_component_id": 135, 
      "alert_notification": false, 
      "client_component_id": 139
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "DB-VIP", 
      "name": "DB-LB", 
      "server_component_name": "DBFarm", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 141, 
      "server_component_id": 137, 
      "alert_notification": false, 
      "client_component_id": 140
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "EndUsers", 
      "name": "Web", 
      "server_component_name": "WebVIP", 
      "type": "FRONT_END", 
      "locations": [
        {
          "host_group_type_id": 102, 
          "location_id": 174, 
          "host_group_id": 0
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 175, 
          "host_group_id": 1
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 176, 
          "host_group_id": 2
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 177, 
          "host_group_id": 3
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 178, 
          "host_group_id": 5
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 179, 
          "host_group_id": 6
        }, 
        {
          "host_group_type_id": 102, 
          "location_id": 180, 
          "host_group_id": 7
        }
      ], 
      "monitored_metrics": [], 
      "id": 173, 
      "server_component_id": 139, 
      "alert_notification": false, 
      "client_component_id": 136, 
      "location_type": "SUBSET"
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "WebFarm", 
      "name": "DB", 
      "server_component_name": "DB-VIP", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 147, 
      "server_component_id": 140, 
      "alert_notification": false, 
      "client_component_id": 135
    }, 
    {
      "status": "ADDED", 
      "definition": [], 
      "client_component_name": "WebFarm", 
      "name": "LDAP", 
      "server_component_name": "LDAP-Servers", 
      "type": "BACK_END", 
      "monitored_metrics": [], 
      "id": 153, 
      "server_component_id": 138, 
      "alert_notification": false, 
      "client_component_id": 135
    }
  ], 
  "name": "Service_A"
}
Property Name Type Description Notes
ServiceConfig <object> Object representing a business service.
ServiceConfig.alert_notification <object> Alert notification flag.
ServiceConfig.alert_notification.
high_enabled
<string> High alert enabled flag.
ServiceConfig.alert_notification.
low_alert_recipient
<string> Low alert recipient.
ServiceConfig.alert_notification.
low_enabled
<string> Low alert enabled flag.
ServiceConfig.alert_notification.
high_alert_recipient
<string> High alert recipient.
ServiceConfig.components <array of <object>> Service components.
ServiceConfig.components
[ServiceComponent]
<object> Components defined for this business service. Optional
ServiceConfig.components
[ServiceComponent].id
<number> Service component id. Optional
ServiceConfig.components
[ServiceComponent].definition
<object> Service component definition.
ServiceConfig.components
[ServiceComponent].definition.
snat_type
<string> Snat type. Optional; Values: NOT_USED, SOMETIMES, ALWAYS
ServiceConfig.components
[ServiceComponent].definition.vips
<array of <object>> Vips if any. Optional
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer]
<object> Load balancer virtual server. Optional
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer].port
<number> Port.
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer].protocol
<number> Protocol.
ServiceConfig.components
[ServiceComponent].definition.vips
[LBVirtualServer].ipaddr
<string> IP address.
ServiceConfig.components
[ServiceComponent].definition.
load_balancer
<number> Load balancer if any. Optional
ServiceConfig.components
[ServiceComponent].definition.
outside_hosts
<array of <string>> Hosts/subnets excluded from component definition if any. Optional
ServiceConfig.components
[ServiceComponent].definition.
outside_hosts[item]
<string> Host/subnet string. Optional
ServiceConfig.components
[ServiceComponent].definition.manual
<string> Manual flag. Optional
ServiceConfig.components
[ServiceComponent].definition.
within_hosts
<array of <string>> Hosts/subnets included into component definition. Optional
ServiceConfig.components
[ServiceComponent].definition.
within_hosts[item]
<string> Host/subnet string. Optional
ServiceConfig.components
[ServiceComponent].definition.snats
<array of <string>> Snats if any. Optional
ServiceConfig.components
[ServiceComponent].definition.snats
[item]
<string> Host/subnet string. Optional
ServiceConfig.components
[ServiceComponent].name
<string> Service component name.
ServiceConfig.components
[ServiceComponent].type
<string> Service component type. Values: END_USERS, SERVERS, LBVS, LBRS
ServiceConfig.segments <array of <object>> Service segments.
ServiceConfig.segments[ServiceSegment] <object> Segments defined for this business service. Optional
ServiceConfig.segments[ServiceSegment].
alert_notification
<string> Alert notification flag.
ServiceConfig.segments[ServiceSegment].
id
<number> Service segment id. Optional
ServiceConfig.segments[ServiceSegment].
definition
<array of <string>> Segment definition.
ServiceConfig.segments[ServiceSegment].
definition[item]
<string> Service segment definition. Optional
ServiceConfig.segments[ServiceSegment].
client_component_id
<number> Client component id. Optional
ServiceConfig.segments[ServiceSegment].
status
<string> Service segment status. Optional; Values: ADDED, DROPPED, UNDECIDED
ServiceConfig.segments[ServiceSegment].
locations
<array of <object>> Segment locations. Optional
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation]
<object> Segment locations. Optional
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation].
host_group_type_id
<number> Host group type id.
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation].
host_group_id
<number> Host group id.
ServiceConfig.segments[ServiceSegment].
locations[SegmentLocation].location_id
<number> Location id. Optional
ServiceConfig.segments[ServiceSegment].
server_component_name
<string> Server component name.
ServiceConfig.segments[ServiceSegment].
name
<string> Service segment name.
ServiceConfig.segments[ServiceSegment].
type
<string> Service segment type. Optional; Values: FRONT_END, BACK_END
ServiceConfig.segments[ServiceSegment].
monitored_metrics
<array of <object>> Monitored segment metrics.
ServiceConfig.segments[ServiceSegment].
monitored_metrics[SegmentMetric]
<object> Segment metrics. Optional
ServiceConfig.segments[ServiceSegment].
monitored_metrics[SegmentMetric].id
<number> Metric id.
ServiceConfig.segments[ServiceSegment].
location_type
<string> Location type. Optional; Values: ALL, SUBSET
ServiceConfig.segments[ServiceSegment].
server_component_id
<number> Server component id. Optional
ServiceConfig.segments[ServiceSegment].
client_component_name
<string> Client component name.
ServiceConfig.id <number> Service id. Optional
ServiceConfig.description <string> Service description.
ServiceConfig.name <string> Service name.
ServiceConfig.locked_by_user_id <number> Account id of the user currently editing this Service if any. Optional
ServiceConfig.policies <array of <object>> Service policies.
ServiceConfig.policies[ServicePolicy] <object> Policies defined for this business service. Optional
ServiceConfig.policies[ServicePolicy].id <number> Service policy id. Optional
ServiceConfig.policies[ServicePolicy].
tuning_parameters
<object> Tuning parameters.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.id
<number> Service policy parameter id.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.tolerance_high
<number> Service policy high tolerance threshold.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.name
<string> Service policy parameter name.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.tolerance_low
<number> Service policy low tolerance threshold.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.noise_floor
<string> Service policy noise floor.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.duration
<number> Service policy duration.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.trigger_on_decreases
<string> Service policy trigger on decreases.
ServiceConfig.policies[ServicePolicy].
tuning_parameters.trigger_on_increases
<string> Service policy trigger on increases.
ServiceConfig.policies[ServicePolicy].
name
<string> Service policy name.

Services: Get policies

Manage policies of one business service.

GET https://{device}/api/profiler/1.3/services/{service_id}/policies?offset={number}&sortby={string}&sort={string}&limit={number}
Authorization

This request requires authorization.

Parameters
Property Name Type Description Notes
offset <number> Starting element number. Optional
sortby <string> Sorting field name. Optional
sort <string> Sorting direction: 'asc' or 'desc' (default: 'asc'). Optional
limit <number> Number of rows to be returned. Optional
Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "id": number,
    "tuning_parameters": {
      "id": number,
      "tolerance_high": number,
      "name": string,
      "tolerance_low": number,
      "noise_floor": string,
      "duration": number,
      "trigger_on_decreases": string,
      "trigger_on_increases": string
    },
    "name": string
  }
]

Example:
[
  {
    "id": 352321572, 
    "name": "Srv-1_Seg-1_Conn_ActiveConns", 
    "tuning_parameters": {
      "noise_floor": 0, 
      "name": "conns_active", 
      "trigger_on_increases": true, 
      "trigger_on_decreases": false, 
      "duration": 1, 
      "tolerance_high": 8, 
      "tolerance_low": 7, 
      "id": 11
    }
  }, 
  {
    "id": 352321573, 
    "name": "Srv-1_Seg-1_Effncy_TCPRetransBW", 
    "tuning_parameters": {
      "noise_floor": 0, 
      "name": "retransbw", 
      "trigger_on_increases": true, 
      "trigger_on_decreases": false, 
      "duration": 1, 
      "tolerance_high": 8, 
      "tolerance_low": 7, 
      "id": 9
    }
  }, 
  {
    "id": 352321574, 
    "name": "Srv-1_Seg-2_Boston_Conn_ActiveConns", 
    "tuning_parameters": {
      "noise_floor": 0, 
      "name": "conns_active", 
      "trigger_on_increases": true, 
      "trigger_on_decreases": false, 
      "duration": 1, 
      "tolerance_high": 8, 
      "tolerance_low": 7, 
      "id": 11
    }
  }
]
Property Name Type Description Notes
ServicePoliciesList <array of <object>> List of service policies defined for this business service.
ServicePoliciesList[ServicePolicy] <object> Policies defined for this business service. Optional
ServicePoliciesList[ServicePolicy].id <number> Service policy id. Optional
ServicePoliciesList[ServicePolicy].
tuning_parameters
<object> Tuning parameters.
ServicePoliciesList[ServicePolicy].
tuning_parameters.id
<number> Service policy parameter id.
ServicePoliciesList[ServicePolicy].
tuning_parameters.tolerance_high
<number> Service policy high tolerance threshold.
ServicePoliciesList[ServicePolicy].
tuning_parameters.name
<string> Service policy parameter name.
ServicePoliciesList[ServicePolicy].
tuning_parameters.tolerance_low
<number> Service policy low tolerance threshold.
ServicePoliciesList[ServicePolicy].
tuning_parameters.noise_floor
<string> Service policy noise floor.
ServicePoliciesList[ServicePolicy].
tuning_parameters.duration
<number> Service policy duration.
ServicePoliciesList[ServicePolicy].
tuning_parameters.trigger_on_decreases
<string> Service policy trigger on decreases.
ServicePoliciesList[ServicePolicy].
tuning_parameters.trigger_on_increases
<string> Service policy trigger on increases.
ServicePoliciesList[ServicePolicy].name <string> Service policy name.

Services: Get segments

Manage segments of one business service.

GET https://{device}/api/profiler/1.3/services/{service_id}/segments?offset={number}&sortby={string}&sort={string}&limit={number}
Authorization

This request requires authorization.

Parameters
Property Name Type Description Notes
offset <number> Starting element number. Optional
sortby <string> Sorting field name. Optional
sort <string> Sorting direction: 'asc' or 'desc' (default: 'asc'). Optional
limit <number> Number of rows to be returned. Optional
Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "alert_notification": string,
    "id": number,
    "definition": [
      string
    ],
    "client_component_id": number,
    "status": string,
    "locations": [
      {
        "host_group_type_id": number,
        "host_group_id": number,
        "location_id": number
      }
    ],
    "server_component_name": string,
    "name": string,
    "type": string,
    "monitored_metrics": [
      {
        "id": number
      }
    ],
    "location_type": string,
    "server_component_id": number,
    "client_component_name": string
  }
]

Example:
[
  {
    "status": "ADDED", 
    "definition": [], 
    "client_component_name": "Comp-2", 
    "name": "Seg-1", 
    "server_component_name": "Comp-3", 
    "type": "BACK_END", 
    "monitored_metrics": [
      {
        "id": 11
      }, 
      {
        "id": 9
      }
    ], 
    "id": 1003, 
    "server_component_id": 1002, 
    "alert_notification": true, 
    "client_component_id": 1001
  }, 
  {
    "status": "ADDED", 
    "definition": [], 
    "client_component_name": "Comp-1", 
    "name": "Seg-2", 
    "server_component_name": "Comp-2", 
    "type": "FRONT_END", 
    "locations": [
      {
        "host_group_type_id": 102, 
        "location_id": 1010, 
        "host_group_id": 0
      }
    ], 
    "monitored_metrics": [
      {
        "id": 11
      }
    ], 
    "id": 1009, 
    "server_component_id": 1001, 
    "alert_notification": false, 
    "client_component_id": 1000, 
    "location_type": "SUBSET"
  }
]
Property Name Type Description Notes
ServiceSegmentsList <array of <object>> List of segments defined for this business service.
ServiceSegmentsList[ServiceSegment] <object> Segments defined for this business service. Optional
ServiceSegmentsList[ServiceSegment].
alert_notification
<string> Alert notification flag.
ServiceSegmentsList[ServiceSegment].id <number> Service segment id. Optional
ServiceSegmentsList[ServiceSegment].
definition
<array of <string>> Segment definition.
ServiceSegmentsList[ServiceSegment].
definition[item]
<string> Service segment definition. Optional
ServiceSegmentsList[ServiceSegment].
client_component_id
<number> Client component id. Optional
ServiceSegmentsList[ServiceSegment].
status
<string> Service segment status. Optional; Values: ADDED, DROPPED, UNDECIDED
ServiceSegmentsList[ServiceSegment].
locations
<array of <object>> Segment locations. Optional
ServiceSegmentsList[ServiceSegment].
locations[SegmentLocation]
<object> Segment locations. Optional
ServiceSegmentsList[ServiceSegment].
locations[SegmentLocation].
host_group_type_id
<number> Host group type id.
ServiceSegmentsList[ServiceSegment].
locations[SegmentLocation].
host_group_id
<number> Host group id.
ServiceSegmentsList[ServiceSegment].
locations[SegmentLocation].location_id
<number> Location id. Optional
ServiceSegmentsList[ServiceSegment].
server_component_name
<string> Server component name.
ServiceSegmentsList[ServiceSegment].name <string> Service segment name.
ServiceSegmentsList[ServiceSegment].type <string> Service segment type. Optional; Values: FRONT_END, BACK_END
ServiceSegmentsList[ServiceSegment].
monitored_metrics
<array of <object>> Monitored segment metrics.
ServiceSegmentsList[ServiceSegment].
monitored_metrics[SegmentMetric]
<object> Segment metrics. Optional
ServiceSegmentsList[ServiceSegment].
monitored_metrics[SegmentMetric].id
<number> Metric id.
ServiceSegmentsList[ServiceSegment].
location_type
<string> Location type. Optional; Values: ALL, SUBSET
ServiceSegmentsList[ServiceSegment].
server_component_id
<number> Server component id. Optional
ServiceSegmentsList[ServiceSegment].
client_component_name
<string> Client component name.

Vnis: List VNIs

Get a list of Virtual Network Identifiers.

GET https://{device}/api/profiler/1.3/vnis
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "id": number,
    "description": string,
    "name": string
  }
]

Example:
[
  {
    "description": "Customer A. Blue Network.", 
    "name": "Blue_Network", 
    "id": 100
  }, 
  {
    "description": "Customer B. Blue Network.", 
    "name": "Red_Network", 
    "id": 200
  }
]
Property Name Type Description Notes
VNIs <array of <object>> List of VNIs (Virtual Network Identifiers of SDN setup).
VNIs[VNI] <object> Object representing a VNI. Optional
VNIs[VNI].id <number> ID of the VNI.
VNIs[VNI].description <string> Description of the VNI. Optional
VNIs[VNI].name <string> Name of the VNI. Optional

Vnis: Delete VNI

Delete a Virtual Network Identifier.

DELETE https://{device}/api/profiler/1.3/vnis/{vni_id}
Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

Vnis: Update VNIs

Update one or many Virtual Network Identifiers.

PUT https://{device}/api/profiler/1.3/vnis
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "id": number,
    "description": string,
    "name": string
  }
]

Example:
[
  {
    "description": "Customer A. Blue Network.", 
    "name": "Blue_Network", 
    "id": 100
  }, 
  {
    "description": "Customer B. Blue Network.", 
    "name": "Red_Network", 
    "id": 200
  }
]
Property Name Type Description Notes
VNIs <array of <object>> List of VNIs (Virtual Network Identifiers of SDN setup).
VNIs[VNI] <object> Object representing a VNI. Optional
VNIs[VNI].id <number> ID of the VNI.
VNIs[VNI].description <string> Description of the VNI. Optional
VNIs[VNI].name <string> Name of the VNI. Optional
Response Body

On success, the server does not provide any body in the responses.

Vnis: Get VNI

Get a Virtual Network Identifier.

GET https://{device}/api/profiler/1.3/vnis/{vni_id}
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "id": number,
  "description": string,
  "name": string
}

Example:
{
  "description": "Customer A. Blue Network.", 
  "name": "Blue_Network", 
  "id": 100
}
Property Name Type Description Notes
VNI <object> Object representing a VNI.
VNI.id <number> ID of the VNI.
VNI.description <string> Description of the VNI. Optional
VNI.name <string> Name of the VNI. Optional

Vnis: Update VNI

Update one Virtual Network Identifier.

PUT https://{device}/api/profiler/1.3/vnis/{vni_id}
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "id": number,
  "description": string,
  "name": string
}

Example:
{
  "description": "Customer A. Blue Network.", 
  "name": "Blue_Network", 
  "id": 100
}
Property Name Type Description Notes
VNI <object> Object representing a VNI.
VNI.id <number> ID of the VNI.
VNI.description <string> Description of the VNI. Optional
VNI.name <string> Name of the VNI. Optional
Response Body

On success, the server does not provide any body in the responses.

Steelheads: Disable Steelhead polling

Disables data polling from Steelheads.

POST https://{device}/api/profiler/1.3/steelheads/sync/disable
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "ipaddr": string
  }
]

Example:
[
  {
    "ipaddr": "10.99.16.252"
  }, 
  {
    "ipaddr": "10.99.15.252"
  }, 
  {
    "ipaddr": "10.99.14.252"
  }
]
Property Name Type Description Notes
SteelheadIPAddrs <array of <object>> IP addresses object representing the list of Steelheads.
SteelheadIPAddrs[SteelheadIPAddr] <object> IP address collection object representing the list of Steelheads. Optional
SteelheadIPAddrs[SteelheadIPAddr].ipaddr <string> IP address representing a Steelhead.
Response Body

On success, the server does not provide any body in the responses.

Steelheads: Enable Steelhead polling

Enables data polling from Steelheads.

POST https://{device}/api/profiler/1.3/steelheads/sync/enable
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "ipaddr": string
  }
]

Example:
[
  {
    "ipaddr": "10.99.16.252"
  }, 
  {
    "ipaddr": "10.99.15.252"
  }, 
  {
    "ipaddr": "10.99.14.252"
  }
]
Property Name Type Description Notes
SteelheadIPAddrs <array of <object>> IP addresses object representing the list of Steelheads.
SteelheadIPAddrs[SteelheadIPAddr] <object> IP address collection object representing the list of Steelheads. Optional
SteelheadIPAddrs[SteelheadIPAddr].ipaddr <string> IP address representing a Steelhead.
Response Body

On success, the server does not provide any body in the responses.

Steelheads: Delete Steelheads global OAuth

Deletes global OAuth code.

DELETE https://{device}/api/profiler/1.3/steelheads/oauth_code/global
Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

Steelheads: Get Steelheads OAuth codes

Get a list of steelheads CIDRs with OAuth code configured.

GET https://{device}/api/profiler/1.3/steelheads/oauth_code
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "cidr": string
  }
]

Example:
[
  {
    "cidr": "10.10.0.60"
  }, 
  {
    "cidr": "0/0"
  }, 
  {
    "cidr": "10/8"
  }
]
Property Name Type Description Notes
Cidrs <array of <object>> List of Cidr Objects.
Cidrs[Cidr] <object> Object representing an IP address, CIDR. Optional
Cidrs[Cidr].cidr <string> IP address, CIDR.

Steelheads: Update Steelheads OAuth codes

Creates or Updates Oauth Codes for a list of Steelheads.

PUT https://{device}/api/profiler/1.3/steelheads/oauth_code
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "code": string,
    "cidr": string
  }
]

Example:
[
  {
    "cidr": "10.20.0.60", 
    "code": "code_ip"
  }, 
  {
    "cidr": "0/0", 
    "code": "code_global"
  }, 
  {
    "cidr": "10/8", 
    "code": "code_region"
  }
]
Property Name Type Description Notes
Oauthcodes <array of <object>> List of OAuth code Objects.
Oauthcodes[Oauthcode] <object> Object representing an IP address, CIDR and its OAuth code. Optional
Oauthcodes[Oauthcode].code <string> OAuth code.
Oauthcodes[Oauthcode].cidr <string> IP address, CIDR.
Response Body

On success, the server does not provide any body in the responses.

Steelheads: Sync Steelheads QoS data

Retrieves QoS data from Steelheads on which polling is enabled.

POST https://{device}/api/profiler/1.3/steelheads/qos/sync
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "ipaddr": string
  }
]

Example:
[
  {
    "ipaddr": "10.99.16.252"
  }, 
  {
    "ipaddr": "10.99.15.252"
  }, 
  {
    "ipaddr": "10.99.14.252"
  }
]
Property Name Type Description Notes
SteelheadIPAddrs <array of <object>> IP addresses object representing the list of Steelheads.
SteelheadIPAddrs[SteelheadIPAddr] <object> IP address collection object representing the list of Steelheads. Optional
SteelheadIPAddrs[SteelheadIPAddr].ipaddr <string> IP address representing a Steelhead.
Response Body

On success, the server does not provide any body in the responses.

Steelheads: Sync Steelhead apps

Retrieves application data from Steelheads on which polling is enabled.

POST https://{device}/api/profiler/1.3/steelheads/apps/sync
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "ipaddr": string
  }
]

Example:
[
  {
    "ipaddr": "10.99.16.252"
  }, 
  {
    "ipaddr": "10.99.15.252"
  }, 
  {
    "ipaddr": "10.99.14.252"
  }
]
Property Name Type Description Notes
SteelheadIPAddrs <array of <object>> IP addresses object representing the list of Steelheads.
SteelheadIPAddrs[SteelheadIPAddr] <object> IP address collection object representing the list of Steelheads. Optional
SteelheadIPAddrs[SteelheadIPAddr].ipaddr <string> IP address representing a Steelhead.
Response Body

On success, the server does not provide any body in the responses.

Steelheads: Get Steelheads

Get a Steelhead QoS Global Configuration by IP address.

GET https://{device}/api/profiler/1.3/steelheads/{steelhead_ip}
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "dpi": string,
  "marking": string,
  "sync": {
    "apps": {
      "enabled": string,
      "error_text": string,
      "last_sync_ts": number,
      "last_success_ts": number,
      "error_id": number,
      "state": string
    },
    "qos": {
      "enabled": string,
      "error_text": string,
      "last_sync_ts": number,
      "last_success_ts": number,
      "error_id": number,
      "state": string
    }
  },
  "ipaddr": string,
  "name": string,
  "oauth_custom": string,
  "hier_mode": string,
  "shaping": string,
  "easy_mode": string,
  "bw_overcommit": string
}

Example:
{
  "marking": false, 
  "name": "SH-DataCenter", 
  "ipaddr": "10.100.100.252", 
  "bw_overcommit": false, 
  "sync": {
    "qos": {
      "last_sync_ts": 1370967843, 
      "enabled": true, 
      "last_success_ts": 0, 
      "state": "SYNC_FAILED", 
      "error_id": 720897, 
      "error_text": "28: Timeout was reached"
    }, 
    "apps": {
      "last_sync_ts": 1370967843, 
      "enabled": true, 
      "last_success_ts": 0, 
      "state": "SYNC_FAILED", 
      "error_id": 720897, 
      "error_text": "28: Timeout was reached"
    }
  }, 
  "shaping": true, 
  "hier_mode": true, 
  "oauth_custom": false, 
  "dpi": true, 
  "easy_mode": false
}
Property Name Type Description Notes
Steelhead <object> Object representing a steelhead.
Steelhead.dpi <string> Flag indicating if Deep Packet Inspection (DPI) is enabled on this Steelhead. Optional
Steelhead.marking <string> Flag indicating if QoS Marking is enabled on this Steelhead. Optional
Steelhead.sync <object> Object representing Steelhead syncronization information.
Steelhead.sync.apps <object> Object representing Steelhead application syncronization information.
Steelhead.sync.apps.enabled <string> Flag - Enable application synchronization.
Steelhead.sync.apps.error_text <string> Error description.
Steelhead.sync.apps.last_sync_ts <number> Last attempted application synchronization time.
Steelhead.sync.apps.last_success_ts <number> Last successful application synchronization time.
Steelhead.sync.apps.error_id <number> Error ID.
Steelhead.sync.apps.state <string> Synchronization status. Values: SYNC_INITIALIZING, SYNC_FAILED, SYNC_SUCCEEDED, SYNC_DISABLED, SYNC_NA
Steelhead.sync.qos <object> Object representing Steelhead QoS syncronization information.
Steelhead.sync.qos.enabled <string> Flag indicating if QoS synchronization is enabled on this Steelhead.
Steelhead.sync.qos.error_text <string> Error description.
Steelhead.sync.qos.last_sync_ts <number> Last attempted QoS syncronization time.
Steelhead.sync.qos.last_success_ts <number> Last successful QoS syncronization time.
Steelhead.sync.qos.error_id <number> Error ID.
Steelhead.sync.qos.state <string> Synchronization status. Values: SYNC_INITIALIZING, SYNC_FAILED, SYNC_SUCCEEDED, SYNC_DISABLED, SYNC_NA
Steelhead.ipaddr <string> Steelhead IP address.
Steelhead.name <string> Steelhead name.
Steelhead.oauth_custom <string> Flag indicating if Custom OAuth code is configured on this Steelhead.
Steelhead.hier_mode <string> Flag indicating if QoS Hierarchical Mode is enabled on this Steelhead. Optional
Steelhead.shaping <string> Flag indicating if QoS Shaping is enabled on this Steelhead. Optional
Steelhead.easy_mode <string> Flag indicating which QoS Configuration Mode (Basic/Advanced) is set (Basic if true). Optional
Steelhead.bw_overcommit <string> Flag indicating if QoS Bandwidth Overcommit is enabled on this Steelhead. Optional

Steelheads: Delete Steelheads OAuth codes

Deletes OAuth codes for a list of Steelheads.

DELETE https://{device}/api/profiler/1.3/steelheads/oauth_code
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "cidr": string
  }
]

Example:
[
  {
    "cidr": "10.10.0.60"
  }, 
  {
    "cidr": "0/0"
  }, 
  {
    "cidr": "10/8"
  }
]
Property Name Type Description Notes
Cidrs <array of <object>> List of Cidr Objects.
Cidrs[Cidr] <object> Object representing an IP address, CIDR. Optional
Cidrs[Cidr].cidr <string> IP address, CIDR.
Response Body

On success, the server does not provide any body in the responses.

Steelheads: Update Steelheads global OAuth

Creates or Updates global OAuth code.

PUT https://{device}/api/profiler/1.3/steelheads/oauth_code/global
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "code": string
}

Example:
{
  "code": "code_global"
}
Property Name Type Description Notes
Globalcode <object> Global OAuth code object.
Globalcode.code <string> OAuth Code.
Response Body

On success, the server does not provide any body in the responses.

Steelheads: List Steelheads

Get a list of Steelheads and their QoS global and application configuration.

GET https://{device}/api/profiler/1.3/steelheads
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "dpi": string,
    "marking": string,
    "sync": {
      "apps": {
        "enabled": string,
        "error_text": string,
        "last_sync_ts": number,
        "last_success_ts": number,
        "error_id": number,
        "state": string
      },
      "qos": {
        "enabled": string,
        "error_text": string,
        "last_sync_ts": number,
        "last_success_ts": number,
        "error_id": number,
        "state": string
      }
    },
    "ipaddr": string,
    "name": string,
    "oauth_custom": string,
    "hier_mode": string,
    "shaping": string,
    "easy_mode": string,
    "bw_overcommit": string
  }
]

Example:
[
  {
    "marking": false, 
    "name": "10.99.15.252", 
    "ipaddr": "10.99.15.252", 
    "bw_overcommit": false, 
    "sync": {
      "qos": {
        "last_sync_ts": 1370967813, 
        "enabled": true, 
        "last_success_ts": 0, 
        "state": "SYNC_FAILED", 
        "error_id": 720897, 
        "error_text": "28: Timeout was reached"
      }, 
      "apps": {
        "last_sync_ts": 1370967813, 
        "enabled": true, 
        "last_success_ts": 0, 
        "state": "SYNC_FAILED", 
        "error_id": 720897, 
        "error_text": "28: Timeout was reached"
      }
    }, 
    "shaping": true, 
    "hier_mode": true, 
    "oauth_custom": false, 
    "dpi": false, 
    "easy_mode": true
  }, 
  {
    "marking": false, 
    "name": "SH-DataCenter", 
    "ipaddr": "10.100.100.252", 
    "bw_overcommit": false, 
    "sync": {
      "qos": {
        "last_sync_ts": 1370967843, 
        "enabled": true, 
        "last_success_ts": 0, 
        "state": "SYNC_FAILED", 
        "error_id": 720897, 
        "error_text": "28: Timeout was reached"
      }, 
      "apps": {
        "last_sync_ts": 1370967843, 
        "enabled": true, 
        "last_success_ts": 0, 
        "state": "SYNC_FAILED", 
        "error_id": 720897, 
        "error_text": "28: Timeout was reached"
      }
    }, 
    "shaping": true, 
    "hier_mode": true, 
    "oauth_custom": false, 
    "dpi": true, 
    "easy_mode": false
  }, 
  {
    "marking": false, 
    "name": "SH-LosAngeles", 
    "ipaddr": "10.99.12.252", 
    "bw_overcommit": false, 
    "sync": {
      "qos": {
        "last_sync_ts": 1371583559, 
        "enabled": true, 
        "last_success_ts": 0, 
        "state": "SYNC_FAILED", 
        "error_id": 720897, 
        "error_text": "28: Timeout was reached"
      }, 
      "apps": {
        "last_sync_ts": 1371583559, 
        "enabled": true, 
        "last_success_ts": 0, 
        "state": "SYNC_FAILED", 
        "error_id": 720897, 
        "error_text": "28: Timeout was reached"
      }
    }, 
    "shaping": true, 
    "hier_mode": true, 
    "oauth_custom": false, 
    "dpi": false, 
    "easy_mode": true
  }
]
Property Name Type Description Notes
Steelheads <array of <object>> List of Steelheads and their QoS and Application configuration data.
Steelheads[Steelhead] <object> Steelhead QoS and Application Configuration Data. Optional
Steelheads[Steelhead].dpi <string> Flag indicating if Deep Packet Inspection (DPI) is enabled on this Steelhead. Optional
Steelheads[Steelhead].marking <string> Flag indicating if QoS Marking is enabled on this Steelhead. Optional
Steelheads[Steelhead].sync <object> Object representing Steelhead syncronization information.
Steelheads[Steelhead].sync.apps <object> Object representing Steelhead application syncronization information.
Steelheads[Steelhead].sync.apps.enabled <string> Flag - Enable application synchronization.
Steelheads[Steelhead].sync.apps.
error_text
<string> Error description.
Steelheads[Steelhead].sync.apps.
last_sync_ts
<number> Last attempted application synchronization time.
Steelheads[Steelhead].sync.apps.
last_success_ts
<number> Last successful application synchronization time.
Steelheads[Steelhead].sync.apps.error_id <number> Error ID.
Steelheads[Steelhead].sync.apps.state <string> Synchronization status. Values: SYNC_INITIALIZING, SYNC_FAILED, SYNC_SUCCEEDED, SYNC_DISABLED, SYNC_NA
Steelheads[Steelhead].sync.qos <object> Object representing Steelhead QoS syncronization information.
Steelheads[Steelhead].sync.qos.enabled <string> Flag indicating if QoS synchronization is enabled on this Steelhead.
Steelheads[Steelhead].sync.qos.
error_text
<string> Error description.
Steelheads[Steelhead].sync.qos.
last_sync_ts
<number> Last attempted QoS syncronization time.
Steelheads[Steelhead].sync.qos.
last_success_ts
<number> Last successful QoS syncronization time.
Steelheads[Steelhead].sync.qos.error_id <number> Error ID.
Steelheads[Steelhead].sync.qos.state <string> Synchronization status. Values: SYNC_INITIALIZING, SYNC_FAILED, SYNC_SUCCEEDED, SYNC_DISABLED, SYNC_NA
Steelheads[Steelhead].ipaddr <string> Steelhead IP address.
Steelheads[Steelhead].name <string> Steelhead name.
Steelheads[Steelhead].oauth_custom <string> Flag indicating if Custom OAuth code is configured on this Steelhead.
Steelheads[Steelhead].hier_mode <string> Flag indicating if QoS Hierarchical Mode is enabled on this Steelhead. Optional
Steelheads[Steelhead].shaping <string> Flag indicating if QoS Shaping is enabled on this Steelhead. Optional
Steelheads[Steelhead].easy_mode <string> Flag indicating which QoS Configuration Mode (Basic/Advanced) is set (Basic if true). Optional
Steelheads[Steelhead].bw_overcommit <string> Flag indicating if QoS Bandwidth Overcommit is enabled on this Steelhead. Optional

Steelheads: Ping Steelhead

Pings a Steelhead by IP address.

GET https://{device}/api/profiler/1.3/steelheads/{steelhead_ip}/ping
Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

Steelheads: Check Steelheads global OAuth

Checks if the global OAuth code is configured.

GET https://{device}/api/profiler/1.3/steelheads/oauth_code/global
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "configured": string
}

Example:
{
  "configured": true
}
Property Name Type Description Notes
Oauthcodeglobal <object> Object representing the global OAuth code is configured.
Oauthcodeglobal.configured <string> True if the global ouath code is configured.

Devices: Enable REST polling

Globally disable REST polling for all devices.

POST https://{device}/api/profiler/1.3/devices/restsync/enable
Authorization

This request requires authorization.

Request Body

Do not provide a request body.

Response Body

On success, the server does not provide any body in the responses.

Devices: Get device

Get a device by IP Address.

GET https://{device}/api/profiler/1.3/devices/{device_ip}
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "id": number,
  "type_id": number,
  "ipaddr": string,
  "name": string,
  "type": string,
  "version": string
}

Example:
{
  "name": "MyNetflowDevice", 
  "type_id": 2, 
  "ipaddr": "10.0.0.1", 
  "version": "N/A", 
  "type": "Netflow", 
  "id": 123
}
Property Name Type Description Notes
Device <object> Object representing a device.
Device.id <number> Device identifier (ID). Used internally in the product and in the API.
Device.type_id <number> Device type ID; a way to represent device type that is more friendly to programs.
Device.ipaddr <string> Device IP address.
Device.name <string> Device name, which usually comes from SNMP or DNS.
Device.type <string> Device type, e.g. Cascade Gateway, Cascade Shark or Netflow device.
Device.version <string> Version of the protocol used to communicate with the device.

Devices: List devices

Get a list of devices.

GET https://{device}/api/profiler/1.3/devices?type_id={number}&cidr={string}
Authorization

This request requires authorization.

Parameters
Property Name Type Description Notes
type_id <number> Filter devices by device type. Optional
cidr <string> Filter devices by IP or Subnet (e.g. 10.0.0.0/8). Optional
Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "id": number,
    "type_id": number,
    "ipaddr": string,
    "name": string,
    "type": string,
    "version": string
  }
]

Example:
[
  {
    "name": "MyNetflowDevice", 
    "type_id": 2, 
    "ipaddr": "10.0.0.1", 
    "version": "N/A", 
    "type": "Netflow", 
    "id": 123
  }, 
  {
    "name": "MySensorDevice", 
    "type_id": 1, 
    "ipaddr": "10.0.0.2", 
    "version": "M8.4", 
    "type": "Sensor", 
    "id": 124
  }
]
Property Name Type Description Notes
Devices <array of <object>> List of network devices that report data to Profiler.
Devices[Device] <object> One device from the list of devices that report data. Optional
Devices[Device].id <number> Device identifier (ID). Used internally in the product and in the API.
Devices[Device].type_id <number> Device type ID; a way to represent device type that is more friendly to programs.
Devices[Device].ipaddr <string> Device IP address.
Devices[Device].name <string> Device name, which usually comes from SNMP or DNS.
Devices[Device].type <string> Device type, e.g. Cascade Gateway, Cascade Shark or Netflow device.
Devices[Device].version <string> Version of the protocol used to communicate with the device.

Devices: Check REST polling

Get global flag showing whether REST polling is enabled for all devices.

GET https://{device}/api/profiler/1.3/devices/restsync
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "enabled": string
}
Property Name Type Description Notes
DevicesRestSyncEnabled <object> Object representing global REST sync enabled flag for devices on Profiler.
DevicesRestSyncEnabled.enabled <string> Global REST sync enabled flag for devices on Profiler.

Devices: Delete device

Delete a device by IP Address. Warning: the device will be deleted in a few minutes after this call.

DELETE https://{device}/api/profiler/1.3/devices/{device_ip}
Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

Devices: Disable REST polling

Globally enable REST polling for all devices.

POST https://{device}/api/profiler/1.3/devices/restsync/disable
Authorization

This request requires authorization.

Request Body

Do not provide a request body.

Response Body

On success, the server does not provide any body in the responses.

Dscps: List DSCPs

Get complete DSCP configuration.

GET https://{device}/api/profiler/1.3/dscps
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "id": number,
    "description": string,
    "name": string
  }
]

Example:
[
  {
    "description": "Assured Forwarding Class 1 Medium Drop", 
    "name": "AF12", 
    "id": 12
  }, 
  {
    "description": "", 
    "name": "", 
    "id": 13
  }, 
  {
    "description": "Assured Forwarding Class 1 High Drop", 
    "name": "AF13", 
    "id": 14
  }
]
Property Name Type Description Notes
CDSCPDefs <array of <object>> List of DSCP objects.
CDSCPDefs[DSCPDef] <object> Object representing DSCP information. Optional
CDSCPDefs[DSCPDef].id <number> ID of the DSCP.
CDSCPDefs[DSCPDef].description <string> Description of the DSCP.
CDSCPDefs[DSCPDef].name <string> Name of the DSCP.

Dscps: Get DSCP

Get information about a specific DSCP.

GET https://{device}/api/profiler/1.3/dscps/{dscp_id}
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "id": number,
  "description": string,
  "name": string
}

Example:
{
  "description": "Assured Forwarding Class 1 Low Drop", 
  "name": "AF11", 
  "id": 10
}
Property Name Type Description Notes
DSCPDef <object> Object representing DSCP information.
DSCPDef.id <number> ID of the DSCP.
DSCPDef.description <string> Description of the DSCP.
DSCPDef.name <string> Name of the DSCP.

Dscps: Update DSCPs

Update DSCP configuration (only name and description can be updated).

PUT https://{device}/api/profiler/1.3/dscps
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "id": number,
    "description": string,
    "name": string
  }
]

Example:
[
  {
    "description": "Assured Forwarding Class 1 Medium Drop", 
    "name": "AF12", 
    "id": 12
  }, 
  {
    "description": "", 
    "name": "", 
    "id": 13
  }, 
  {
    "description": "Assured Forwarding Class 1 High Drop", 
    "name": "AF13", 
    "id": 14
  }
]
Property Name Type Description Notes
CDSCPDefs <array of <object>> List of DSCP objects.
CDSCPDefs[DSCPDef] <object> Object representing DSCP information. Optional
CDSCPDefs[DSCPDef].id <number> ID of the DSCP.
CDSCPDefs[DSCPDef].description <string> Description of the DSCP.
CDSCPDefs[DSCPDef].name <string> Name of the DSCP.
Response Body

On success, the server does not provide any body in the responses.

Dscps: Update DSCP

Update information for a specific DSCP.

PUT https://{device}/api/profiler/1.3/dscps/{dscp_id}
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "id": number,
  "description": string,
  "name": string
}

Example:
{
  "description": "Assured Forwarding Class 1 Low Drop", 
  "name": "AF11", 
  "id": 10
}
Property Name Type Description Notes
DSCPDef <object> Object representing DSCP information.
DSCPDef.id <number> ID of the DSCP.
DSCPDef.description <string> Description of the DSCP.
DSCPDef.name <string> Name of the DSCP.
Response Body

On success, the server does not provide any body in the responses.

Port_Groups: Get port group

Get one port group.

GET https://{device}/api/profiler/1.3/port_groups/{group_id}
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "id": number,
  "definitions": [
    {
      "port": number,
      "proto": number
    }
  ],
  "name": string
}

Example:
{
  "definitions": [
    {
      "port": 137, 
      "proto": 6
    }, 
    {
      "port": 137, 
      "proto": 17
    }, 
    {
      "port": 138, 
      "proto": 6
    }, 
    {
      "port": 138, 
      "proto": 17
    }, 
    {
      "port": 139, 
      "proto": 6
    }, 
    {
      "port": 139, 
      "proto": 17
    }
  ], 
  "id": 3, 
  "name": "netbios"
}
Property Name Type Description Notes
CPortGroupDef <object> Object representing port group information.
CPortGroupDef.id <number> ID of the port group. To be used in the API. Optional
CPortGroupDef.definitions <array of <object>> Object with port group's definitions.
CPortGroupDef.definitions
[CPortGroupProtoPort]
<object> Port associated with port group. Optional
CPortGroupDef.definitions
[CPortGroupProtoPort].port
<number> Port associated with port group.
CPortGroupDef.definitions
[CPortGroupProtoPort].proto
<number> Protocol that corresponds to the port of the port group.
CPortGroupDef.name <string> Name of the port group.

Port_Groups: Create port group

Create a new port group.

POST https://{device}/api/profiler/1.3/port_groups
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "id": number,
  "definitions": [
    {
      "port": number,
      "proto": number
    }
  ],
  "name": string
}

Example:
{
  "definitions": [
    {
      "port": 137, 
      "proto": 6
    }, 
    {
      "port": 137, 
      "proto": 17
    }, 
    {
      "port": 138, 
      "proto": 6
    }, 
    {
      "port": 138, 
      "proto": 17
    }, 
    {
      "port": 139, 
      "proto": 6
    }, 
    {
      "port": 139, 
      "proto": 17
    }
  ], 
  "id": 3, 
  "name": "netbios"
}
Property Name Type Description Notes
CPortGroupDef <object> Object representing port group information.
CPortGroupDef.id <number> ID of the port group. To be used in the API. Optional
CPortGroupDef.definitions <array of <object>> Object with port group's definitions.
CPortGroupDef.definitions
[CPortGroupProtoPort]
<object> Port associated with port group. Optional
CPortGroupDef.definitions
[CPortGroupProtoPort].port
<number> Port associated with port group.
CPortGroupDef.definitions
[CPortGroupProtoPort].proto
<number> Protocol that corresponds to the port of the port group.
CPortGroupDef.name <string> Name of the port group.
Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "id": number,
  "definitions": [
    {
      "port": number,
      "proto": number
    }
  ],
  "name": string
}

Example:
{
  "definitions": [
    {
      "port": 137, 
      "proto": 6
    }, 
    {
      "port": 137, 
      "proto": 17
    }, 
    {
      "port": 138, 
      "proto": 6
    }, 
    {
      "port": 138, 
      "proto": 17
    }, 
    {
      "port": 139, 
      "proto": 6
    }, 
    {
      "port": 139, 
      "proto": 17
    }
  ], 
  "id": 3, 
  "name": "netbios"
}
Property Name Type Description Notes
CPortGroupDef <object> Object representing port group information.
CPortGroupDef.id <number> ID of the port group. To be used in the API. Optional
CPortGroupDef.definitions <array of <object>> Object with port group's definitions.
CPortGroupDef.definitions
[CPortGroupProtoPort]
<object> Port associated with port group. Optional
CPortGroupDef.definitions
[CPortGroupProtoPort].port
<number> Port associated with port group.
CPortGroupDef.definitions
[CPortGroupProtoPort].proto
<number> Protocol that corresponds to the port of the port group.
CPortGroupDef.name <string> Name of the port group.

Port_Groups: List port groups

Get a list of all configured port groups.

GET https://{device}/api/profiler/1.3/port_groups
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "id": number,
    "definitions": [
      {
        "port": number,
        "proto": number
      }
    ],
    "name": string
  }
]

Example:
[
  {
    "definitions": [
      {
        "port": 25, 
        "proto": 6
      }, 
      {
        "port": 995, 
        "proto": 6
      }, 
      {
        "port": 995, 
        "proto": 17
      }, 
      {
        "port": 1109, 
        "proto": 6
      }
    ], 
    "id": 2, 
    "name": "mail"
  }, 
  {
    "definitions": [
      {
        "port": 137, 
        "proto": 6
      }, 
      {
        "port": 137, 
        "proto": 17
      }, 
      {
        "port": 138, 
        "proto": 6
      }, 
      {
        "port": 138, 
        "proto": 17
      }, 
      {
        "port": 139, 
        "proto": 6
      }, 
      {
        "port": 139, 
        "proto": 17
      }
    ], 
    "id": 3, 
    "name": "netbios"
  }
]
Property Name Type Description Notes
CPortGroupDefs <array of <object>> List of Port Group objects.
CPortGroupDefs[CPortGroupDef] <object> Object representing port group information. Optional
CPortGroupDefs[CPortGroupDef].id <number> ID of the port group. To be used in the API. Optional
CPortGroupDefs[CPortGroupDef].
definitions
<array of <object>> Object with port group's definitions.
CPortGroupDefs[CPortGroupDef].
definitions[CPortGroupProtoPort]
<object> Port associated with port group. Optional
CPortGroupDefs[CPortGroupDef].
definitions[CPortGroupProtoPort].port
<number> Port associated with port group.
CPortGroupDefs[CPortGroupDef].
definitions[CPortGroupProtoPort].proto
<number> Protocol that corresponds to the port of the port group.
CPortGroupDefs[CPortGroupDef].name <string> Name of the port group.

Port_Groups: Update port group

Update one port group.

PUT https://{device}/api/profiler/1.3/port_groups/{group_id}
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "id": number,
  "definitions": [
    {
      "port": number,
      "proto": number
    }
  ],
  "name": string
}

Example:
{
  "definitions": [
    {
      "port": 137, 
      "proto": 6
    }, 
    {
      "port": 137, 
      "proto": 17
    }, 
    {
      "port": 138, 
      "proto": 6
    }, 
    {
      "port": 138, 
      "proto": 17
    }, 
    {
      "port": 139, 
      "proto": 6
    }, 
    {
      "port": 139, 
      "proto": 17
    }
  ], 
  "id": 3, 
  "name": "netbios"
}
Property Name Type Description Notes
CPortGroupDef <object> Object representing port group information.
CPortGroupDef.id <number> ID of the port group. To be used in the API. Optional
CPortGroupDef.definitions <array of <object>> Object with port group's definitions.
CPortGroupDef.definitions
[CPortGroupProtoPort]
<object> Port associated with port group. Optional
CPortGroupDef.definitions
[CPortGroupProtoPort].port
<number> Port associated with port group.
CPortGroupDef.definitions
[CPortGroupProtoPort].proto
<number> Protocol that corresponds to the port of the port group.
CPortGroupDef.name <string> Name of the port group.
Response Body

On success, the server does not provide any body in the responses.

Port_Groups: Delete

Delete one port group.

DELETE https://{device}/api/profiler/1.3/port_groups/{group_id}
Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

Ping: Ping

Simple test of service availability.

GET https://{device}/api/profiler/1.3/ping
Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

Sharks: Enable Sharks polling

Enables data polling from Sharks.

POST https://{device}/api/profiler/1.3/sharks/sync/enable
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "ipaddr": string
  }
]

Example:
[
  {
    "ipaddr": "10.99.16.252"
  }, 
  {
    "ipaddr": "10.99.15.252"
  }, 
  {
    "ipaddr": "10.99.14.252"
  }
]
Property Name Type Description Notes
SharkIPAddrs <array of <object>> IP addresses object representing the list of all Sharks.
SharkIPAddrs[SharkIPAddr] <object> IP address collection object representing the list of all Sharks. Optional
SharkIPAddrs[SharkIPAddr].ipaddr <string> IP address representing a Shark.
Response Body

On success, the server does not provide any body in the responses.

Sharks: Sync Sharks apps

Retrieves application data from Sharks on which polling is enabled.

POST https://{device}/api/profiler/1.3/sharks/apps/sync
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "ipaddr": string
  }
]

Example:
[
  {
    "ipaddr": "10.99.16.252"
  }, 
  {
    "ipaddr": "10.99.15.252"
  }, 
  {
    "ipaddr": "10.99.14.252"
  }
]
Property Name Type Description Notes
SharkIPAddrs <array of <object>> IP addresses object representing the list of all Sharks.
SharkIPAddrs[SharkIPAddr] <object> IP address collection object representing the list of all Sharks. Optional
SharkIPAddrs[SharkIPAddr].ipaddr <string> IP address representing a Shark.
Response Body

On success, the server does not provide any body in the responses.

Sharks: Get Shark apps

Get configuration of a Shark by IP address.

GET https://{device}/api/profiler/1.3/sharks/{shark_ip}
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "sync": {
    "apps": {
      "enabled": string,
      "error_text": string,
      "last_sync_ts": number,
      "last_success_ts": number,
      "error_id": number,
      "state": string
    }
  },
  "ipaddr": string
}
Property Name Type Description Notes
Shark <object> Object representing a Shark.
Shark.sync <object> Object representing Shark syncronization information.
Shark.sync.apps <object> Object representing Shark application syncronization information.
Shark.sync.apps.enabled <string> Flag indicating if application synchronization is enabled on this Shark.
Shark.sync.apps.error_text <string> Error description.
Shark.sync.apps.last_sync_ts <number> Last attempted application syncronization time.
Shark.sync.apps.last_success_ts <number> Last successful application syncronization time.
Shark.sync.apps.error_id <number> Error ID.
Shark.sync.apps.state <string> Synchronization status. Values: SYNC_INITIALIZING, SYNC_FAILED, SYNC_SUCCEEDED, SYNC_DISABLED, SYNC_NA
Shark.ipaddr <string> Shark IP address.

Sharks: Ping Shark

Ping a Shark by IP address.

GET https://{device}/api/profiler/1.3/sharks/{shark_ip}/ping
Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

Sharks: Disable Sharks polling

Disables data polling from Sharks.

POST https://{device}/api/profiler/1.3/sharks/sync/disable
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "ipaddr": string
  }
]

Example:
[
  {
    "ipaddr": "10.99.16.252"
  }, 
  {
    "ipaddr": "10.99.15.252"
  }, 
  {
    "ipaddr": "10.99.14.252"
  }
]
Property Name Type Description Notes
SharkIPAddrs <array of <object>> IP addresses object representing the list of all Sharks.
SharkIPAddrs[SharkIPAddr] <object> IP address collection object representing the list of all Sharks. Optional
SharkIPAddrs[SharkIPAddr].ipaddr <string> IP address representing a Shark.
Response Body

On success, the server does not provide any body in the responses.

Sharks: List Sharks

Get a list of Sharks and their application configuration data.

GET https://{device}/api/profiler/1.3/sharks
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "sync": {
      "apps": {
        "enabled": string,
        "error_text": string,
        "last_sync_ts": number,
        "last_success_ts": number,
        "error_id": number,
        "state": string
      }
    },
    "ipaddr": string
  }
]

Example:
[]
Property Name Type Description Notes
Sharks <array of <object>> List of Sharks and their configuration data.
Sharks[Shark] <object> Shark configuration data. Optional
Sharks[Shark].sync <object> Object representing Shark syncronization information.
Sharks[Shark].sync.apps <object> Object representing Shark application syncronization information.
Sharks[Shark].sync.apps.enabled <string> Flag indicating if application synchronization is enabled on this Shark.
Sharks[Shark].sync.apps.error_text <string> Error description.
Sharks[Shark].sync.apps.last_sync_ts <number> Last attempted application syncronization time.
Sharks[Shark].sync.apps.last_success_ts <number> Last successful application syncronization time.
Sharks[Shark].sync.apps.error_id <number> Error ID.
Sharks[Shark].sync.apps.state <string> Synchronization status. Values: SYNC_INITIALIZING, SYNC_FAILED, SYNC_SUCCEEDED, SYNC_DISABLED, SYNC_NA
Sharks[Shark].ipaddr <string> Shark IP address.

Interfaces: Delete interface

Delete one network interface.

DELETE https://{device}/api/profiler/1.3/interfaces/{ip:ifindex}
Authorization

This request requires authorization.

Response Body

On success, the server does not provide any body in the responses.

Interfaces: Update interfaces

Update network interfaces (fields that can be update: label, inbound speed, outbound speed).

PUT https://{device}/api/profiler/1.3/interfaces
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
[
  {
    "user_inbound_speed": number,
    "ipaddr": string,
    "label": string,
    "user_outbound_speed": number,
    "ifindex": number
  }
]

Example:
[
  {
    "ifindex": 2, 
    "user_outbound_speed": 44153724, 
    "ipaddr": "10.2.3.5", 
    "user_inbound_speed": 140736208929648, 
    "label": "hsdgs"
  }, 
  {
    "ifindex": 3, 
    "user_outbound_speed": 44153724, 
    "ipaddr": "10.2.3.5", 
    "user_inbound_speed": 140736208929648, 
    "label": "jhgvas"
  }
]
Property Name Type Description Notes
CInterfaceUpdateDefs <array of <object>> List of update interfaces.
CInterfaceUpdateDefs
[CInterfaceUpdateDef]
<object> object representing update interface. Optional
CInterfaceUpdateDefs
[CInterfaceUpdateDef].
user_inbound_speed
<number> update interface's inbound speed declared by the user. Optional
CInterfaceUpdateDefs
[CInterfaceUpdateDef].ipaddr
<string> update interface's IP address.
CInterfaceUpdateDefs
[CInterfaceUpdateDef].label
<string> update interface's label.
CInterfaceUpdateDefs
[CInterfaceUpdateDef].
user_outbound_speed
<number> update interface's outbound speed declared by the user. Optional
CInterfaceUpdateDefs
[CInterfaceUpdateDef].ifindex
<number> update interface's index.
Response Body

On success, the server does not provide any body in the responses.

Interfaces: Get interface

Get one network interface.

GET https://{device}/api/profiler/1.3/interfaces/{ip:ifindex}
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "mac": string,
  "id": number,
  "ifdescr": string,
  "outbound_speed": number,
  "user_inbound_speed": number,
  "ipaddr": string,
  "name": string,
  "label": string,
  "user_outbound_speed": number,
  "ifalias": string,
  "inbound_speed": number,
  "ifindex": number
}

Example:
{
  "name": "Device1", 
  "ipaddr": "10.2.3.5", 
  "ifalias": "5", 
  "user_inbound_speed": 140736208929648, 
  "inbound_speed": 140736208929120, 
  "label": "4", 
  "mac": "08:00:2b:01:02:04", 
  "ifdescr": "6", 
  "ifindex": 2, 
  "outbound_speed": 140736208929104, 
  "user_outbound_speed": 44153724, 
  "id": 2
}
Property Name Type Description Notes
CInterfaceDef <object> Object representing an interface.
CInterfaceDef.mac <string> Interface's mac address.
CInterfaceDef.id <number> Interface's ID.
CInterfaceDef.ifdescr <string> Name (ifDescr).
CInterfaceDef.outbound_speed <number> Interface's reported outbound speed. Optional
CInterfaceDef.user_inbound_speed <number> Interface's inbound speed declared by the user. Optional
CInterfaceDef.ipaddr <string> IP address of the interface.
CInterfaceDef.name <string> Device name.
CInterfaceDef.label <string> Interface's label.
CInterfaceDef.user_outbound_speed <number> Interface's outbound speed declared by the user. Optional
CInterfaceDef.ifalias <string> Description (ifAlias).
CInterfaceDef.inbound_speed <number> Interface's reported inbound speed. Optional
CInterfaceDef.ifindex <number> Interface's index.

Interfaces: List interfaces

Get a list of all known network interfaces.

GET https://{device}/api/profiler/1.3/interfaces?offset={number}&ipaddr={string}&limit={number}
Authorization

This request requires authorization.

Parameters
Property Name Type Description Notes
offset <number> Starting element number. Optional
ipaddr <string> Filter network interfaces by an IP address. Optional
limit <number> Number of rows to be returned. Optional
Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "mac": string,
    "id": number,
    "ifdescr": string,
    "outbound_speed": number,
    "user_inbound_speed": number,
    "ipaddr": string,
    "name": string,
    "label": string,
    "user_outbound_speed": number,
    "ifalias": string,
    "inbound_speed": number,
    "ifindex": number
  }
]

Example:
[
  {
    "name": "Router1", 
    "ipaddr": "10.2.5.5", 
    "ifalias": "5", 
    "user_inbound_speed": 140736208929648, 
    "inbound_speed": 140736208929120, 
    "label": "4", 
    "mac": "08:00:2b:01:02:04", 
    "ifdescr": "6", 
    "ifindex": 2, 
    "outbound_speed": 140736208929104, 
    "user_outbound_speed": 44153724, 
    "id": 3
  }, 
  {
    "name": "Router2", 
    "ipaddr": "10.2.5.5", 
    "ifalias": "5", 
    "user_inbound_speed": 140736208929648, 
    "inbound_speed": 140736208929120, 
    "label": "unique", 
    "mac": "08:00:2b:01:02:05", 
    "ifdescr": "6", 
    "ifindex": 2, 
    "outbound_speed": 140736208929104, 
    "user_outbound_speed": 44153724, 
    "id": 4
  }
]
Property Name Type Description Notes
CInterfaceDefs <array of <object>> List of interfaces.
CInterfaceDefs[CInterfaceDef] <object> Object representing an interface. Optional
CInterfaceDefs[CInterfaceDef].mac <string> Interface's mac address.
CInterfaceDefs[CInterfaceDef].id <number> Interface's ID.
CInterfaceDefs[CInterfaceDef].ifdescr <string> Name (ifDescr).
CInterfaceDefs[CInterfaceDef].
outbound_speed
<number> Interface's reported outbound speed. Optional
CInterfaceDefs[CInterfaceDef].
user_inbound_speed
<number> Interface's inbound speed declared by the user. Optional
CInterfaceDefs[CInterfaceDef].ipaddr <string> IP address of the interface.
CInterfaceDefs[CInterfaceDef].name <string> Device name.
CInterfaceDefs[CInterfaceDef].label <string> Interface's label.
CInterfaceDefs[CInterfaceDef].
user_outbound_speed
<number> Interface's outbound speed declared by the user. Optional
CInterfaceDefs[CInterfaceDef].ifalias <string> Description (ifAlias).
CInterfaceDefs[CInterfaceDef].
inbound_speed
<number> Interface's reported inbound speed. Optional
CInterfaceDefs[CInterfaceDef].ifindex <number> Interface's index.

Reporting: List reports

Get a list of reports with their respective status.

GET https://{device}/api/profiler/1.3/reporting/reports
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "run_time": number,
    "error_text": string,
    "remaining_seconds": number,
    "saved": string,
    "id": number,
    "status": string,
    "percent": number,
    "user_id": number,
    "size": number,
    "name": string,
    "template_id": number
  }
]

Example:
[
  {
    "status": "completed", 
    "user_id": 1, 
    "name": "", 
    "percent": 100, 
    "id": 1000, 
    "remaining_seconds": 0, 
    "run_time": 1352494550, 
    "saved": false, 
    "template_id": 952, 
    "error_text": "", 
    "size": 140
  }, 
  {
    "status": "completed", 
    "user_id": 1, 
    "name": "Host Information Report", 
    "percent": 100, 
    "id": 1001, 
    "remaining_seconds": 0, 
    "run_time": 1352494550, 
    "saved": true, 
    "template_id": 952, 
    "error_text": "", 
    "size": 140
  }
]
Property Name Type Description Notes
ReportInfoList <array of <object>> List of report objects.
ReportInfoList[ReportInfo] <object> Object representing report information. Optional
ReportInfoList[ReportInfo].run_time <number> Time when the report was run (Unix time).
ReportInfoList[ReportInfo].error_text <string> A report can be completed with an error. Error message may provide more detailed info. Optional
ReportInfoList[ReportInfo].
remaining_seconds
<number> Number of seconds remaining to run the report. Even if this number is 0, the report may not yet be completed, so check 'status' to make sure what the status is.
ReportInfoList[ReportInfo].saved <string> Boolean flag indicating if the report was saved.
ReportInfoList[ReportInfo].id <number> ID of the report. To be used in the API.
ReportInfoList[ReportInfo].status <string> Status of the report. Values: completed, running, waiting
ReportInfoList[ReportInfo].percent <number> Progress of the report represented by percentage of report completion.
ReportInfoList[ReportInfo].user_id <number> ID of the user who owns the report.
ReportInfoList[ReportInfo].size <number> Size of the report in kilobytes.
ReportInfoList[ReportInfo].name <string> Name of the report. Could be given by a user or automatically generated by the system. Optional
ReportInfoList[ReportInfo].template_id <number> ID of the template that the report is based on.

Reporting: Get widget

Get one widget from the template section.

GET https://{device}/api/profiler/1.3/reporting/templates/{template_id}/sections/{section_id}/widgets/{widget_id}
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "config": {
    "datasource": string,
    "visualization": string,
    "widget_type": string
  },
  "widget_id": number,
  "criteria": {
    "ports": [
      {
        "port": number,
        "protocol": number,
        "name": string
      }
    ],
    "dscp_app_ports": [
      {
        "port": {
          "port": number,
          "protocol": number,
          "name": string
        },
        "app": {
          "code": string,
          "name": string,
          "tunneled": string
        },
        "dscp": {
          "name": string,
          "code_point": number
        }
      }
    ],
    "services": [
      {
        "name": string,
        "service_id": number
      }
    ],
    "port_groups": [
      {
        "name": string,
        "group_id": number
      }
    ],
    "comparison_time_frame": {
      "data_resolution": string,
      "refresh_interval": string,
      "type": string
    },
    "host_group_pairs": [
      {
        "server": {
          "name": string,
          "group_id": number
        },
        "client": {
          "name": string,
          "group_id": number
        }
      }
    ],
    "wan_group": string,
    "traffic_expression": string,
    "split_direction": string,
    "include_successes": string,
    "include_non_optimized_sites": string,
    "columns": [
      number
    ],
    "application_servers": [
      {
        "app": {
          "code": string,
          "name": string,
          "tunneled": string
        },
        "server": {
          "mac": string,
          "ipaddr": string,
          "name": string
        }
      }
    ],
    "devices": [
      {
        "ipaddr": string,
        "name": string
      }
    ],
    "application_ports": [
      {
        "port": {
          "port": number,
          "protocol": number,
          "name": string
        },
        "app": {
          "code": string,
          "name": string,
          "tunneled": string
        }
      }
    ],
    "include_failures": string,
    "host_pair_ports": [
      {
        "port": {
          "port": number,
          "protocol": number,
          "name": string
        },
        "server": {
          "mac": string,
          "ipaddr": string,
          "name": string
        },
        "client": {
          "mac": string,
          "ipaddr": string,
          "name": string
        }
      }
    ],
    "dscp_interfaces": [
      {
        "interface": {
          "ipaddr": string,
          "name": string,
          "ifindex": number
        },
        "dscp": {
          "name": string,
          "code_point": number
        }
      }
    ],
    "time_frame": {
      "data_resolution": string,
      "refresh_interval": string,
      "type": string
    },
    "service": {
      "name": string,
      "service_id": number
    },
    "severity": number,
    "role": string,
    "event_policies": [
      number
    ],
    "service_locations": [
      {
        "name": string,
        "location_id": string
      }
    ],
    "case_insensitive": string,
    "service_location": {
      "name": string,
      "location_id": string
    },
    "include_backend_segments": string,
    "host_group_type": string,
    "host_pair_app_ports": [
      {
        "port": {
          "port": number,
          "protocol": number,
          "name": string
        },
        "app": {
          "code": string,
          "name": string,
          "tunneled": string
        },
        "server": {
          "mac": string,
          "ipaddr": string,
          "name": string
        },
        "client": {
          "mac": string,
          "ipaddr": string,
          "name": string
        }
      }
    ],
    "users": [
      {
        "name": string
      }
    ],
    "sort_desc": string,
    "sort_column": number,
    "host_group_pair_ports": [
      {
        "port": {
          "port": number,
          "protocol": number,
          "name": string
        },
        "server": {
          "name": string,
          "group_id": number
        },
        "client": {
          "name": string,
          "group_id": number
        }
      }
    ],
    "network_segments": [
      {
        "src": {
          "ipaddr": string,
          "name": string,
          "ifindex": number
        },
        "dst": {
          "ipaddr": string,
          "name": string,
          "ifindex": number
        }
      }
    ],
    "hosts": [
      {
        "mac": string,
        "ipaddr": string,
        "name": string
      }
    ],
    "host_pairs": [
      {
        "server": {
          "mac": string,
          "ipaddr": string,
          "name": string
        },
        "client": {
          "mac": string,
          "ipaddr": string,
          "name": string
        }
      }
    ],
    "protocols": [
      {
        "id": number,
        "name": string
      }
    ],
    "centricity": string,
    "limit": number,
    "interfaces": [
      {
        "ipaddr": string,
        "name": string,
        "ifindex": number
      }
    ],
    "host_groups": [
      {
        "name": string,
        "group_id": number
      }
    ],
    "dscps": [
      {
        "name": string,
        "code_point": number
      }
    ],
    "applications": [
      {
        "code": string,
        "name": string,
        "tunneled": string
      }
    ]
  },
  "title": string,
  "attributes": {
    "pan_zoomable": string,
    "line_scale": string,
    "format_bytes": string,
    "show_images": string,
    "open_nodes": [
      string
    ],
    "line_style": string,
    "layout": string,
    "width": number,
    "height": number,
    "percent_of_total": string,
    "edge_thickness": string,
    "display_host_group_type": string,
    "extend_to_zero": string,
    "collapsible": string,
    "high_threshold": string,
    "n_items": number,
    "colspan": number,
    "low_threshold": string,
    "moveable_nodes": string,
    "orientation": string,
    "modal_links": number
  },
  "user_attributes": {
    "pan_zoomable": string,
    "line_scale": string,
    "format_bytes": string,
    "show_images": string,
    "open_nodes": [
      string
    ],
    "line_style": string,
    "layout": string,
    "width": number,
    "height": number,
    "percent_of_total": string,
    "edge_thickness": string,
    "display_host_group_type": string,
    "extend_to_zero": string,
    "collapsible": string,
    "high_threshold": string,
    "n_items": number,
    "colspan": number,
    "low_threshold": string,
    "moveable_nodes": string,
    "orientation": string,
    "modal_links": number
  },
  "timestamp": string
}

Example:
{
  "title": "VoIP-RTP: Applications", 
  "timestamp": "1383141976.674383", 
  "criteria": {
    "sort_column": 33, 
    "traffic_expression": "", 
    "centricity": "host", 
    "limit": 100, 
    "columns": [
      17, 
      33, 
      34, 
      757, 
      766, 
      781, 
      803
    ], 
    "time_frame": {
      "data_resolution": "15mins", 
      "type": "last_hour", 
      "refresh_interval": "15mins"
    }
  }, 
  "attributes": {
    "format_bytes": "UI_PREF", 
    "colspan": 2, 
    "n_items": 20
  }, 
  "config": {
    "widget_type": "APPS", 
    "visualization": "TABLE", 
    "datasource": "TRAFFIC"
  }, 
  "widget_id": 1
}
Property Name Type Description Notes
TMWidget <object> Widget specification.
TMWidget.config <object> Widget configuration: data source type, widget type, and visualization type.
TMWidget.config.datasource <string> Data source type. Values: TRAFFIC, WAN, SERVICE, EVENTS, ACTIVE_DIRECTORY
TMWidget.config.visualization <string> Visualization type. Values: TABLE, PIE, BAR, LINE, CONN_GRAPH, TREE_TABLE, INVISIBLE
TMWidget.config.widget_type <string> Widget type. Values: TRAFFIC_OVERALL, TRAFFIC_OVERALL_CRTT, HOSTS, PEER_HOSTS, PEER_HOST_GROUPS, HOST_PAIRS_PORTS, HOST_PAIRS_APP_PORTS, HOST_PAIRS, HOST_GROUPS, HOST_GROUP_PAIRS, HOST_GROUP_PAIR_PORTS, APPS, APP_PORTS, SERVER_APPS, PORTS, PORT_GROUPS, PROTOCOLS, DEVICES, INTERFACES, NETWORK_SEGMENTS, DSCPS, DSCP_APP_PORTS, DSCP_IFACES, CURRENT_EVENTS, UNACKED_EVENTS, ACTIVE_DIRECTORY, SERVICE_HEALTH, LOCATION_HEALTH, SERVICE_HEALTH_MAP, LOCATION_HEALTH_MAP
TMWidget.widget_id <number> Internal widget ID within a dashboard. Optional
TMWidget.criteria <object> Query criteria for the widget.
TMWidget.criteria.ports <array of <object>> Watched ports. Optional
TMWidget.criteria.ports[CProtoPort] <object> One CProtoPort object. Optional
TMWidget.criteria.ports[CProtoPort].port <number> Port specification. Optional
TMWidget.criteria.ports[CProtoPort].
protocol
<number> Protocol specification. Optional
TMWidget.criteria.ports[CProtoPort].name <string> Protocol + port combination name. Optional
TMWidget.criteria.dscp_app_ports <array of <object>> Watched combinations of DSCPs, applications, and ports. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort]
<object> One CDSCPAppPort object. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].port
<object> Port specification.
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].port.port
<number> Port specification. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].port.protocol
<number> Protocol specification. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].port.name
<string> Protocol + port combination name. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].app
<object> Application specification.
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].app.code
<string> Application code. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].app.name
<string> Application name. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].app.tunneled
<string> Flag: is the application tunneled. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].dscp
<object> DSCP specification.
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].dscp.name
<string> DSCP name. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].dscp.code_point
<number> DSCP code point. Optional
TMWidget.criteria.services <array of <object>> Watched services. Optional
TMWidget.criteria.services[CService] <object> One CService object. Optional
TMWidget.criteria.services[CService].
name
<string> Service name.
TMWidget.criteria.services[CService].
service_id
<number> Service ID. Optional
TMWidget.criteria.port_groups <array of <object>> Watched port groups. Optional
TMWidget.criteria.port_groups
[CPortGroup]
<object> One CPortGroup object. Optional
TMWidget.criteria.port_groups
[CPortGroup].name
<string> Name of the port group. Optional
TMWidget.criteria.port_groups
[CPortGroup].group_id
<number> ID of the port group. Optional
TMWidget.criteria.comparison_time_frame <object> Alternative time frame specification to be used in a comparison widget. Optional
TMWidget.criteria.comparison_time_frame.
data_resolution
<string> Report data resolution. It can be one of: 1min, 15min, hour, 6hour, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
TMWidget.criteria.comparison_time_frame.
refresh_interval
<string> Report refresh interval. It can be one of: min, 15mins, hour, 6hours, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
TMWidget.criteria.comparison_time_frame.
type
<string> Type of time frame. Can be one of: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month. Optional; Values: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month
TMWidget.criteria.host_group_pairs <array of <object>> Watched group pairs. Optional
TMWidget.criteria.host_group_pairs
[CHostGroupPair]
<object> One CHostGroupPair object. Optional
TMWidget.criteria.host_group_pairs
[CHostGroupPair].server
<object> Server host group specification.
TMWidget.criteria.host_group_pairs
[CHostGroupPair].server.name
<string> Host group name. Optional
TMWidget.criteria.host_group_pairs
[CHostGroupPair].server.group_id
<number> Host group ID. Optional
TMWidget.criteria.host_group_pairs
[CHostGroupPair].client
<object> Client host group specification.
TMWidget.criteria.host_group_pairs
[CHostGroupPair].client.name
<string> Host group name. Optional
TMWidget.criteria.host_group_pairs
[CHostGroupPair].client.group_id
<number> Host group ID. Optional
TMWidget.criteria.wan_group <string> WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'. Optional
TMWidget.criteria.traffic_expression <string> Traffic expression. Optional
TMWidget.criteria.split_direction <string> Split inbound/outbound or received/transmitted data. Optional
TMWidget.criteria.include_successes <string> Include successful requests in active directory report. Optional
TMWidget.criteria.
include_non_optimized_sites
<string> Flag indicating whether to include WAN non optimized sites. Optional
TMWidget.criteria.columns <array of <number>> List of column ID. Optional
TMWidget.criteria.columns[item] <number> Column ID. Optional
TMWidget.criteria.application_servers <array of <object>> Watched combinations of applications and servers. Optional
TMWidget.criteria.application_servers
[CApplicationServer]
<object> One CApplicationServer object. Optional
TMWidget.criteria.application_servers
[CApplicationServer].app
<object> Application specification.
TMWidget.criteria.application_servers
[CApplicationServer].app.code
<string> Application code. Optional
TMWidget.criteria.application_servers
[CApplicationServer].app.name
<string> Application name. Optional
TMWidget.criteria.application_servers
[CApplicationServer].app.tunneled
<string> Flag: is the application tunneled. Optional
TMWidget.criteria.application_servers
[CApplicationServer].server
<object> Server specification.
TMWidget.criteria.application_servers
[CApplicationServer].server.mac
<string> Host MAC address. Optional
TMWidget.criteria.application_servers
[CApplicationServer].server.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.application_servers
[CApplicationServer].server.name
<string> Host name. Optional
TMWidget.criteria.devices <array of <object>> Watched devices. Optional
TMWidget.criteria.devices[CDevice] <object> One CDevice object. Optional
TMWidget.criteria.devices[CDevice].
ipaddr
<string> Device IP address. Optional
TMWidget.criteria.devices[CDevice].name <string> Device name. Optional
TMWidget.criteria.application_ports <array of <object>> Watched combinations of applications and ports. Optional
TMWidget.criteria.application_ports
[CApplicationPort]
<object> One CApplicationPort object. Optional
TMWidget.criteria.application_ports
[CApplicationPort].port
<object> Port specification.
TMWidget.criteria.application_ports
[CApplicationPort].port.port
<number> Port specification. Optional
TMWidget.criteria.application_ports
[CApplicationPort].port.protocol
<number> Protocol specification. Optional
TMWidget.criteria.application_ports
[CApplicationPort].port.name
<string> Protocol + port combination name. Optional
TMWidget.criteria.application_ports
[CApplicationPort].app
<object> Application specification.
TMWidget.criteria.application_ports
[CApplicationPort].app.code
<string> Application code. Optional
TMWidget.criteria.application_ports
[CApplicationPort].app.name
<string> Application name. Optional
TMWidget.criteria.application_ports
[CApplicationPort].app.tunneled
<string> Flag: is the application tunneled. Optional
TMWidget.criteria.include_failures <string> Include failed requests in active directory report. Optional
TMWidget.criteria.host_pair_ports <array of <object>> Watched combinations of host pairs and ports. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort]
<object> One CHostPairPort object. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].port
<object> Port specification.
TMWidget.criteria.host_pair_ports
[CHostPairPort].port.port
<number> Port specification. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].port.protocol
<number> Protocol specification. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].port.name
<string> Protocol + port combination name. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].server
<object> Server host specification.
TMWidget.criteria.host_pair_ports
[CHostPairPort].server.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].server.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].server.name
<string> Host name. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].client
<object> Client host specification.
TMWidget.criteria.host_pair_ports
[CHostPairPort].client.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].client.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].client.name
<string> Host name. Optional
TMWidget.criteria.dscp_interfaces <array of <object>> Watched combinations of DSCPs and interfaces. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface]
<object> One CDSCPInterface object. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].interface
<object> Interface specification.
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].interface.ipaddr
<string> Interface IP address. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].interface.name
<string> Interface name. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].interface.ifindex
<number> Interface index. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].dscp
<object> DSCP specification.
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].dscp.name
<string> DSCP name. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].dscp.code_point
<number> DSCP code point. Optional
TMWidget.criteria.time_frame <object> Widget time frame specification. Optional
TMWidget.criteria.time_frame.
data_resolution
<string> Report data resolution. It can be one of: 1min, 15min, hour, 6hour, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
TMWidget.criteria.time_frame.
refresh_interval
<string> Report refresh interval. It can be one of: min, 15mins, hour, 6hours, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
TMWidget.criteria.time_frame.type <string> Type of time frame. Can be one of: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month. Optional; Values: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month
TMWidget.criteria.service <object> Watched service. Optional
TMWidget.criteria.service.name <string> Service name.
TMWidget.criteria.service.service_id <number> Service ID. Optional
TMWidget.criteria.severity <number> Minimum severity filter for an event report. Optional
TMWidget.criteria.role <string> Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER'). Optional; Values: CLIENT_SERVER, CLIENT, SERVER
TMWidget.criteria.event_policies <array of <number>> List of event policies to include in an event report. Optional
TMWidget.criteria.event_policies[item] <number> Event policy ID. Optional
TMWidget.criteria.service_locations <array of <object>> Watched service locations. Optional
TMWidget.criteria.service_locations
[CServiceLocation]
<object> One CServiceLocation object. Optional
TMWidget.criteria.service_locations
[CServiceLocation].name
<string> Service location name.
TMWidget.criteria.service_locations
[CServiceLocation].location_id
<string> Service location ID. Optional
TMWidget.criteria.case_insensitive <string> Case-insensitive usernames in an identity report. Optional
TMWidget.criteria.service_location <object> Watched service location. Optional
TMWidget.criteria.service_location.name <string> Service location name.
TMWidget.criteria.service_location.
location_id
<string> Service location ID. Optional
TMWidget.criteria.
include_backend_segments
<string> Flag indicating whether to include back-end segments. Optional
TMWidget.criteria.host_group_type <string> Host group type used. Optional
TMWidget.criteria.host_pair_app_ports <array of <object>> Watched combinations of host pairs, applications, and ports. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort]
<object> One CHostPairAppPort object. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].port
<object> Port specification.
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].port.port
<number> Port specification. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].port.protocol
<number> Protocol specification. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].port.name
<string> Protocol + port combination name. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].app
<object> Application specification.
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].app.code
<string> Application code. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].app.name
<string> Application name. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].app.tunneled
<string> Flag: is the application tunneled. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].server
<object> Server host specification.
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].server.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].server.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].server.name
<string> Host name. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].client
<object> Client host specification.
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].client.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].client.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].client.name
<string> Host name. Optional
TMWidget.criteria.users <array of <object>> Watched users. Optional
TMWidget.criteria.users[CUser] <object> One CUser object. Optional
TMWidget.criteria.users[CUser].name <string> Active Directory user name.
TMWidget.criteria.sort_desc <string> Sorting direction (true for descending, false for ascending). Optional
TMWidget.criteria.sort_column <number> Sorting column ID. Optional
TMWidget.criteria.host_group_pair_ports <array of <object>> Watched combinations of host groups pairs and ports. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort]
<object> One CHostGroupPairPort object. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].port
<object> Port specification.
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].port.port
<number> Port specification. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].port.protocol
<number> Protocol specification. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].port.name
<string> Protocol + port combination name. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].server
<object> Server host group specification.
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].server.name
<string> Host group name. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].server.group_id
<number> Host group ID. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].client
<object> Client host group specification.
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].client.name
<string> Host group name. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].client.group_id
<number> Host group ID. Optional
TMWidget.criteria.network_segments <array of <object>> Watched network segments. Optional
TMWidget.criteria.network_segments
[CNetworkSegment]
<object> One CNetworkSegment object. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].src
<object> Segment source.
TMWidget.criteria.network_segments
[CNetworkSegment].src.ipaddr
<string> Interface IP address. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].src.name
<string> Interface name. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].src.ifindex
<number> Interface index. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].dst
<object> Segment destination.
TMWidget.criteria.network_segments
[CNetworkSegment].dst.ipaddr
<string> Interface IP address. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].dst.name
<string> Interface name. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].dst.ifindex
<number> Interface index. Optional
TMWidget.criteria.hosts <array of <object>> Watched hosts. Optional
TMWidget.criteria.hosts[CHost] <object> One CHost object. Optional
TMWidget.criteria.hosts[CHost].mac <string> Host MAC address. Optional
TMWidget.criteria.hosts[CHost].ipaddr <string> Host IP address. Optional
TMWidget.criteria.hosts[CHost].name <string> Host name. Optional
TMWidget.criteria.host_pairs <array of <object>> Watched host pairs. Optional
TMWidget.criteria.host_pairs[CHostPair] <object> One CHostPair object. Optional
TMWidget.criteria.host_pairs[CHostPair].
server
<object> Specification of the server host.
TMWidget.criteria.host_pairs[CHostPair].
server.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pairs[CHostPair].
server.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pairs[CHostPair].
server.name
<string> Host name. Optional
TMWidget.criteria.host_pairs[CHostPair].
client
<object> Specification of the client host.
TMWidget.criteria.host_pairs[CHostPair].
client.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pairs[CHostPair].
client.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pairs[CHostPair].
client.name
<string> Host name. Optional
TMWidget.criteria.protocols <array of <object>> Watched protocols. Optional
TMWidget.criteria.protocols[CProtocol] <object> Object representing Protocol information. Optional
TMWidget.criteria.protocols[CProtocol].
id
<number> ID of the Protocol. Optional
TMWidget.criteria.protocols[CProtocol].
name
<string> Name of the Protocol. Optional
TMWidget.criteria.centricity <string> Centricity used to run the report. Optional
TMWidget.criteria.limit <number> Maximum number of data rows in the report for the widget. Optional
TMWidget.criteria.interfaces <array of <object>> Watched interfaces. Optional
TMWidget.criteria.interfaces[CInterface] <object> One CInterface object. Optional
TMWidget.criteria.interfaces[CInterface].
ipaddr
<string> Interface IP address. Optional
TMWidget.criteria.interfaces[CInterface].
name
<string> Interface name. Optional
TMWidget.criteria.interfaces[CInterface].
ifindex
<number> Interface index. Optional
TMWidget.criteria.host_groups <array of <object>> Watched host groups. Optional
TMWidget.criteria.host_groups
[CHostGroup]
<object> One CHostGroup object. Optional
TMWidget.criteria.host_groups
[CHostGroup].name
<string> Host group name. Optional
TMWidget.criteria.host_groups
[CHostGroup].group_id
<number> Host group ID. Optional
TMWidget.criteria.dscps <array of <object>> Watched DSCPs. Optional
TMWidget.criteria.dscps[CDSCP] <object> One CDSCP object. Optional
TMWidget.criteria.dscps[CDSCP].name <string> DSCP name. Optional
TMWidget.criteria.dscps[CDSCP].
code_point
<number> DSCP code point. Optional
TMWidget.criteria.applications <array of <object>> Watched applications. Optional
TMWidget.criteria.applications
[CApplication]
<object> One CApplication object. Optional
TMWidget.criteria.applications
[CApplication].code
<string> Application code. Optional
TMWidget.criteria.applications
[CApplication].name
<string> Application name. Optional
TMWidget.criteria.applications
[CApplication].tunneled
<string> Flag: is the application tunneled. Optional
TMWidget.title <string> Widget title.
TMWidget.attributes <object> Widget common attributes. Optional
TMWidget.attributes.pan_zoomable <string> Flag making the graph interactive. Optional
TMWidget.attributes.line_scale <string> Line scale for a line chart (can be: LINEAR, LOG). Optional; Values: LINEAR, LOG
TMWidget.attributes.format_bytes <string> What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF). Optional; Values: BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF
TMWidget.attributes.show_images <string> Flag showing images in a connection graph. Optional
TMWidget.attributes.open_nodes <array of <string>> List of open node IDs for a tree widget. Optional
TMWidget.attributes.open_nodes[item] <string> ID of an expanded nodes in a tree widget. Optional
TMWidget.attributes.line_style <string> Line chart style (can be: LINE, STACKED). Optional; Values: LINE, STACKED
TMWidget.attributes.layout <string> Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC). Optional; Values: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC
TMWidget.attributes.width <number> Widget width. Optional
TMWidget.attributes.height <number> Widget height. Optional
TMWidget.attributes.percent_of_total <string> Flag including the 'total' item in a pie chart. Optional
TMWidget.attributes.edge_thickness <string> Widget edge thickness. Optional
TMWidget.attributes.
display_host_group_type
<string> Default host grouping type for displaying grouped hosts. Optional
TMWidget.attributes.extend_to_zero <string> Flag: extending the Y-axis to zero. Optional
TMWidget.attributes.collapsible <string> Flag indicating if the widget is collapsible. Optional
TMWidget.attributes.high_threshold <string> High threshold on the chart (in bytes). Optional
TMWidget.attributes.n_items <number> Maximum number of items shown. Optional
TMWidget.attributes.colspan <number> How many columns the widget occupies in layout. Optional
TMWidget.attributes.low_threshold <string> Low threshold on the chart (in bytes). Optional
TMWidget.attributes.moveable_nodes <string> Flag allowing the user to reposition nodes in a connection graph. Optional
TMWidget.attributes.orientation <string> Bar chart orientation (can be: VERTICAL, HORIZONTAL). Optional; Values: VERTICAL, HORIZONTAL
TMWidget.attributes.modal_links <number> Flag adding modal links on a widget. Optional
TMWidget.user_attributes <object> User-specific attributes. Optional
TMWidget.user_attributes.pan_zoomable <string> Flag making the graph interactive. Optional
TMWidget.user_attributes.line_scale <string> Line scale for a line chart (can be: LINEAR, LOG). Optional; Values: LINEAR, LOG
TMWidget.user_attributes.format_bytes <string> What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF). Optional; Values: BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF
TMWidget.user_attributes.show_images <string> Flag showing images in a connection graph. Optional
TMWidget.user_attributes.open_nodes <array of <string>> List of open node IDs for a tree widget. Optional
TMWidget.user_attributes.open_nodes
[item]
<string> ID of an expanded nodes in a tree widget. Optional
TMWidget.user_attributes.line_style <string> Line chart style (can be: LINE, STACKED). Optional; Values: LINE, STACKED
TMWidget.user_attributes.layout <string> Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC). Optional; Values: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC
TMWidget.user_attributes.width <number> Widget width. Optional
TMWidget.user_attributes.height <number> Widget height. Optional
TMWidget.user_attributes.
percent_of_total
<string> Flag including the 'total' item in a pie chart. Optional
TMWidget.user_attributes.edge_thickness <string> Widget edge thickness. Optional
TMWidget.user_attributes.
display_host_group_type
<string> Default host grouping type for displaying grouped hosts. Optional
TMWidget.user_attributes.extend_to_zero <string> Flag: extending the Y-axis to zero. Optional
TMWidget.user_attributes.collapsible <string> Flag indicating if the widget is collapsible. Optional
TMWidget.user_attributes.high_threshold <string> High threshold on the chart (in bytes). Optional
TMWidget.user_attributes.n_items <number> Maximum number of items shown. Optional
TMWidget.user_attributes.colspan <number> How many columns the widget occupies in layout. Optional
TMWidget.user_attributes.low_threshold <string> Low threshold on the chart (in bytes). Optional
TMWidget.user_attributes.moveable_nodes <string> Flag allowing the user to reposition nodes in a connection graph. Optional
TMWidget.user_attributes.orientation <string> Bar chart orientation (can be: VERTICAL, HORIZONTAL). Optional; Values: VERTICAL, HORIZONTAL
TMWidget.user_attributes.modal_links <number> Flag adding modal links on a widget. Optional
TMWidget.timestamp <string> Widget time stamp specification. Optional

Reporting: Get factory widget

Get configuration of a stock widget.

GET https://{device}/api/profiler/1.3/reporting/templates/widgets/{widget_id}
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
{
  "config": {
    "datasource": string,
    "visualization": string,
    "widget_type": string
  },
  "widget_id": number,
  "criteria": {
    "ports": [
      {
        "port": number,
        "protocol": number,
        "name": string
      }
    ],
    "dscp_app_ports": [
      {
        "port": {
          "port": number,
          "protocol": number,
          "name": string
        },
        "app": {
          "code": string,
          "name": string,
          "tunneled": string
        },
        "dscp": {
          "name": string,
          "code_point": number
        }
      }
    ],
    "services": [
      {
        "name": string,
        "service_id": number
      }
    ],
    "port_groups": [
      {
        "name": string,
        "group_id": number
      }
    ],
    "comparison_time_frame": {
      "data_resolution": string,
      "refresh_interval": string,
      "type": string
    },
    "host_group_pairs": [
      {
        "server": {
          "name": string,
          "group_id": number
        },
        "client": {
          "name": string,
          "group_id": number
        }
      }
    ],
    "wan_group": string,
    "traffic_expression": string,
    "split_direction": string,
    "include_successes": string,
    "include_non_optimized_sites": string,
    "columns": [
      number
    ],
    "application_servers": [
      {
        "app": {
          "code": string,
          "name": string,
          "tunneled": string
        },
        "server": {
          "mac": string,
          "ipaddr": string,
          "name": string
        }
      }
    ],
    "devices": [
      {
        "ipaddr": string,
        "name": string
      }
    ],
    "application_ports": [
      {
        "port": {
          "port": number,
          "protocol": number,
          "name": string
        },
        "app": {
          "code": string,
          "name": string,
          "tunneled": string
        }
      }
    ],
    "include_failures": string,
    "host_pair_ports": [
      {
        "port": {
          "port": number,
          "protocol": number,
          "name": string
        },
        "server": {
          "mac": string,
          "ipaddr": string,
          "name": string
        },
        "client": {
          "mac": string,
          "ipaddr": string,
          "name": string
        }
      }
    ],
    "dscp_interfaces": [
      {
        "interface": {
          "ipaddr": string,
          "name": string,
          "ifindex": number
        },
        "dscp": {
          "name": string,
          "code_point": number
        }
      }
    ],
    "time_frame": {
      "data_resolution": string,
      "refresh_interval": string,
      "type": string
    },
    "service": {
      "name": string,
      "service_id": number
    },
    "severity": number,
    "role": string,
    "event_policies": [
      number
    ],
    "service_locations": [
      {
        "name": string,
        "location_id": string
      }
    ],
    "case_insensitive": string,
    "service_location": {
      "name": string,
      "location_id": string
    },
    "include_backend_segments": string,
    "host_group_type": string,
    "host_pair_app_ports": [
      {
        "port": {
          "port": number,
          "protocol": number,
          "name": string
        },
        "app": {
          "code": string,
          "name": string,
          "tunneled": string
        },
        "server": {
          "mac": string,
          "ipaddr": string,
          "name": string
        },
        "client": {
          "mac": string,
          "ipaddr": string,
          "name": string
        }
      }
    ],
    "users": [
      {
        "name": string
      }
    ],
    "sort_desc": string,
    "sort_column": number,
    "host_group_pair_ports": [
      {
        "port": {
          "port": number,
          "protocol": number,
          "name": string
        },
        "server": {
          "name": string,
          "group_id": number
        },
        "client": {
          "name": string,
          "group_id": number
        }
      }
    ],
    "network_segments": [
      {
        "src": {
          "ipaddr": string,
          "name": string,
          "ifindex": number
        },
        "dst": {
          "ipaddr": string,
          "name": string,
          "ifindex": number
        }
      }
    ],
    "hosts": [
      {
        "mac": string,
        "ipaddr": string,
        "name": string
      }
    ],
    "host_pairs": [
      {
        "server": {
          "mac": string,
          "ipaddr": string,
          "name": string
        },
        "client": {
          "mac": string,
          "ipaddr": string,
          "name": string
        }
      }
    ],
    "protocols": [
      {
        "id": number,
        "name": string
      }
    ],
    "centricity": string,
    "limit": number,
    "interfaces": [
      {
        "ipaddr": string,
        "name": string,
        "ifindex": number
      }
    ],
    "host_groups": [
      {
        "name": string,
        "group_id": number
      }
    ],
    "dscps": [
      {
        "name": string,
        "code_point": number
      }
    ],
    "applications": [
      {
        "code": string,
        "name": string,
        "tunneled": string
      }
    ]
  },
  "title": string,
  "attributes": {
    "pan_zoomable": string,
    "line_scale": string,
    "format_bytes": string,
    "show_images": string,
    "open_nodes": [
      string
    ],
    "line_style": string,
    "layout": string,
    "width": number,
    "height": number,
    "percent_of_total": string,
    "edge_thickness": string,
    "display_host_group_type": string,
    "extend_to_zero": string,
    "collapsible": string,
    "high_threshold": string,
    "n_items": number,
    "colspan": number,
    "low_threshold": string,
    "moveable_nodes": string,
    "orientation": string,
    "modal_links": number
  },
  "user_attributes": {
    "pan_zoomable": string,
    "line_scale": string,
    "format_bytes": string,
    "show_images": string,
    "open_nodes": [
      string
    ],
    "line_style": string,
    "layout": string,
    "width": number,
    "height": number,
    "percent_of_total": string,
    "edge_thickness": string,
    "display_host_group_type": string,
    "extend_to_zero": string,
    "collapsible": string,
    "high_threshold": string,
    "n_items": number,
    "colspan": number,
    "low_threshold": string,
    "moveable_nodes": string,
    "orientation": string,
    "modal_links": number
  },
  "timestamp": string
}

Example:
{
  "title": "VoIP-RTP: Applications", 
  "timestamp": "1383141976.674383", 
  "criteria": {
    "sort_column": 33, 
    "traffic_expression": "", 
    "centricity": "host", 
    "limit": 100, 
    "columns": [
      17, 
      33, 
      34, 
      757, 
      766, 
      781, 
      803
    ], 
    "time_frame": {
      "data_resolution": "15mins", 
      "type": "last_hour", 
      "refresh_interval": "15mins"
    }
  }, 
  "attributes": {
    "format_bytes": "UI_PREF", 
    "colspan": 2, 
    "n_items": 20
  }, 
  "config": {
    "widget_type": "APPS", 
    "visualization": "TABLE", 
    "datasource": "TRAFFIC"
  }, 
  "widget_id": 1
}
Property Name Type Description Notes
TMWidget <object> Widget specification.
TMWidget.config <object> Widget configuration: data source type, widget type, and visualization type.
TMWidget.config.datasource <string> Data source type. Values: TRAFFIC, WAN, SERVICE, EVENTS, ACTIVE_DIRECTORY
TMWidget.config.visualization <string> Visualization type. Values: TABLE, PIE, BAR, LINE, CONN_GRAPH, TREE_TABLE, INVISIBLE
TMWidget.config.widget_type <string> Widget type. Values: TRAFFIC_OVERALL, TRAFFIC_OVERALL_CRTT, HOSTS, PEER_HOSTS, PEER_HOST_GROUPS, HOST_PAIRS_PORTS, HOST_PAIRS_APP_PORTS, HOST_PAIRS, HOST_GROUPS, HOST_GROUP_PAIRS, HOST_GROUP_PAIR_PORTS, APPS, APP_PORTS, SERVER_APPS, PORTS, PORT_GROUPS, PROTOCOLS, DEVICES, INTERFACES, NETWORK_SEGMENTS, DSCPS, DSCP_APP_PORTS, DSCP_IFACES, CURRENT_EVENTS, UNACKED_EVENTS, ACTIVE_DIRECTORY, SERVICE_HEALTH, LOCATION_HEALTH, SERVICE_HEALTH_MAP, LOCATION_HEALTH_MAP
TMWidget.widget_id <number> Internal widget ID within a dashboard. Optional
TMWidget.criteria <object> Query criteria for the widget.
TMWidget.criteria.ports <array of <object>> Watched ports. Optional
TMWidget.criteria.ports[CProtoPort] <object> One CProtoPort object. Optional
TMWidget.criteria.ports[CProtoPort].port <number> Port specification. Optional
TMWidget.criteria.ports[CProtoPort].
protocol
<number> Protocol specification. Optional
TMWidget.criteria.ports[CProtoPort].name <string> Protocol + port combination name. Optional
TMWidget.criteria.dscp_app_ports <array of <object>> Watched combinations of DSCPs, applications, and ports. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort]
<object> One CDSCPAppPort object. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].port
<object> Port specification.
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].port.port
<number> Port specification. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].port.protocol
<number> Protocol specification. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].port.name
<string> Protocol + port combination name. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].app
<object> Application specification.
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].app.code
<string> Application code. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].app.name
<string> Application name. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].app.tunneled
<string> Flag: is the application tunneled. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].dscp
<object> DSCP specification.
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].dscp.name
<string> DSCP name. Optional
TMWidget.criteria.dscp_app_ports
[CDSCPAppPort].dscp.code_point
<number> DSCP code point. Optional
TMWidget.criteria.services <array of <object>> Watched services. Optional
TMWidget.criteria.services[CService] <object> One CService object. Optional
TMWidget.criteria.services[CService].
name
<string> Service name.
TMWidget.criteria.services[CService].
service_id
<number> Service ID. Optional
TMWidget.criteria.port_groups <array of <object>> Watched port groups. Optional
TMWidget.criteria.port_groups
[CPortGroup]
<object> One CPortGroup object. Optional
TMWidget.criteria.port_groups
[CPortGroup].name
<string> Name of the port group. Optional
TMWidget.criteria.port_groups
[CPortGroup].group_id
<number> ID of the port group. Optional
TMWidget.criteria.comparison_time_frame <object> Alternative time frame specification to be used in a comparison widget. Optional
TMWidget.criteria.comparison_time_frame.
data_resolution
<string> Report data resolution. It can be one of: 1min, 15min, hour, 6hour, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
TMWidget.criteria.comparison_time_frame.
refresh_interval
<string> Report refresh interval. It can be one of: min, 15mins, hour, 6hours, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
TMWidget.criteria.comparison_time_frame.
type
<string> Type of time frame. Can be one of: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month. Optional; Values: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month
TMWidget.criteria.host_group_pairs <array of <object>> Watched group pairs. Optional
TMWidget.criteria.host_group_pairs
[CHostGroupPair]
<object> One CHostGroupPair object. Optional
TMWidget.criteria.host_group_pairs
[CHostGroupPair].server
<object> Server host group specification.
TMWidget.criteria.host_group_pairs
[CHostGroupPair].server.name
<string> Host group name. Optional
TMWidget.criteria.host_group_pairs
[CHostGroupPair].server.group_id
<number> Host group ID. Optional
TMWidget.criteria.host_group_pairs
[CHostGroupPair].client
<object> Client host group specification.
TMWidget.criteria.host_group_pairs
[CHostGroupPair].client.name
<string> Host group name. Optional
TMWidget.criteria.host_group_pairs
[CHostGroupPair].client.group_id
<number> Host group ID. Optional
TMWidget.criteria.wan_group <string> WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'. Optional
TMWidget.criteria.traffic_expression <string> Traffic expression. Optional
TMWidget.criteria.split_direction <string> Split inbound/outbound or received/transmitted data. Optional
TMWidget.criteria.include_successes <string> Include successful requests in active directory report. Optional
TMWidget.criteria.
include_non_optimized_sites
<string> Flag indicating whether to include WAN non optimized sites. Optional
TMWidget.criteria.columns <array of <number>> List of column ID. Optional
TMWidget.criteria.columns[item] <number> Column ID. Optional
TMWidget.criteria.application_servers <array of <object>> Watched combinations of applications and servers. Optional
TMWidget.criteria.application_servers
[CApplicationServer]
<object> One CApplicationServer object. Optional
TMWidget.criteria.application_servers
[CApplicationServer].app
<object> Application specification.
TMWidget.criteria.application_servers
[CApplicationServer].app.code
<string> Application code. Optional
TMWidget.criteria.application_servers
[CApplicationServer].app.name
<string> Application name. Optional
TMWidget.criteria.application_servers
[CApplicationServer].app.tunneled
<string> Flag: is the application tunneled. Optional
TMWidget.criteria.application_servers
[CApplicationServer].server
<object> Server specification.
TMWidget.criteria.application_servers
[CApplicationServer].server.mac
<string> Host MAC address. Optional
TMWidget.criteria.application_servers
[CApplicationServer].server.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.application_servers
[CApplicationServer].server.name
<string> Host name. Optional
TMWidget.criteria.devices <array of <object>> Watched devices. Optional
TMWidget.criteria.devices[CDevice] <object> One CDevice object. Optional
TMWidget.criteria.devices[CDevice].
ipaddr
<string> Device IP address. Optional
TMWidget.criteria.devices[CDevice].name <string> Device name. Optional
TMWidget.criteria.application_ports <array of <object>> Watched combinations of applications and ports. Optional
TMWidget.criteria.application_ports
[CApplicationPort]
<object> One CApplicationPort object. Optional
TMWidget.criteria.application_ports
[CApplicationPort].port
<object> Port specification.
TMWidget.criteria.application_ports
[CApplicationPort].port.port
<number> Port specification. Optional
TMWidget.criteria.application_ports
[CApplicationPort].port.protocol
<number> Protocol specification. Optional
TMWidget.criteria.application_ports
[CApplicationPort].port.name
<string> Protocol + port combination name. Optional
TMWidget.criteria.application_ports
[CApplicationPort].app
<object> Application specification.
TMWidget.criteria.application_ports
[CApplicationPort].app.code
<string> Application code. Optional
TMWidget.criteria.application_ports
[CApplicationPort].app.name
<string> Application name. Optional
TMWidget.criteria.application_ports
[CApplicationPort].app.tunneled
<string> Flag: is the application tunneled. Optional
TMWidget.criteria.include_failures <string> Include failed requests in active directory report. Optional
TMWidget.criteria.host_pair_ports <array of <object>> Watched combinations of host pairs and ports. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort]
<object> One CHostPairPort object. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].port
<object> Port specification.
TMWidget.criteria.host_pair_ports
[CHostPairPort].port.port
<number> Port specification. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].port.protocol
<number> Protocol specification. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].port.name
<string> Protocol + port combination name. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].server
<object> Server host specification.
TMWidget.criteria.host_pair_ports
[CHostPairPort].server.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].server.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].server.name
<string> Host name. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].client
<object> Client host specification.
TMWidget.criteria.host_pair_ports
[CHostPairPort].client.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].client.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pair_ports
[CHostPairPort].client.name
<string> Host name. Optional
TMWidget.criteria.dscp_interfaces <array of <object>> Watched combinations of DSCPs and interfaces. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface]
<object> One CDSCPInterface object. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].interface
<object> Interface specification.
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].interface.ipaddr
<string> Interface IP address. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].interface.name
<string> Interface name. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].interface.ifindex
<number> Interface index. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].dscp
<object> DSCP specification.
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].dscp.name
<string> DSCP name. Optional
TMWidget.criteria.dscp_interfaces
[CDSCPInterface].dscp.code_point
<number> DSCP code point. Optional
TMWidget.criteria.time_frame <object> Widget time frame specification. Optional
TMWidget.criteria.time_frame.
data_resolution
<string> Report data resolution. It can be one of: 1min, 15min, hour, 6hour, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
TMWidget.criteria.time_frame.
refresh_interval
<string> Report refresh interval. It can be one of: min, 15mins, hour, 6hours, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
TMWidget.criteria.time_frame.type <string> Type of time frame. Can be one of: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month. Optional; Values: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month
TMWidget.criteria.service <object> Watched service. Optional
TMWidget.criteria.service.name <string> Service name.
TMWidget.criteria.service.service_id <number> Service ID. Optional
TMWidget.criteria.severity <number> Minimum severity filter for an event report. Optional
TMWidget.criteria.role <string> Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER'). Optional; Values: CLIENT_SERVER, CLIENT, SERVER
TMWidget.criteria.event_policies <array of <number>> List of event policies to include in an event report. Optional
TMWidget.criteria.event_policies[item] <number> Event policy ID. Optional
TMWidget.criteria.service_locations <array of <object>> Watched service locations. Optional
TMWidget.criteria.service_locations
[CServiceLocation]
<object> One CServiceLocation object. Optional
TMWidget.criteria.service_locations
[CServiceLocation].name
<string> Service location name.
TMWidget.criteria.service_locations
[CServiceLocation].location_id
<string> Service location ID. Optional
TMWidget.criteria.case_insensitive <string> Case-insensitive usernames in an identity report. Optional
TMWidget.criteria.service_location <object> Watched service location. Optional
TMWidget.criteria.service_location.name <string> Service location name.
TMWidget.criteria.service_location.
location_id
<string> Service location ID. Optional
TMWidget.criteria.
include_backend_segments
<string> Flag indicating whether to include back-end segments. Optional
TMWidget.criteria.host_group_type <string> Host group type used. Optional
TMWidget.criteria.host_pair_app_ports <array of <object>> Watched combinations of host pairs, applications, and ports. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort]
<object> One CHostPairAppPort object. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].port
<object> Port specification.
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].port.port
<number> Port specification. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].port.protocol
<number> Protocol specification. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].port.name
<string> Protocol + port combination name. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].app
<object> Application specification.
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].app.code
<string> Application code. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].app.name
<string> Application name. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].app.tunneled
<string> Flag: is the application tunneled. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].server
<object> Server host specification.
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].server.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].server.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].server.name
<string> Host name. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].client
<object> Client host specification.
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].client.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].client.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pair_app_ports
[CHostPairAppPort].client.name
<string> Host name. Optional
TMWidget.criteria.users <array of <object>> Watched users. Optional
TMWidget.criteria.users[CUser] <object> One CUser object. Optional
TMWidget.criteria.users[CUser].name <string> Active Directory user name.
TMWidget.criteria.sort_desc <string> Sorting direction (true for descending, false for ascending). Optional
TMWidget.criteria.sort_column <number> Sorting column ID. Optional
TMWidget.criteria.host_group_pair_ports <array of <object>> Watched combinations of host groups pairs and ports. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort]
<object> One CHostGroupPairPort object. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].port
<object> Port specification.
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].port.port
<number> Port specification. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].port.protocol
<number> Protocol specification. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].port.name
<string> Protocol + port combination name. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].server
<object> Server host group specification.
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].server.name
<string> Host group name. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].server.group_id
<number> Host group ID. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].client
<object> Client host group specification.
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].client.name
<string> Host group name. Optional
TMWidget.criteria.host_group_pair_ports
[CHostGroupPairPort].client.group_id
<number> Host group ID. Optional
TMWidget.criteria.network_segments <array of <object>> Watched network segments. Optional
TMWidget.criteria.network_segments
[CNetworkSegment]
<object> One CNetworkSegment object. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].src
<object> Segment source.
TMWidget.criteria.network_segments
[CNetworkSegment].src.ipaddr
<string> Interface IP address. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].src.name
<string> Interface name. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].src.ifindex
<number> Interface index. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].dst
<object> Segment destination.
TMWidget.criteria.network_segments
[CNetworkSegment].dst.ipaddr
<string> Interface IP address. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].dst.name
<string> Interface name. Optional
TMWidget.criteria.network_segments
[CNetworkSegment].dst.ifindex
<number> Interface index. Optional
TMWidget.criteria.hosts <array of <object>> Watched hosts. Optional
TMWidget.criteria.hosts[CHost] <object> One CHost object. Optional
TMWidget.criteria.hosts[CHost].mac <string> Host MAC address. Optional
TMWidget.criteria.hosts[CHost].ipaddr <string> Host IP address. Optional
TMWidget.criteria.hosts[CHost].name <string> Host name. Optional
TMWidget.criteria.host_pairs <array of <object>> Watched host pairs. Optional
TMWidget.criteria.host_pairs[CHostPair] <object> One CHostPair object. Optional
TMWidget.criteria.host_pairs[CHostPair].
server
<object> Specification of the server host.
TMWidget.criteria.host_pairs[CHostPair].
server.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pairs[CHostPair].
server.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pairs[CHostPair].
server.name
<string> Host name. Optional
TMWidget.criteria.host_pairs[CHostPair].
client
<object> Specification of the client host.
TMWidget.criteria.host_pairs[CHostPair].
client.mac
<string> Host MAC address. Optional
TMWidget.criteria.host_pairs[CHostPair].
client.ipaddr
<string> Host IP address. Optional
TMWidget.criteria.host_pairs[CHostPair].
client.name
<string> Host name. Optional
TMWidget.criteria.protocols <array of <object>> Watched protocols. Optional
TMWidget.criteria.protocols[CProtocol] <object> Object representing Protocol information. Optional
TMWidget.criteria.protocols[CProtocol].
id
<number> ID of the Protocol. Optional
TMWidget.criteria.protocols[CProtocol].
name
<string> Name of the Protocol. Optional
TMWidget.criteria.centricity <string> Centricity used to run the report. Optional
TMWidget.criteria.limit <number> Maximum number of data rows in the report for the widget. Optional
TMWidget.criteria.interfaces <array of <object>> Watched interfaces. Optional
TMWidget.criteria.interfaces[CInterface] <object> One CInterface object. Optional
TMWidget.criteria.interfaces[CInterface].
ipaddr
<string> Interface IP address. Optional
TMWidget.criteria.interfaces[CInterface].
name
<string> Interface name. Optional
TMWidget.criteria.interfaces[CInterface].
ifindex
<number> Interface index. Optional
TMWidget.criteria.host_groups <array of <object>> Watched host groups. Optional
TMWidget.criteria.host_groups
[CHostGroup]
<object> One CHostGroup object. Optional
TMWidget.criteria.host_groups
[CHostGroup].name
<string> Host group name. Optional
TMWidget.criteria.host_groups
[CHostGroup].group_id
<number> Host group ID. Optional
TMWidget.criteria.dscps <array of <object>> Watched DSCPs. Optional
TMWidget.criteria.dscps[CDSCP] <object> One CDSCP object. Optional
TMWidget.criteria.dscps[CDSCP].name <string> DSCP name. Optional
TMWidget.criteria.dscps[CDSCP].
code_point
<number> DSCP code point. Optional
TMWidget.criteria.applications <array of <object>> Watched applications. Optional
TMWidget.criteria.applications
[CApplication]
<object> One CApplication object. Optional
TMWidget.criteria.applications
[CApplication].code
<string> Application code. Optional
TMWidget.criteria.applications
[CApplication].name
<string> Application name. Optional
TMWidget.criteria.applications
[CApplication].tunneled
<string> Flag: is the application tunneled. Optional
TMWidget.title <string> Widget title.
TMWidget.attributes <object> Widget common attributes. Optional
TMWidget.attributes.pan_zoomable <string> Flag making the graph interactive. Optional
TMWidget.attributes.line_scale <string> Line scale for a line chart (can be: LINEAR, LOG). Optional; Values: LINEAR, LOG
TMWidget.attributes.format_bytes <string> What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF). Optional; Values: BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF
TMWidget.attributes.show_images <string> Flag showing images in a connection graph. Optional
TMWidget.attributes.open_nodes <array of <string>> List of open node IDs for a tree widget. Optional
TMWidget.attributes.open_nodes[item] <string> ID of an expanded nodes in a tree widget. Optional
TMWidget.attributes.line_style <string> Line chart style (can be: LINE, STACKED). Optional; Values: LINE, STACKED
TMWidget.attributes.layout <string> Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC). Optional; Values: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC
TMWidget.attributes.width <number> Widget width. Optional
TMWidget.attributes.height <number> Widget height. Optional
TMWidget.attributes.percent_of_total <string> Flag including the 'total' item in a pie chart. Optional
TMWidget.attributes.edge_thickness <string> Widget edge thickness. Optional
TMWidget.attributes.
display_host_group_type
<string> Default host grouping type for displaying grouped hosts. Optional
TMWidget.attributes.extend_to_zero <string> Flag: extending the Y-axis to zero. Optional
TMWidget.attributes.collapsible <string> Flag indicating if the widget is collapsible. Optional
TMWidget.attributes.high_threshold <string> High threshold on the chart (in bytes). Optional
TMWidget.attributes.n_items <number> Maximum number of items shown. Optional
TMWidget.attributes.colspan <number> How many columns the widget occupies in layout. Optional
TMWidget.attributes.low_threshold <string> Low threshold on the chart (in bytes). Optional
TMWidget.attributes.moveable_nodes <string> Flag allowing the user to reposition nodes in a connection graph. Optional
TMWidget.attributes.orientation <string> Bar chart orientation (can be: VERTICAL, HORIZONTAL). Optional; Values: VERTICAL, HORIZONTAL
TMWidget.attributes.modal_links <number> Flag adding modal links on a widget. Optional
TMWidget.user_attributes <object> User-specific attributes. Optional
TMWidget.user_attributes.pan_zoomable <string> Flag making the graph interactive. Optional
TMWidget.user_attributes.line_scale <string> Line scale for a line chart (can be: LINEAR, LOG). Optional; Values: LINEAR, LOG
TMWidget.user_attributes.format_bytes <string> What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF). Optional; Values: BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF
TMWidget.user_attributes.show_images <string> Flag showing images in a connection graph. Optional
TMWidget.user_attributes.open_nodes <array of <string>> List of open node IDs for a tree widget. Optional
TMWidget.user_attributes.open_nodes
[item]
<string> ID of an expanded nodes in a tree widget. Optional
TMWidget.user_attributes.line_style <string> Line chart style (can be: LINE, STACKED). Optional; Values: LINE, STACKED
TMWidget.user_attributes.layout <string> Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC). Optional; Values: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC
TMWidget.user_attributes.width <number> Widget width. Optional
TMWidget.user_attributes.height <number> Widget height. Optional
TMWidget.user_attributes.
percent_of_total
<string> Flag including the 'total' item in a pie chart. Optional
TMWidget.user_attributes.edge_thickness <string> Widget edge thickness. Optional
TMWidget.user_attributes.
display_host_group_type
<string> Default host grouping type for displaying grouped hosts. Optional
TMWidget.user_attributes.extend_to_zero <string> Flag: extending the Y-axis to zero. Optional
TMWidget.user_attributes.collapsible <string> Flag indicating if the widget is collapsible. Optional
TMWidget.user_attributes.high_threshold <string> High threshold on the chart (in bytes). Optional
TMWidget.user_attributes.n_items <number> Maximum number of items shown. Optional
TMWidget.user_attributes.colspan <number> How many columns the widget occupies in layout. Optional
TMWidget.user_attributes.low_threshold <string> Low threshold on the chart (in bytes). Optional
TMWidget.user_attributes.moveable_nodes <string> Flag allowing the user to reposition nodes in a connection graph. Optional
TMWidget.user_attributes.orientation <string> Bar chart orientation (can be: VERTICAL, HORIZONTAL). Optional; Values: VERTICAL, HORIZONTAL
TMWidget.user_attributes.modal_links <number> Flag adding modal links on a widget. Optional
TMWidget.timestamp <string> Widget time stamp specification. Optional

Reporting: List directions

Get a list of directions that this version of the API supports.

GET https://{device}/api/profiler/1.3/reporting/directions
Authorization

This request requires authorization.

Response Body

On success, the server returns a response body with the following structure:

  • JSON
[
  {
    "id": string,
    "name": string
  }
]

Example:
[
  {
    "id": "inn", 
    "name": "in"
  }, 
  {
    "id": "out", 
    "name": "out"
  }, 
  {
    "id": "c2s", 
    "name": "client to server"
  }, 
  {
    "id": "s2c", 
    "name": "server to client"
  }
]
Property Name Type Description Notes
Directions <array of <object>> List of directions.
Directions[Direction] <object> Object representing a direction. Optional
Directions[Direction].id <string> ID of a direction. To be used in the API.
Directions[Direction].name <string> Human-readable name of a direction.

Reporting: Update template

Update reporting template.

PUT https://{device}/api/profiler/1.3/reporting/templates/{template_id}
Authorization

This request requires authorization.

Request Body

Provide a request body with the following structure:

  • JSON
{
  "traffic_expression": string,
  "id": number,
  "scheduled": string,
  "sharing": {
    "users": [
      number
    ]
  },
  "layout": [
    {
      "flow_items": [
        {
          "id": number
        }
      ],
      "attributes": {
        "wrappable": string,
        "full_width": string,
        "item_spacing": string
      }
    }
  ],
  "description": string,
  "user_id": number,
  "shared": string,
  "live": string,
  "last_added_section_id": number,
  "name": string,
  "last_added_widget_id": number,
  "version": string,
  "disabled": string,
  "timestamp": string,
  "sections": [
    {
      "widgets": [
        {
          "config": {
            "datasource": string,
            "visualization": string,
            "widget_type": string
          },
          "widget_id": number,
          "criteria": {
            "ports": [
              {
                "port": number,
                "protocol": number,
                "name": string
              }
            ],
            "dscp_app_ports": [
              {
                "port": {
                  "port": number,
                  "protocol": number,
                  "name": string
                },
                "app": {
                  "code": string,
                  "name": string,
                  "tunneled": string
                },
                "dscp": {
                  "name": string,
                  "code_point": number
                }
              }
            ],
            "services": [
              {
                "name": string,
                "service_id": number
              }
            ],
            "port_groups": [
              {
                "name": string,
                "group_id": number
              }
            ],
            "comparison_time_frame": {
              "data_resolution": string,
              "refresh_interval": string,
              "type": string
            },
            "host_group_pairs": [
              {
                "server": {
                  "name": string,
                  "group_id": number
                },
                "client": {
                  "name": string,
                  "group_id": number
                }
              }
            ],
            "wan_group": string,
            "traffic_expression": string,
            "split_direction": string,
            "include_successes": string,
            "include_non_optimized_sites": string,
            "columns": [
              number
            ],
            "application_servers": [
              {
                "app": {
                  "code": string,
                  "name": string,
                  "tunneled": string
                },
                "server": {
                  "mac": string,
                  "ipaddr": string,
                  "name": string
                }
              }
            ],
            "devices": [
              {
                "ipaddr": string,
                "name": string
              }
            ],
            "application_ports": [
              {
                "port": {
                  "port": number,
                  "protocol": number,
                  "name": string
                },
                "app": {
                  "code": string,
                  "name": string,
                  "tunneled": string
                }
              }
            ],
            "include_failures": string,
            "host_pair_ports": [
              {
                "port": {
                  "port": number,
                  "protocol": number,
                  "name": string
                },
                "server": {
                  "mac": string,
                  "ipaddr": string,
                  "name": string
                },
                "client": {
                  "mac": string,
                  "ipaddr": string,
                  "name": string
                }
              }
            ],
            "dscp_interfaces": [
              {
                "interface": {
                  "ipaddr": string,
                  "name": string,
                  "ifindex": number
                },
                "dscp": {
                  "name": string,
                  "code_point": number
                }
              }
            ],
            "time_frame": {
              "data_resolution": string,
              "refresh_interval": string,
              "type": string
            },
            "service": {
              "name": string,
              "service_id": number
            },
            "severity": number,
            "role": string,
            "event_policies": [
              number
            ],
            "service_locations": [
              {
                "name": string,
                "location_id": string
              }
            ],
            "case_insensitive": string,
            "service_location": {
              "name": string,
              "location_id": string
            },
            "include_backend_segments": string,
            "host_group_type": string,
            "host_pair_app_ports": [
              {
                "port": {
                  "port": number,
                  "protocol": number,
                  "name": string
                },
                "app": {
                  "code": string,
                  "name": string,
                  "tunneled": string
                },
                "server": {
                  "mac": string,
                  "ipaddr": string,
                  "name": string
                },
                "client": {
                  "mac": string,
                  "ipaddr": string,
                  "name": string
                }
              }
            ],
            "users": [
              {
                "name": string
              }
            ],
            "sort_desc": string,
            "sort_column": number,
            "host_group_pair_ports": [
              {
                "port": {
                  "port": number,
                  "protocol": number,
                  "name": string
                },
                "server": {
                  "name": string,
                  "group_id": number
                },
                "client": {
                  "name": string,
                  "group_id": number
                }
              }
            ],
            "network_segments": [
              {
                "src": {
                  "ipaddr": string,
                  "name": string,
                  "ifindex": number
                },
                "dst": {
                  "ipaddr": string,
                  "name": string,
                  "ifindex": number
                }
              }
            ],
            "hosts": [
              {
                "mac": string,
                "ipaddr": string,
                "name": string
              }
            ],
            "host_pairs": [
              {
                "server": {
                  "mac": string,
                  "ipaddr": string,
                  "name": string
                },
                "client": {
                  "mac": string,
                  "ipaddr": string,
                  "name": string
                }
              }
            ],
            "protocols": [
              {
                "id": number,
                "name": string
              }
            ],
            "centricity": string,
            "limit": number,
            "interfaces": [
              {
                "ipaddr": string,
                "name": string,
                "ifindex": number
              }
            ],
            "host_groups": [
              {
                "name": string,
                "group_id": number
              }
            ],
            "dscps": [
              {
                "name": string,
                "code_point": number
              }
            ],
            "applications": [
              {
                "code": string,
                "name": string,
                "tunneled": string
              }
            ]
          },
          "title": string,
          "attributes": {
            "pan_zoomable": string,
            "line_scale": string,
            "format_bytes": string,
            "show_images": string,
            "open_nodes": [
              string
            ],
            "line_style": string,
            "layout": string,
            "width": number,
            "height": number,
            "percent_of_total": string,
            "edge_thickness": string,
            "display_host_group_type": string,
            "extend_to_zero": string,
            "collapsible": string,
            "high_threshold": string,
            "n_items": number,
            "colspan": number,
            "low_threshold": string,
            "moveable_nodes": string,
            "orientation": string,
            "modal_links": number
          },
          "user_attributes": {
            "pan_zoomable": string,
            "line_scale": string,
            "format_bytes": string,
            "show_images": string,
            "open_nodes": [
              string
            ],
            "line_style": string,
            "layout": string,
            "width": number,
            "height": number,
            "percent_of_total": string,
            "edge_thickness": string,
            "display_host_group_type": string,
            "extend_to_zero": string,
            "collapsible": string,
            "high_threshold": string,
            "n_items": number,
            "colspan": number,
            "low_threshold": string,
            "moveable_nodes": string,
            "orientation": string,
            "modal_links": number
          },
          "timestamp": string
        }
      ],
      "section_id": number,
      "layout": [
        {
          "flow_items": [
            {
              "id": number
            }
          ],
          "attributes": {
            "wrappable": string,
            "full_width": string,
            "item_spacing": string
          }
        }
      ]
    }
  ],
  "img": {
    "thumbnail": {
      "src": string
    },
    "full": {
      "src": string
    }
  }
}

Example:
{
  "layout": [
    {
      "flow_items": [
        {
          "id": 1
        }
      ]
    }
  ], 
  "name": "VOIP - Call Quality and Usage", 
  "user_id": 1, 
  "timestamp": "1383141976.674345", 
  "live": true, 
  "last_added_widget_id": 6, 
  "traffic_expression": "app VoIP-RTP", 
  "version": "1.1", 
  "shared": "Private", 
  "sections": [
    {
      "widgets": [
        {
          "title": "VoIP-RTP: Applications", 
          "timestamp": "1383141976.674383", 
          "criteria": {
            "sort_column": 33, 
            "traffic_expression": "", 
            "sort_desc": true, 
            "centricity": "host", 
            "limit": 100, 
            "columns": [
              17, 
              33, 
              34, 
              757, 
              766, 
              781, 
              803
            ], 
            "time_frame": {
              "data_resolution": "15mins", 
              "type": "last_hour", 
              "refresh_interval": "15mins"
            }
          }, 
          "attributes": {
            "format_bytes": "UI_PREF", 
            "colspan": 2, 
            "n_items": 20
          }, 
          "config": {
            "widget_type": "APPS", 
            "visualization": "TABLE", 
            "datasource": "TRAFFIC"
          }, 
          "widget_id": 1
        }, 
        {
          "title": "VoIP-RTP: Traffic Quality", 
          "timestamp": "1383141976.674428", 
          "criteria": {
            "traffic_expression": "", 
            "sort_desc": true, 
            "centricity": "host", 
            "columns": [
              803
            ], 
            "time_frame": {
              "data_resolution": "min", 
              "type": "last_hour", 
              "refresh_interval": "min"
            }
          }, 
          "attributes": {
            "format_bytes": "UI_PREF", 
            "colspan": 1, 
            "extend_to_zero": false, 
            "line_scale": "LINEAR", 
            "line_style": "STACKED"
          }, 
          "config": {
            "widget_type": "TRAFFIC_OVERALL", 
            "visualization": "LINE", 
            "datasource": "TRAFFIC"
          }, 
          "widget_id": 2
        }, 
        {
          "title": "VoIP-RTP: Traffic Quality", 
          "timestamp": "1383141976.674459", 
          "criteria": {
            "traffic_expression": "", 
            "sort_desc": true, 
            "centricity": "host", 
            "columns": [
              781
            ], 
            "time_frame": {
              "data_resolution": "min", 
              "type": "last_hour", 
              "refresh_interval": "min"
            }
          }, 
          "attributes": {
            "format_bytes": "UI_PREF", 
            "colspan": 1, 
            "extend_to_zero": false, 
            "line_style": "STACKED"
          }, 
          "config": {
            "widget_type": "TRAFFIC_OVERALL", 
            "visualization": "LINE", 
            "datasource": "TRAFFIC"
          }, 
          "widget_id": 3
        }, 
        {
          "title": "VoIP-RTP: Traffic Quality", 
          "timestamp": "1383141976.674497", 
          "criteria": {
            "traffic_expression": "", 
            "sort_desc": true, 
            "centricity": "host", 
            "columns": [
              766
            ], 
            "time_frame": {
              "data_resolution": "min", 
              "type": "last_hour", 
              "refresh_interval": "min"
            }
          }, 
          "attributes": {
            "format_bytes": "UI_PREF", 
            "colspan": 2, 
            "extend_to_zero": false, 
            "line_style": "STACKED"
          }, 
          "config": {
            "widget_type": "TRAFFIC_OVERALL", 
            "visualization": "LINE", 
            "datasource": "TRAFFIC"
          }, 
          "widget_id": 4
        }, 
        {
          "title": "VoIP-RTP: Traffic Volume", 
          "timestamp": "1383141976.674527", 
          "criteria": {
            "traffic_expression": "", 
            "sort_desc": true, 
            "centricity": "host", 
            "columns": [
              33
            ], 
            "time_frame": {
              "data_resolution": "15mins", 
              "type": "last_day", 
              "refresh_interval": "15mins"
            }
          }, 
          "attributes": {
            "format_bytes": "UI_PREF", 
            "colspan": 2, 
            "extend_to_zero": false, 
            "line_style": "STACKED"
          }, 
          "config": {
            "widget_type": "TRAFFIC_OVERALL", 
            "visualization": "LINE", 
            "datasource": "TRAFFIC"
          }, 
          "widget_id": 5
        }, 
        {
          "title": "Host Group Pairs", 
          "timestamp": "1383141976.674566", 
          "criteria": {
            "sort_column": 33, 
            "traffic_expression": "", 
            "host_group_type": "ByLocation", 
            "sort_desc": true, 
            "centricity": "host", 
            "limit": 100, 
            "time_frame": {
              "data_resolution": "15mins", 
              "type": "last_hour", 
              "refresh_interval": "15mins"
            }
          }, 
          "attributes": {
            "format_bytes": "UI_PREF", 
            "show_images": true, 
            "layout": "HORIZONTAL_TREE", 
            "colspan": 2, 
            "moveable_nodes": true, 
            "height": 400, 
            "edge_thickness": true, 
            "pan_zoomable": true, 
            "n_items": 10
          }, 
          "config": {
            "widget_type": "HOST_GROUP_PAIRS", 
            "visualization": "CONN_GRAPH", 
            "datasource": "TRAFFIC"
          }, 
          "widget_id": 6
        }
      ], 
      "layout": [
        {
          "flow_items": [
            {
              "id": 1
            }
          ]
        }, 
        {
          "flow_items": [
            {
              "id": 2
            }, 
            {
              "id": 3
            }
          ]
        }, 
        {
          "flow_items": [
            {
              "id": 4
            }
          ]
        }, 
        {
          "flow_items": [
            {
              "id": 5
            }
          ]
        }, 
        {
          "flow_items": [
            {
              "id": 6
            }
          ]
        }
      ], 
      "section_id": 1
    }
  ], 
  "id": 5217, 
  "description": ""
}
Property Name Type Description Notes
ReportTemplateSpec <object> Reporting template specification object.
ReportTemplateSpec.traffic_expression <string> Traffic expression applied to all widgets within the template. Optional
ReportTemplateSpec.id <number> ID of the report template. Optional
ReportTemplateSpec.scheduled <string> Flag indicating that the template is scheduled. Optional
ReportTemplateSpec.sharing <object> List of the users the template is shared with (see ReportTemplateSharing). Optional
ReportTemplateSpec.sharing.users <array of <number>> List of the users a template is shared with. Optional
ReportTemplateSpec.sharing.users[item] <number> User ID. Optional
ReportTemplateSpec.layout <array of <object>> Layout information. Optional
ReportTemplateSpec.layout[TMFlowLine] <object> One horizontal line of widgets. Optional
ReportTemplateSpec.layout[TMFlowLine].
flow_items
<array of <object>> List of line items. Optional
ReportTemplateSpec.layout[TMFlowLine].
flow_items[TMFlowItem]
<object> Object replesenting one layout item. Optional
ReportTemplateSpec.layout[TMFlowLine].
flow_items[TMFlowItem].id
<number> Widget ID. Optional
ReportTemplateSpec.layout[TMFlowLine].
attributes
<object> List of line attributes. Optional
ReportTemplateSpec.layout[TMFlowLine].
attributes.wrappable
<string> Flag allowing wrapping. Optional
ReportTemplateSpec.layout[TMFlowLine].
attributes.full_width
<string> Flag representing width of the layout line. Optional
ReportTemplateSpec.layout[TMFlowLine].
attributes.item_spacing
<string> Item spacing between widgets. Optional
ReportTemplateSpec.description <string> Human-readable description of the template. Optional
ReportTemplateSpec.user_id <number> User ID of the template owner. Optional
ReportTemplateSpec.shared <string> Flag indicating that the template is shared with other users. Optional; Values: Private, Public, Users
ReportTemplateSpec.live <string> Flag indicating that the template is a dashboard.
ReportTemplateSpec.last_added_section_id <number> ID of the last layout section added to the template. Optional
ReportTemplateSpec.name <string> Human-readable name of the template.
ReportTemplateSpec.last_added_widget_id <number> ID of the last widget added to the template. Optional
ReportTemplateSpec.version <string> Version of the specification. Optional
ReportTemplateSpec.disabled <string> Flag indicating that the template is disabled. Optional
ReportTemplateSpec.timestamp <string> Report time stamp (unix time). Optional
ReportTemplateSpec.sections <array of <object>> List of layout sections. Optional
ReportTemplateSpec.sections[TMSection] <object> One TMSection object. Optional
ReportTemplateSpec.sections[TMSection].
widgets
<array of <object>> List of widgets that belong to the section. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget]
<object> One TMWidget object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].config
<object> Widget configuration: data source type, widget type, and visualization type.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].config.datasource
<string> Data source type. Values: TRAFFIC, WAN, SERVICE, EVENTS, ACTIVE_DIRECTORY
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].config.visualization
<string> Visualization type. Values: TABLE, PIE, BAR, LINE, CONN_GRAPH, TREE_TABLE, INVISIBLE
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].config.widget_type
<string> Widget type. Values: TRAFFIC_OVERALL, TRAFFIC_OVERALL_CRTT, HOSTS, PEER_HOSTS, PEER_HOST_GROUPS, HOST_PAIRS_PORTS, HOST_PAIRS_APP_PORTS, HOST_PAIRS, HOST_GROUPS, HOST_GROUP_PAIRS, HOST_GROUP_PAIR_PORTS, APPS, APP_PORTS, SERVER_APPS, PORTS, PORT_GROUPS, PROTOCOLS, DEVICES, INTERFACES, NETWORK_SEGMENTS, DSCPS, DSCP_APP_PORTS, DSCP_IFACES, CURRENT_EVENTS, UNACKED_EVENTS, ACTIVE_DIRECTORY, SERVICE_HEALTH, LOCATION_HEALTH, SERVICE_HEALTH_MAP, LOCATION_HEALTH_MAP
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].widget_id
<number> Internal widget ID within a dashboard. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria
<object> Query criteria for the widget.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.ports
<array of <object>> Watched ports. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.ports
[CProtoPort]
<object> One CProtoPort object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.ports
[CProtoPort].port
<number> Port specification. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.ports
[CProtoPort].protocol
<number> Protocol specification. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.ports
[CProtoPort].name
<string> Protocol + port combination name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports
<array of <object>> Watched combinations of DSCPs, applications, and ports. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort]
<object> One CDSCPAppPort object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort].port
<object> Port specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort].port.port
<number> Port specification. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort].port.
protocol
<number> Protocol specification. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort].port.name
<string> Protocol + port combination name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort].app
<object> Application specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort].app.code
<string> Application code. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort].app.name
<string> Application name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort].app.
tunneled
<string> Flag: is the application tunneled. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort].dscp
<object> DSCP specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort].dscp.name
<string> DSCP name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_app_ports[CDSCPAppPort].dscp.
code_point
<number> DSCP code point. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.services
<array of <object>> Watched services. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.services
[CService]
<object> One CService object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.services
[CService].name
<string> Service name.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.services
[CService].service_id
<number> Service ID. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.port_groups
<array of <object>> Watched port groups. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.port_groups
[CPortGroup]
<object> One CPortGroup object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.port_groups
[CPortGroup].name
<string> Name of the port group. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.port_groups
[CPortGroup].group_id
<number> ID of the port group. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
comparison_time_frame
<object> Alternative time frame specification to be used in a comparison widget. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
comparison_time_frame.data_resolution
<string> Report data resolution. It can be one of: 1min, 15min, hour, 6hour, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
comparison_time_frame.refresh_interval
<string> Report refresh interval. It can be one of: min, 15mins, hour, 6hours, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
comparison_time_frame.type
<string> Type of time frame. Can be one of: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month. Optional; Values: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_group_pairs
<array of <object>> Watched group pairs. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_group_pairs[CHostGroupPair]
<object> One CHostGroupPair object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_group_pairs[CHostGroupPair].
server
<object> Server host group specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_group_pairs[CHostGroupPair].
server.name
<string> Host group name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_group_pairs[CHostGroupPair].
server.group_id
<number> Host group ID. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_group_pairs[CHostGroupPair].
client
<object> Client host group specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_group_pairs[CHostGroupPair].
client.name
<string> Host group name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_group_pairs[CHostGroupPair].
client.group_id
<number> Host group ID. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.wan_group
<string> WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
traffic_expression
<string> Traffic expression. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
split_direction
<string> Split inbound/outbound or received/transmitted data. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
include_successes
<string> Include successful requests in active directory report. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
include_non_optimized_sites
<string> Flag indicating whether to include WAN non optimized sites. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.columns
<array of <number>> List of column ID. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.columns
[item]
<number> Column ID. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_servers
<array of <object>> Watched combinations of applications and servers. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_servers
[CApplicationServer]
<object> One CApplicationServer object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_servers
[CApplicationServer].app
<object> Application specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_servers
[CApplicationServer].app.code
<string> Application code. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_servers
[CApplicationServer].app.name
<string> Application name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_servers
[CApplicationServer].app.tunneled
<string> Flag: is the application tunneled. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_servers
[CApplicationServer].server
<object> Server specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_servers
[CApplicationServer].server.mac
<string> Host MAC address. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_servers
[CApplicationServer].server.ipaddr
<string> Host IP address. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_servers
[CApplicationServer].server.name
<string> Host name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.devices
<array of <object>> Watched devices. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.devices
[CDevice]
<object> One CDevice object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.devices
[CDevice].ipaddr
<string> Device IP address. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.devices
[CDevice].name
<string> Device name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_ports
<array of <object>> Watched combinations of applications and ports. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_ports[CApplicationPort]
<object> One CApplicationPort object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_ports[CApplicationPort].
port
<object> Port specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_ports[CApplicationPort].
port.port
<number> Port specification. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_ports[CApplicationPort].
port.protocol
<number> Protocol specification. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_ports[CApplicationPort].
port.name
<string> Protocol + port combination name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_ports[CApplicationPort].
app
<object> Application specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_ports[CApplicationPort].
app.code
<string> Application code. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_ports[CApplicationPort].
app.name
<string> Application name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
application_ports[CApplicationPort].
app.tunneled
<string> Flag: is the application tunneled. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
include_failures
<string> Include failed requests in active directory report. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports
<array of <object>> Watched combinations of host pairs and ports. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort]
<object> One CHostPairPort object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].port
<object> Port specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].port.
port
<number> Port specification. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].port.
protocol
<number> Protocol specification. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].port.
name
<string> Protocol + port combination name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].server
<object> Server host specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].server.
mac
<string> Host MAC address. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].server.
ipaddr
<string> Host IP address. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].server.
name
<string> Host name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].client
<object> Client host specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].client.
mac
<string> Host MAC address. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].client.
ipaddr
<string> Host IP address. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_ports[CHostPairPort].client.
name
<string> Host name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_interfaces
<array of <object>> Watched combinations of DSCPs and interfaces. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_interfaces[CDSCPInterface]
<object> One CDSCPInterface object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_interfaces[CDSCPInterface].
interface
<object> Interface specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_interfaces[CDSCPInterface].
interface.ipaddr
<string> Interface IP address. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_interfaces[CDSCPInterface].
interface.name
<string> Interface name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_interfaces[CDSCPInterface].
interface.ifindex
<number> Interface index. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_interfaces[CDSCPInterface].dscp
<object> DSCP specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_interfaces[CDSCPInterface].dscp.
name
<string> DSCP name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
dscp_interfaces[CDSCPInterface].dscp.
code_point
<number> DSCP code point. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.time_frame
<object> Widget time frame specification. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.time_frame.
data_resolution
<string> Report data resolution. It can be one of: 1min, 15min, hour, 6hour, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.time_frame.
refresh_interval
<string> Report refresh interval. It can be one of: min, 15mins, hour, 6hours, day, week, month. Optional; Values: min, 15mins, hour, 6hours, day, week, month
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.time_frame.
type
<string> Type of time frame. Can be one of: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month. Optional; Values: last_min, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.service
<object> Watched service. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.service.
name
<string> Service name.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.service.
service_id
<number> Service ID. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.severity
<number> Minimum severity filter for an event report. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.role
<string> Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER'). Optional; Values: CLIENT_SERVER, CLIENT, SERVER
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
event_policies
<array of <number>> List of event policies to include in an event report. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
event_policies[item]
<number> Event policy ID. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
service_locations
<array of <object>> Watched service locations. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
service_locations[CServiceLocation]
<object> One CServiceLocation object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
service_locations[CServiceLocation].
name
<string> Service location name.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
service_locations[CServiceLocation].
location_id
<string> Service location ID. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
case_insensitive
<string> Case-insensitive usernames in an identity report. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
service_location
<object> Watched service location. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
service_location.name
<string> Service location name.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
service_location.location_id
<string> Service location ID. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
include_backend_segments
<string> Flag indicating whether to include back-end segments. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_group_type
<string> Host group type used. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports
<array of <object>> Watched combinations of host pairs, applications, and ports. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort]
<object> One CHostPairAppPort object. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort].
port
<object> Port specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort].
port.port
<number> Port specification. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort].
port.protocol
<number> Protocol specification. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort].
port.name
<string> Protocol + port combination name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort].
app
<object> Application specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort].
app.code
<string> Application code. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort].
app.name
<string> Application name. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort].
app.tunneled
<string> Flag: is the application tunneled. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort].
server
<object> Server host specification.
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort].
server.mac
<string> Host MAC address. Optional
ReportTemplateSpec.sections[TMSection].
widgets[TMWidget].criteria.
host_pair_app_ports[CHostPairAppPort].
server.ipaddr
<string> Host IP address. Optional
ReportTemplateSpec.sections[TMSection].