\nThe documentation pages in this section describe\nthe RESTful APIs included with Cascade Profiler and Cascade Express\nproducts. It is assumed that the reader has practical knowledge of\nRESTful APIs, so the documentation does not go into detail about what\nREST is and how to use it. Instead the documentation focuses on what\ndata can be accessed and how to access it.\n
\n\n\nThe primary focus of the current version of the API is on providing\naccess to reporting data. The following information can be accessed\nvia the API:\n
\n\nDetails about REST resources can be found in the Resources\nsection. This overview continues with how to run reports and retrieve\ndata from them.\n
\n\n\nThe steps for running a report are described below. An easy way to\nlearn how to run reports and get data is to use the Demo\nReports section of this documentation. In that section a number of\nexample reports are listed. If you click on any of the examples, the\nreport will run along with a listing on the right side of the screen\nfor each step in the process. It displays the REST resource, HTTP\nmethod, headers and body for both the request and response.\n
\n\n\nFollow these steps to run a report:\n
\n\n\nA criteria structure in either JSON or XML is submitted to the server\nusing the HTTP POST method. The resource to which the criteria\nstructure is posted is\ncalled /profiler/1.0/reporting/reports. The details are\ndescribed in the Resources section of this documentation.\n
\n\n\nA key part of the report criteria is the ID of the template that\nshould be used to run the report. A special system template ID 184\nthat provides a high degree of flexibility is used in demo reports in\nthis documentation. Additionally, any template that is saved via the\nuser interface of the product can be used to run a report. In order to\nsave a template, the ID of that template must be passed in the report\ncriteria structure instead of 184. A template can be configured via\nthe user interface, saved via the product and then used in the REST\nAPI to generate reports and retrieve them in a rendered form or in raw\ndata form. Once a template is saved, its ID can be obtained\nvia the /api/profiler/1.0/reporting/templates REST resource.\n
\n\n\nIt may take a while for a report to complete. While the report is\nrunning, the client must poll for report status to know when the\nreport completes. When the call to create a new report succeeds, it\nreturns the URL for the newly created report. That URL may look\nsimilar to /profiler/1.0/reporting/reports/1000, which is the ID of\nthe new report.\n
\n\n\nThe general way to describe this in REST documentation is\n/profiler/1.0/reporting/reports/{id} so this documentation uses\nthat syntax throughout. Note that the client does not need to know\nthat {id} is really an ID of a report. Instead the client should\ntreat a given report, for example\n/profiler/1.0/reporting/reports/1000, as a REST resource without\nparsing the parts of the URL.\n
\n\n\nThe status of a report can be obtained by executing a GET method on\nthe report URL. The client should wait while the report is running and\nuntil the status turns to state.\n
\n\n\nOnce the report completes, the client can retrieve its data or the\nrendered version of the report in a number of formats.\n
\n\n\nThe following resources can be used to retrieve a rendered version of the report:\n
\nIf the client is a script that needs access to raw data, the\n/profiler/1.0/reporting/reports/{id}/queries resource can be\nused with the GET method to obtain the list of elements (queries)\nfirst. The data shown in a typical report on the user interface may\ncome from more than one query, which is why the report structure needs\nto be determined first. However, the system template 184 described\nabove will have only one query and is easy to use for simple scripts.\n
\n\n\nEach query resource provides metadata about the query, such as\nthe list of columns with descriptions of what the columns are. \n
\n\n\nOnce the query is chosen, the\n/profiler/1.0/reporting/reports/{id}/queries/{id} resource can be used\nto get the report data.\n
\n\n\nThe simple overview provided above cannot substitute for full\ndocumentation and it is not intended to do so. Please refer to Demo\nReports section to see how reports are run. Look at the Coding\nExamples under General Information and\nexplore Resources section of this documentation for more\ninformation.\n
\n\n\nAll REST requests must be authenticated. The Authentication\nsection of the Common 1.0 API describes which authentication methods\nare presently supported. There are also examples that show how to use\neach of the different authentication methods.\n
\n\nRun a report to get bytes and packets for the top 20 hosts using the application WEB. Use BASIC Authentication.
\n\n 184,\n 'criteria' => Array('time_frame' => array('start' => $start,\n 'end' => $end),\n 'traffic_expression' => 'app WEB',\n 'query' => array('realm' => 'traffic_summary',\n 'group_by' => 'hos',\n 'sort_column' => 33,\n 'columns' => array(6, 33, 34))));\n \n $json = json_encode($struct);\n $columns = $struct['criteria']['query']['columns'];\n \n // Post to run the report\n $url = 'https://' . HOST . '/api/profiler/1.0/reporting/reports.json';\n echo \"Run report:\\nPOST {$url}\\n{$json}\\n\\n\";\n $info = array();\n do_POST($url, $json, $info);\n if ($info['http_code'] != 201) {\n echo \"Unable to run report!\\n\";\n exit(1);\n }\n $location = get_header($info['headers'], 'Location');\n echo \"Generated: {$location}\\n\\n\";\n $status_url = 'https://' . HOST . '' . $location . '.json';\n \n // Wait for it to complete\n echo \"Please wait\\n\";\n while (true) {\n $info = array();\n $output = do_GET($status_url, $info);\n $s = json_decode($output, 1);\n print \" Percent completed {$s['percent']}, seconds remaining {$s['remaining_seconds']}...\\n\";\n if ($s['status'] == 'completed') {\n echo \"Completed\\n\\n\";\n break;\n }\n sleep(1);\n }\n \n // Get all quesries (In this exampe it is only one)\n $queries_url = 'https://' . HOST . '' . $location . '/queries.json';\n $output = do_GET($queries_url, $info);\n $queries = json_decode($output, 1);\n \n // Print the data from all queries\n foreach ($queries as $q) {\n $query_id = $q['id'];\n $data_url = 'https://' . HOST . '' . $location . '/queries/' . $query_id . '.json?offset=0&limit=20&columns=' . join(',', $columns);\n $info = array();\n $output = do_GET($data_url, $info);\n $data = json_decode($output, 1);\n \n $h = array();\n foreach ($columns as $c)\n $h[] = find_column_name_by_id($q['columns'], $c);\n \n echo_csv($h, $data['data']);\n echo \"\\n\";\n }\n \n ?>\nRun a report to get bytes and packets for the top 20 hosts using the application WEB. Use BASIC Authentication.
\n\n from urlparse import urlparse\n import base64\n import logging\n import httplib\n import json\n import time\n import sys\n \n HOST = '127.0.0.1'\n BASIC_AUTH = 'admin:admin'\n \n end = int(time.time() - 3*60)\n start = int(end - 5*60);\n \n # Lib functions\n \n def do_POST(url, string):\n '''HTTP POST'''\n \n conn = httplib.HTTPSConnection(HOST, 443)\n \n headers = {\"Authorization\" : \"Basic %s\" % base64.b64encode(BASIC_AUTH),\n \"Content-Length\" : str(len(string)),\n \"Content-Type\" : \"application/json\"}\n \n conn.request('POST', url, body=string, headers=headers)\n \n res = conn.getresponse()\n \n info = {\"status\" : res.status,\n \"headers\" : res.getheaders()}\n \n data = res.read()\n conn.close()\n return data, info\n \n def do_GET(url):\n '''HTTP GET'''\n \n conn = httplib.HTTPSConnection(HOST, 443)\n \n headers = {\"Authorization\" : \"Basic %s\" % base64.b64encode(BASIC_AUTH),\n \"Content-Length\" : 0,\n \"Content-Type\" : \"application/json\"}\n \n conn.request('GET', url, body=\"\", headers=headers)\n \n res = conn.getresponse()\n \n info = {\"status\" : res.status,\n \"headers\" : res.getheaders()}\n \n data = res.read()\n conn.close()\n return data, info\n \n def get_header(headers, header):\n '''Finds and returns HTTP header'''\n for i in headers:\n if (i[0] == header):\n return i[1]\n return \"\"\n \n def find_column_name_by_id(columns, cid):\n '''Locates a column by id and returns the name'''\n for c in columns:\n if (c['id'] == cid):\n return c['name']\n return 'Unknown'\n \n def echo_csv(headers, rows):\n '''CSV helper'''\n print ','.join(headers)\n for row in rows:\n print ','.join(row)\n \n # End lib functions\n \n struct = {\n \"template_id\" : 184,\n \"criteria\" : {\n \"time_frame\" : {\n \"start\" : start,\n \"end\" : end\n },\n \"traffic_expression\" : \"app WEB\",\n \"query\" : {\n \"realm\" : \"traffic_summary\",\n \"group_by\" : \"hos\",\n \"sort_column\": 33,\n \"columns\" : [6, 33, 34]\n }\n }\n }\n \n to_post = json.dumps(struct)\n columns = struct[\"criteria\"][\"query\"][\"columns\"]\n \n # Post to run the report\n url = \"https://%s/api/profiler/1.0/reporting/reports.json\" % HOST\n print \"Run report:\"\n print \"POST %s\" % url\n print \"%s\" % to_post\n \n output, info = do_POST(url, to_post)\n if (info['status'] is not 201):\n print \"Unable to run report\"\n sys.exit(1)\n \n location = get_header(info['headers'], 'location')\n print \"\"\n print \"Generated: %s\" % location\n print \"\"\n \n status_url = \"https://%s%s.json\" % (HOST, location)\n \n # Wait for it to complete\n print \"Please wait\"\n while (True):\n output, info = do_GET(status_url)\n s = json.loads(output)\n print \"Percent completed %s, seconds remaining %s...\" % (s[\"percent\"], s[\"remaining_seconds\"])\n if (s[\"status\"] == \"completed\"):\n print \"Completed\"\n break\n time.sleep(1)\n \n # Get all quesries (In this exampe it is only one)\n queries_url = \"https://%s%s/queries.json\" % (HOST, location)\n \n output, info = do_GET(queries_url)\n queries = json.loads(output)\n \n # Print the data from all queries\n for q in queries:\n query_id = q['id'];\n columns_str = ','.join([repr(i) for i in columns])\n data_url = \"https://%s%s/queries/%s.json?offset=0&limit=20&columns=%s\" % (HOST, location, query_id, columns_str)\n output, info = do_GET(data_url)\n data = json.loads(output)\n \n h = []\n for c in columns:\n h.append(find_column_name_by_id(q[\"columns\"], c))\n \n print \"\" \n echo_csv(h, data[\"data\"])\nRun a report to get bytes and packets for the top 20 hosts using the application WEB. Use BASIC Authentication.
\n\n #!/usr/bin/perl\n use strict;\n use warnings;\n \n use LWP::UserAgent;\n use HTTP::Request;\n use List::MoreUtils qw(firstidx);\n use JSON qw( encode_json decode_json );\n \n use constant HOST => '127.0.0.1';\n use constant LOGIN => 'admin';\n use constant PASSWORD => 'admin';\n \n our $ua = LWP::UserAgent->new;\n $ua->agent(\"ProfilerScript/0.1\");\n \n our $API_BASE = \"https://127.0.0.1\";\n \n sub _request($) \n {\n my $req = shift;\n \n $req->header('Accept' => 'application/json');\n $req->authorization_basic(LOGIN, PASSWORD);\n \n my $res = $ua->request($req);\n \n return {\n code => $res->code,\n status => $res->status_line,\n headers => $res->headers(),\n data => decode_json($res->content)\n };\n }\n \n sub GET($) \n {\n my $req = HTTP::Request->new(GET => $API_BASE . shift);\n return _request($req);\n }\n \n sub POST($$) \n {\n my $req = HTTP::Request->new(POST => $API_BASE . shift);\n $req->content_type('application/json');\n $req->content(encode_json(shift));\n \n return _request($req);\n }\n \n my $end = time();\n my $start = $end - 5 * 60;\n \n my $struct = { \n template_id => 184, \n criteria => { \n time_frame => { \n start => $start, \n end => $end \n }, \n traffic_expression => \"app WEB\", \n query => { \n realm => \"traffic_summary\", \n group_by => \"hos\", \n sort_column => 33, \n columns => [6, 33, 34] \n } \n } \n };\n \n print \"Running report... \";\n \n my $response = POST('/api/profiler/1.0/reporting/reports', $struct);\n die \"Unable to run report. $response->{data}->{error_text}\" unless $response->{code} == 201;\n \n my $loc = $response->{headers}->header('Location');\n \n while (1) \n {\n $response = GET($loc);\n printf \"\\rRunning report, %3d%% done, %d seconds remaining... \", \n $response->{data}->{percent}, \n $response->{data}->{remaining_seconds};\n \n last if $response->{data}->{status} eq 'completed';\n sleep(1);\n };\n \n print \"\\nLoading data...\\n\";\n \n $response = GET($loc . '/queries');\n die \"Unable to load queries. $response->{data}->{error_text}\" unless $response->{code} == 200;\n \n foreach my $query (@{$response->{data}})\n {\n my @columns = @{$struct->{criteria}->{query}->{columns}};\n my $columns = join ',', @columns;\n \n my $data_response = GET(\"$loc/queries/$query->{id}?offset=0&limit=20&columns=$columns\");\n die \"Unable to load data. $response->{data}->{error_text}\" unless $response->{code} == 200;\n \n my @indices = map { my $id = $_; firstidx { $_->{id} == $id } @{$query->{columns}} } @columns;\n \n print join \",\", map { qq~\"$query->{columns}->[$_]->{name}\"~; } @indices;\n print \"\\n\";\n \n foreach my $row (@{$data_response->{data}->{data}}) {\n print join \",\", @$row;\n print \"\\n\";\n }\n }\nRun a report to get bytes and packets for the top 20 hosts using the application WEB. Use BASIC Authentication.
\n\nProgram.cs:
\n\n using System;\n using System.Collections.Generic;\n using System.Net;\n using System.Runtime.Serialization.Json;\n using System.Text;\n using System.IO;\n using System.Net.Security;\n using System.Security.Cryptography.X509Certificates;\n using System.Linq;\n using System.Threading;\n using System.Web.Script.Serialization;\n \n namespace CascadeRestClient\n {\n public class ReportUpdate\n {\n public string status { get; set; }\n public string user_id { get; set; }\n public string name { get; set; }\n public string percent { get; set; }\n public string id { get; set; }\n public string remaining_seconds { get; set; }\n public string run_time { get; set; }\n public string saved { get; set; }\n public string template_id { get; set; }\n public string size { get; set; }\n }\n \n public class Column\n {\n public string strid { get; set; }\n public string metric { get; set; }\n public string rate { get; set; }\n public string statistic { get; set; }\n public int id { get; set; }\n public string unit { get; set; }\n public string category { get; set; }\n public string severity { get; set; }\n public string area { get; set; }\n public bool @internal { get; set; }\n public string role { get; set; }\n public string cli_srv { get; set; }\n public string type { get; set; }\n public bool available { get; set; }\n public string direction { get; set; }\n public string comparison { get; set; }\n public bool sortable { get; set; }\n public string name { get; set; }\n public string comparison_parameter { get; set; }\n public bool has_others { get; set; }\n public bool context { get; set; }\n public string name_type { get; set; }\n }\n \n public class QueryResult\n {\n public string direction { get; set; }\n public string actual_log { get; set; }\n public int actual_t0 { get; set; }\n public bool sort_desc { get; set; }\n public string area { get; set; }\n public string metric { get; set; }\n public int sort_col { get; set; }\n public string parent_id { get; set; }\n public string rate { get; set; }\n public string group_by { get; set; }\n public string role { get; set; }\n public List<Column> columns { get; set; }\n public string statistic { get; set; }\n public string type { get; set; }\n public string id { get; set; }\n public string unit { get; set; }\n public int actual_t1 { get; set; }\n }\n \n public class QueryData\n {\n public List<List<string>> data { get; set; }\n public int data_size { get; set; }\n public List<string> totals { get; set; }\n }\n \n class Program\n {\n static string BASIC_AUTH = \"admin:admin\";\n \n // callback used to validate the self-gen certificate in an SSL conversation\n private static bool ValidateRemoteCertificate(object sender, X509Certificate cert, X509Chain chain, SslPolicyErrors policyErrors)\n {\n return true;\n /*\n X509Certificate2 certv2 = new X509Certificate2(cert);\n if (certv2.GetNameInfo(X509NameType.SimpleName,true) == \"www.riverbed.com\")\n return true;\n \n return false;\n */\n }\n \n static void Main(string[] args)\n {\n if (args.Length == 0 || string.IsNullOrWhiteSpace(args[0]))\n {\n Console.WriteLine(\"Usage: CascadeRestClient hostname\");\n return;\n }\n try\n {\n //Code to allow run with self-signed certificates\n // validate cert by calling a function\n ServicePointManager.ServerCertificateValidationCallback += new RemoteCertificateValidationCallback(ValidateRemoteCertificate);\n \n //Starting to run rest \n string rootUrl = \"https://\" + args[0];\n string requestUrl = rootUrl + \"/api/profiler/1.0/reporting/reports.json\";\n string location;\n \n int start = (int)((DateTime.Now - new DateTime(1970, 1, 1).ToLocalTime()).TotalSeconds) - 8*60; //8 minutes before in unix time\n int end = start + 5*60; //3 minutes before in unix time\n \n var jsondata = new\n {\n template_id = 184,\n criteria = new\n {\n time_frame = new\n {\n start = start,\n end = end\n },\n \n traffic_expression = \"app WEB\",\n query = new\n {\n realm = \"traffic_summary\",\n group_by = \"hos\",\n sort_column = 33,\n columns = new List<int> { 6, 33, 34 }\n }\n }\n };\n \n //Serialize anomymous type to json\n JavaScriptSerializer serializer = new JavaScriptSerializer();\n string postData = serializer.Serialize(jsondata);\n \n Console.WriteLine(\"Run report:\");\n Console.WriteLine(\"POST \" + requestUrl);\n Console.WriteLine(postData + Environment.NewLine);\n \n // Post to run the report\n var runReportResponse = MakeRequest<ReportUpdate>(requestUrl, WebRequestMethods.Http.Post, out location, postData);\n Console.WriteLine(\"Generated \" + location + Environment.NewLine);\n requestUrl = rootUrl + location;\n Console.WriteLine(\"Please wait\");\n while (runReportResponse.status != \"completed\")\n {\n runReportResponse = MakeRequest<ReportUpdate>(requestUrl + \".json\", WebRequestMethods.Http.Get, out location);\n Console.WriteLine(string.Format(\"Percent completed {0}, seconds remaining {1}\",runReportResponse.percent, runReportResponse.remaining_seconds));\n Thread.Sleep(1000);\n }\n Console.WriteLine(\"Completed\"+ Environment.NewLine);\n \n // Get all quesries (In this example it is only one)\n var getQueriesResponse = MakeRequest<List<QueryResult>>(requestUrl +\"/queries.json\", WebRequestMethods.Http.Get, out location);\n string columns = jsondata.criteria.query.columns.Select(c=>c.ToString()).Aggregate((i, j) => i + \",\" + j);\n // Print the data from all queries\n foreach (var query in getQueriesResponse) {\n var qr = MakeRequest<QueryData>(requestUrl + \"/queries/\" + query.id + \".json?offset=0&limit=20&columns=\" + columns,\n WebRequestMethods.Http.Get, out location);\n string columnList = jsondata.criteria.query.columns.Select(c=>query.columns.Where(col => col.id == c).First().name)\n .Aggregate((l,r) => l + \",\" + r);\n Console.WriteLine(columnList);\n \n foreach (var dr in qr.data)\n {\n Console.WriteLine(dr.Aggregate((i, j) => i + ',' + j));\n }\n }\n }\n catch (Exception e)\n {\n Console.WriteLine(e.Message);\n }\n }\n \n \n private static string Base64Encode(string toEncode)\n {\n byte[] toEncodeAsBytes\n = System.Text.ASCIIEncoding.ASCII.GetBytes(toEncode);\n return System.Convert.ToBase64String(toEncodeAsBytes);\n }\n \n /// <summary>\n /// Make request\n /// </summary>\n /// <typeparam name=\"T\">return type</typeparam>\n /// <param name=\"requestUrl\">url for request</param>\n /// <param name=\"action\">Http Verb, Get, Post etc</param>\n /// <param name=\"location\">location returned from response header </param>\n /// <param name=\"requestData\">Data posted</param>\n /// <returns></returns>\n private static T MakeRequest<T>(string requestUrl, string action, out string location, string requestData = null) where T : class\n {\n HttpWebRequest request = WebRequest.Create(requestUrl) as HttpWebRequest;\n request.Headers.Add(\"Authorization: Basic \" + Base64Encode(BASIC_AUTH));\n request.ContentType = \"application/json\";\n request.Method = action;\n if (requestData == null)\n {\n request.ContentLength = 0;\n }\n else\n {\n ASCIIEncoding encoding = new ASCIIEncoding();\n byte[] byte1 = encoding.GetBytes(requestData);\n request.ContentLength = byte1.Length;\n using (Stream newStream = request.GetRequestStream())\n {\n newStream.Write(byte1, 0, byte1.Length);\n }\n }\n \n using (HttpWebResponse response = request.GetResponse() as HttpWebResponse)\n {\n if (response.StatusCode != HttpStatusCode.OK && response.StatusCode != HttpStatusCode.Created)\n throw new Exception(String.Format(\n \"Unable to run report! StatusCode={0}, Description={1}\",\n response.StatusCode,\n response.StatusDescription));\n location = response.Headers[HttpResponseHeader.Location];\n DataContractJsonSerializer jsonSerializer = new DataContractJsonSerializer(typeof(T));\n object objResponse = jsonSerializer.ReadObject(response.GetResponseStream());\n return objResponse as T;\n }\n }\n }\n }\n\nCascadeRestClient.csproj:
\n <?xml version=\"1.0\" encoding=\"utf-8\"?>\n <Project ToolsVersion=\"4.0\" DefaultTargets=\"Build\" xmlns=\"http://schemas.microsoft.com/developer/msbuild/2003\">\n <PropertyGroup>\n <Configuration Condition=\" '$(Configuration)' == '' \">Debug</Configuration>\n <Platform Condition=\" '$(Platform)' == '' \">x86</Platform>\n <ProductVersion>8.0.30703</ProductVersion>\n <SchemaVersion>2.0</SchemaVersion>\n <ProjectGuid>{4ED69347-523B-46AB-B259-47EF60D4F13A}</ProjectGuid>\n <OutputType>Exe</OutputType>\n <AppDesignerFolder>Properties</AppDesignerFolder>\n <RootNamespace>CascadeRestClient</RootNamespace>\n <AssemblyName>CascadeRestClient</AssemblyName>\n <TargetFrameworkVersion>v4.0</TargetFrameworkVersion>\n <TargetFrameworkProfile>\n </TargetFrameworkProfile>\n <FileAlignment>512</FileAlignment>\n </PropertyGroup>\n <PropertyGroup Condition=\" '$(Configuration)|$(Platform)' == 'Debug|x86' \">\n <PlatformTarget>x86</PlatformTarget>\n <DebugSymbols>true</DebugSymbols>\n <DebugType>full</DebugType>\n <Optimize>false</Optimize>\n <OutputPath>bin\\Debug\\</OutputPath>\n <DefineConstants>DEBUG;TRACE</DefineConstants>\n <ErrorReport>prompt</ErrorReport>\n <WarningLevel>4</WarningLevel>\n </PropertyGroup>\n <PropertyGroup Condition=\" '$(Configuration)|$(Platform)' == 'Release|x86' \">\n <PlatformTarget>x86</PlatformTarget>\n <DebugType>pdbonly</DebugType>\n <Optimize>true</Optimize>\n <OutputPath>bin\\Release\\</OutputPath>\n <DefineConstants>TRACE</DefineConstants>\n <ErrorReport>prompt</ErrorReport>\n <WarningLevel>4</WarningLevel>\n </PropertyGroup>\n <ItemGroup>\n <Reference Include=\"System\" />\n <Reference Include=\"System.Core\" />\n <Reference Include=\"System.Runtime.Serialization\" />\n <Reference Include=\"System.Web.Extensions\">\n <HintPath>..\\..\\..\\..\\..\\..\\..\\Program Files (x86)\\Reference Assemblies\\Microsoft\\Framework\\.NETFramework\\v4.0\\System.Web.Extensions.dll</HintPath>\n </Reference>\n <Reference Include=\"System.Xml.Linq\" />\n <Reference Include=\"System.Data.DataSetExtensions\" />\n <Reference Include=\"Microsoft.CSharp\" />\n <Reference Include=\"System.Data\" />\n <Reference Include=\"System.Xml\" />\n </ItemGroup>\n <ItemGroup>\n <Compile Include=\"Program.cs\" />\n <Compile Include=\"Properties\\AssemblyInfo.cs\" />\n </ItemGroup>\n <Import Project=\"$(MSBuildToolsPath)\\Microsoft.CSharp.targets\" />\n <!-- To modify your build process, add your task inside one of the targets below and uncomment it. \n Other similar extension points exist, see Microsoft.Common.targets.\n <Target Name=\"BeforeBuild\">\n </Target>\n <Target Name=\"AfterBuild\">\n </Target>\n -->\n </Project>\n", "version": "1.8", "defaultAuthorization": "required", "servicePath": "/api/profiler/1.8", "schemas": [], "resources": { "Protocols": { "methods": { "Get protocol": { "description": "Get information on one protocol.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "protocols/{proto}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of Protocols objects.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "id": "CProtocols", "type": "array", "example": [ { "id": 6, "name": "tcp" }, { "id": 17, "name": "udp" } ] }, "authorization": "required" }, "List protocols": { "description": "Get a list of all supported protocols.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "protocols", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of Protocols objects.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "id": "CProtocols", "type": "array", "example": [ { "id": 6, "name": "tcp" }, { "id": 17, "name": "udp" } ] }, "authorization": "required" } } }, "Services": { "methods": { "Delete existing business service": { "description": "Delete existing business service.", "httpmethod": "DELETE", "path": "services/{service_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Create and commit a new business service": { "description": "Create and commit a new business service.", "request": { "description": "Object representing a business service.", "properties": { "alert_notification": { "description": "Alert notification flag.", "required": true, "properties": { "high_enabled": { "description": "High alert enabled flag.", "required": true, "type": "string" }, "low_alert_recipient": { "description": "Low alert recipient.", "required": true, "type": "string" }, "low_enabled": { "description": "Low alert enabled flag.", "required": true, "type": "string" }, "high_alert_recipient": { "description": "High alert recipient.", "required": true, "type": "string" } }, "id": "ServiceAlertNotification", "type": "object" }, "components": { "description": "Service components.", "items": { "description": "Components defined for this business service.", "required": false, "properties": { "id": { "description": "Service component id.", "required": false, "type": "number" }, "definition": { "description": "Service component definition.", "required": true, "properties": { "snat_type": { "description": "Snat type.", "required": false, "type": "string", "enum": [ "NOT_USED", "SOMETIMES", "ALWAYS" ] }, "vips": { "description": "Vips if any.", "items": { "description": "Load balancer virtual server.", "required": false, "properties": { "port": { "description": "Port.", "required": true, "type": "number" }, "protocol": { "description": "Protocol.", "required": true, "type": "number" }, "ipaddr": { "description": "IP address.", "required": true, "type": "string" } }, "id": "LBVirtualServer", "type": "object" }, "required": false, "id": "LBVirtualServers", "type": "array" }, "load_balancer": { "description": "Load balancer if any.", "required": false, "type": "number" }, "outside_hosts": { "description": "Hosts/subnets excluded from component definition if any.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" }, "manual": { "description": "Manual flag.", "required": false, "type": "string" }, "within_hosts": { "description": "Hosts/subnets included into component definition.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" }, "snats": { "description": "Snats if any.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" } }, "id": "ServiceComponentDefinition", "type": "object" }, "name": { "description": "Service component name.", "required": true, "type": "string" }, "type": { "description": "Service component type.", "required": true, "type": "string", "enum": [ "END_USERS", "SERVERS", "LBVS", "LBRS" ] } }, "id": "ServiceComponent", "type": "object" }, "required": true, "id": "ServiceComponentsList", "type": "array" }, "segments": { "description": "Service segments.", "items": { "description": "Segments defined for this business service.", "required": false, "properties": { "alert_notification": { "description": "Alert notification flag.", "required": true, "type": "string" }, "id": { "description": "Service segment id.", "required": false, "type": "number" }, "definition": { "description": "Segment definition.", "items": { "description": "Service segment definition.", "required": false, "type": "string" }, "required": true, "id": "ServiceSegmentDefinition", "type": "array" }, "client_component_id": { "description": "Client component id.", "required": false, "type": "number" }, "status": { "description": "Service segment status.", "required": false, "type": "string", "enum": [ "ADDED", "DROPPED", "UNDECIDED" ] }, "locations": { "description": "Segment locations.", "items": { "description": "Segment locations.", "required": false, "properties": { "host_group_type_id": { "description": "Host group type id.", "required": true, "type": "number" }, "host_group_id": { "description": "Host group id.", "required": true, "type": "number" }, "location_id": { "description": "Location id.", "required": false, "type": "number" } }, "id": "SegmentLocation", "type": "object" }, "required": false, "id": "SegmentLocationsList", "type": "array" }, "server_component_name": { "description": "Server component name.", "required": true, "type": "string" }, "name": { "description": "Service segment name.", "required": true, "type": "string" }, "type": { "description": "Service segment type.", "required": false, "type": "string", "enum": [ "FRONT_END", "BACK_END" ] }, "monitored_metrics": { "description": "Monitored segment metrics.", "items": { "description": "Segment metrics.", "required": false, "properties": { "id": { "description": "Metric id.", "required": true, "type": "number" } }, "id": "SegmentMetric", "type": "object" }, "required": true, "id": "SegmentMetricsList", "type": "array" }, "location_type": { "description": "Location type.", "required": false, "type": "string", "enum": [ "ALL", "SUBSET" ] }, "server_component_id": { "description": "Server component id.", "required": false, "type": "number" }, "client_component_name": { "description": "Client component name.", "required": true, "type": "string" } }, "id": "ServiceSegment", "type": "object" }, "required": true, "id": "ServiceSegmentsList", "type": "array" }, "id": { "description": "Service id.", "required": false, "type": "number" }, "description": { "description": "Service description.", "required": true, "type": "string" }, "name": { "description": "Service name.", "required": true, "type": "string" }, "locked_by_user_id": { "description": "Account id of the user currently editing this Service if any.", "required": false, "type": "number" }, "policies": { "description": "Service policies.", "items": { "description": "Policies defined for this business service.", "required": false, "properties": { "id": { "description": "Service policy id.", "required": false, "type": "number" }, "tuning_parameters": { "description": "Tuning parameters.", "required": true, "properties": { "id": { "description": "Service policy parameter id.", "required": true, "type": "number" }, "tolerance_high": { "description": "Service policy high tolerance threshold.", "required": true, "type": "number" }, "name": { "description": "Service policy parameter name.", "required": true, "type": "string" }, "tolerance_low": { "description": "Service policy low tolerance threshold.", "required": true, "type": "number" }, "noise_floor": { "description": "Service policy noise floor.", "required": true, "type": "string" }, "duration": { "description": "Service policy duration.", "required": true, "type": "number" }, "trigger_on_decreases": { "description": "Service policy trigger on decreases.", "required": true, "type": "string" }, "trigger_on_increases": { "description": "Service policy trigger on increases.", "required": true, "type": "string" } }, "id": "ServicePolicyParams", "type": "object" }, "name": { "description": "Service policy name.", "required": true, "type": "string" } }, "id": "ServicePolicy", "type": "object" }, "required": true, "id": "ServicePoliciesList", "type": "array" } }, "id": "ServiceConfig", "type": "object", "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" } }, "httpmethod": "POST", "path": "services", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get components": { "description": "Manage components of one business service.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting element number." }, "sortby": { "required": false, "type": "string", "description": "Sorting field name." }, "sort": { "required": false, "type": "string", "description": "Sorting direction: 'asc' or 'desc' (default: 'asc')." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "services/{service_id}/components", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of components defined for this business service.", "items": { "description": "Components defined for this business service.", "required": false, "properties": { "id": { "description": "Service component id.", "required": false, "type": "number" }, "definition": { "description": "Service component definition.", "required": true, "properties": { "snat_type": { "description": "Snat type.", "required": false, "type": "string", "enum": [ "NOT_USED", "SOMETIMES", "ALWAYS" ] }, "vips": { "description": "Vips if any.", "items": { "description": "Load balancer virtual server.", "required": false, "properties": { "port": { "description": "Port.", "required": true, "type": "number" }, "protocol": { "description": "Protocol.", "required": true, "type": "number" }, "ipaddr": { "description": "IP address.", "required": true, "type": "string" } }, "id": "LBVirtualServer", "type": "object" }, "required": false, "id": "LBVirtualServers", "type": "array" }, "load_balancer": { "description": "Load balancer if any.", "required": false, "type": "number" }, "outside_hosts": { "description": "Hosts/subnets excluded from component definition if any.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" }, "manual": { "description": "Manual flag.", "required": false, "type": "string" }, "within_hosts": { "description": "Hosts/subnets included into component definition.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" }, "snats": { "description": "Snats if any.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" } }, "id": "ServiceComponentDefinition", "type": "object" }, "name": { "description": "Service component name.", "required": true, "type": "string" }, "type": { "description": "Service component type.", "required": true, "type": "string", "enum": [ "END_USERS", "SERVERS", "LBVS", "LBRS" ] } }, "id": "ServiceComponent", "type": "object" }, "id": "ServiceComponentsList", "type": "array", "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 } ] }, "authorization": "required" }, "List business services": { "description": "List business services.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting element number." }, "sortby": { "required": false, "type": "string", "description": "Sorting field name." }, "sort": { "required": false, "type": "string", "description": "Sorting direction: 'asc' or 'desc' (default: 'asc')." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "services", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of business services defined on Profiler.", "items": { "description": "Business service defined on Profiler.", "required": false, "properties": { "id": { "description": "Service id.", "required": true, "type": "number" }, "status": { "description": "Service state.", "required": true, "type": "string", "enum": [ "MONITORED", "COMMITTING", "ERROR", "DISABLED" ] }, "description": { "description": "Service description.", "required": true, "type": "string" }, "name": { "description": "Service name.", "required": true, "type": "string" }, "error": { "description": "Commit error if any.", "required": false, "type": "string" } }, "id": "ServiceInfo", "type": "object" }, "id": "ServiceList", "type": "array", "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" } ] }, "authorization": "required" }, "Update existing business service": { "description": "Update existing business service.", "request": { "description": "Object representing a business service.", "properties": { "alert_notification": { "description": "Alert notification flag.", "required": true, "properties": { "high_enabled": { "description": "High alert enabled flag.", "required": true, "type": "string" }, "low_alert_recipient": { "description": "Low alert recipient.", "required": true, "type": "string" }, "low_enabled": { "description": "Low alert enabled flag.", "required": true, "type": "string" }, "high_alert_recipient": { "description": "High alert recipient.", "required": true, "type": "string" } }, "id": "ServiceAlertNotification", "type": "object" }, "components": { "description": "Service components.", "items": { "description": "Components defined for this business service.", "required": false, "properties": { "id": { "description": "Service component id.", "required": false, "type": "number" }, "definition": { "description": "Service component definition.", "required": true, "properties": { "snat_type": { "description": "Snat type.", "required": false, "type": "string", "enum": [ "NOT_USED", "SOMETIMES", "ALWAYS" ] }, "vips": { "description": "Vips if any.", "items": { "description": "Load balancer virtual server.", "required": false, "properties": { "port": { "description": "Port.", "required": true, "type": "number" }, "protocol": { "description": "Protocol.", "required": true, "type": "number" }, "ipaddr": { "description": "IP address.", "required": true, "type": "string" } }, "id": "LBVirtualServer", "type": "object" }, "required": false, "id": "LBVirtualServers", "type": "array" }, "load_balancer": { "description": "Load balancer if any.", "required": false, "type": "number" }, "outside_hosts": { "description": "Hosts/subnets excluded from component definition if any.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" }, "manual": { "description": "Manual flag.", "required": false, "type": "string" }, "within_hosts": { "description": "Hosts/subnets included into component definition.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" }, "snats": { "description": "Snats if any.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" } }, "id": "ServiceComponentDefinition", "type": "object" }, "name": { "description": "Service component name.", "required": true, "type": "string" }, "type": { "description": "Service component type.", "required": true, "type": "string", "enum": [ "END_USERS", "SERVERS", "LBVS", "LBRS" ] } }, "id": "ServiceComponent", "type": "object" }, "required": true, "id": "ServiceComponentsList", "type": "array" }, "segments": { "description": "Service segments.", "items": { "description": "Segments defined for this business service.", "required": false, "properties": { "alert_notification": { "description": "Alert notification flag.", "required": true, "type": "string" }, "id": { "description": "Service segment id.", "required": false, "type": "number" }, "definition": { "description": "Segment definition.", "items": { "description": "Service segment definition.", "required": false, "type": "string" }, "required": true, "id": "ServiceSegmentDefinition", "type": "array" }, "client_component_id": { "description": "Client component id.", "required": false, "type": "number" }, "status": { "description": "Service segment status.", "required": false, "type": "string", "enum": [ "ADDED", "DROPPED", "UNDECIDED" ] }, "locations": { "description": "Segment locations.", "items": { "description": "Segment locations.", "required": false, "properties": { "host_group_type_id": { "description": "Host group type id.", "required": true, "type": "number" }, "host_group_id": { "description": "Host group id.", "required": true, "type": "number" }, "location_id": { "description": "Location id.", "required": false, "type": "number" } }, "id": "SegmentLocation", "type": "object" }, "required": false, "id": "SegmentLocationsList", "type": "array" }, "server_component_name": { "description": "Server component name.", "required": true, "type": "string" }, "name": { "description": "Service segment name.", "required": true, "type": "string" }, "type": { "description": "Service segment type.", "required": false, "type": "string", "enum": [ "FRONT_END", "BACK_END" ] }, "monitored_metrics": { "description": "Monitored segment metrics.", "items": { "description": "Segment metrics.", "required": false, "properties": { "id": { "description": "Metric id.", "required": true, "type": "number" } }, "id": "SegmentMetric", "type": "object" }, "required": true, "id": "SegmentMetricsList", "type": "array" }, "location_type": { "description": "Location type.", "required": false, "type": "string", "enum": [ "ALL", "SUBSET" ] }, "server_component_id": { "description": "Server component id.", "required": false, "type": "number" }, "client_component_name": { "description": "Client component name.", "required": true, "type": "string" } }, "id": "ServiceSegment", "type": "object" }, "required": true, "id": "ServiceSegmentsList", "type": "array" }, "id": { "description": "Service id.", "required": false, "type": "number" }, "description": { "description": "Service description.", "required": true, "type": "string" }, "name": { "description": "Service name.", "required": true, "type": "string" }, "locked_by_user_id": { "description": "Account id of the user currently editing this Service if any.", "required": false, "type": "number" }, "policies": { "description": "Service policies.", "items": { "description": "Policies defined for this business service.", "required": false, "properties": { "id": { "description": "Service policy id.", "required": false, "type": "number" }, "tuning_parameters": { "description": "Tuning parameters.", "required": true, "properties": { "id": { "description": "Service policy parameter id.", "required": true, "type": "number" }, "tolerance_high": { "description": "Service policy high tolerance threshold.", "required": true, "type": "number" }, "name": { "description": "Service policy parameter name.", "required": true, "type": "string" }, "tolerance_low": { "description": "Service policy low tolerance threshold.", "required": true, "type": "number" }, "noise_floor": { "description": "Service policy noise floor.", "required": true, "type": "string" }, "duration": { "description": "Service policy duration.", "required": true, "type": "number" }, "trigger_on_decreases": { "description": "Service policy trigger on decreases.", "required": true, "type": "string" }, "trigger_on_increases": { "description": "Service policy trigger on increases.", "required": true, "type": "string" } }, "id": "ServicePolicyParams", "type": "object" }, "name": { "description": "Service policy name.", "required": true, "type": "string" } }, "id": "ServicePolicy", "type": "object" }, "required": true, "id": "ServicePoliciesList", "type": "array" } }, "id": "ServiceConfig", "type": "object", "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" } }, "httpmethod": "PUT", "path": "services/{service_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List business service": { "description": "List business service.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "services/{service_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a business service.", "properties": { "alert_notification": { "description": "Alert notification flag.", "required": true, "properties": { "high_enabled": { "description": "High alert enabled flag.", "required": true, "type": "string" }, "low_alert_recipient": { "description": "Low alert recipient.", "required": true, "type": "string" }, "low_enabled": { "description": "Low alert enabled flag.", "required": true, "type": "string" }, "high_alert_recipient": { "description": "High alert recipient.", "required": true, "type": "string" } }, "id": "ServiceAlertNotification", "type": "object" }, "components": { "description": "Service components.", "items": { "description": "Components defined for this business service.", "required": false, "properties": { "id": { "description": "Service component id.", "required": false, "type": "number" }, "definition": { "description": "Service component definition.", "required": true, "properties": { "snat_type": { "description": "Snat type.", "required": false, "type": "string", "enum": [ "NOT_USED", "SOMETIMES", "ALWAYS" ] }, "vips": { "description": "Vips if any.", "items": { "description": "Load balancer virtual server.", "required": false, "properties": { "port": { "description": "Port.", "required": true, "type": "number" }, "protocol": { "description": "Protocol.", "required": true, "type": "number" }, "ipaddr": { "description": "IP address.", "required": true, "type": "string" } }, "id": "LBVirtualServer", "type": "object" }, "required": false, "id": "LBVirtualServers", "type": "array" }, "load_balancer": { "description": "Load balancer if any.", "required": false, "type": "number" }, "outside_hosts": { "description": "Hosts/subnets excluded from component definition if any.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" }, "manual": { "description": "Manual flag.", "required": false, "type": "string" }, "within_hosts": { "description": "Hosts/subnets included into component definition.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" }, "snats": { "description": "Snats if any.", "items": { "description": "Host/subnet string.", "required": false, "type": "string" }, "required": false, "id": "CriteriaPrefixes", "type": "array" } }, "id": "ServiceComponentDefinition", "type": "object" }, "name": { "description": "Service component name.", "required": true, "type": "string" }, "type": { "description": "Service component type.", "required": true, "type": "string", "enum": [ "END_USERS", "SERVERS", "LBVS", "LBRS" ] } }, "id": "ServiceComponent", "type": "object" }, "required": true, "id": "ServiceComponentsList", "type": "array" }, "segments": { "description": "Service segments.", "items": { "description": "Segments defined for this business service.", "required": false, "properties": { "alert_notification": { "description": "Alert notification flag.", "required": true, "type": "string" }, "id": { "description": "Service segment id.", "required": false, "type": "number" }, "definition": { "description": "Segment definition.", "items": { "description": "Service segment definition.", "required": false, "type": "string" }, "required": true, "id": "ServiceSegmentDefinition", "type": "array" }, "client_component_id": { "description": "Client component id.", "required": false, "type": "number" }, "status": { "description": "Service segment status.", "required": false, "type": "string", "enum": [ "ADDED", "DROPPED", "UNDECIDED" ] }, "locations": { "description": "Segment locations.", "items": { "description": "Segment locations.", "required": false, "properties": { "host_group_type_id": { "description": "Host group type id.", "required": true, "type": "number" }, "host_group_id": { "description": "Host group id.", "required": true, "type": "number" }, "location_id": { "description": "Location id.", "required": false, "type": "number" } }, "id": "SegmentLocation", "type": "object" }, "required": false, "id": "SegmentLocationsList", "type": "array" }, "server_component_name": { "description": "Server component name.", "required": true, "type": "string" }, "name": { "description": "Service segment name.", "required": true, "type": "string" }, "type": { "description": "Service segment type.", "required": false, "type": "string", "enum": [ "FRONT_END", "BACK_END" ] }, "monitored_metrics": { "description": "Monitored segment metrics.", "items": { "description": "Segment metrics.", "required": false, "properties": { "id": { "description": "Metric id.", "required": true, "type": "number" } }, "id": "SegmentMetric", "type": "object" }, "required": true, "id": "SegmentMetricsList", "type": "array" }, "location_type": { "description": "Location type.", "required": false, "type": "string", "enum": [ "ALL", "SUBSET" ] }, "server_component_id": { "description": "Server component id.", "required": false, "type": "number" }, "client_component_name": { "description": "Client component name.", "required": true, "type": "string" } }, "id": "ServiceSegment", "type": "object" }, "required": true, "id": "ServiceSegmentsList", "type": "array" }, "id": { "description": "Service id.", "required": false, "type": "number" }, "description": { "description": "Service description.", "required": true, "type": "string" }, "name": { "description": "Service name.", "required": true, "type": "string" }, "locked_by_user_id": { "description": "Account id of the user currently editing this Service if any.", "required": false, "type": "number" }, "policies": { "description": "Service policies.", "items": { "description": "Policies defined for this business service.", "required": false, "properties": { "id": { "description": "Service policy id.", "required": false, "type": "number" }, "tuning_parameters": { "description": "Tuning parameters.", "required": true, "properties": { "id": { "description": "Service policy parameter id.", "required": true, "type": "number" }, "tolerance_high": { "description": "Service policy high tolerance threshold.", "required": true, "type": "number" }, "name": { "description": "Service policy parameter name.", "required": true, "type": "string" }, "tolerance_low": { "description": "Service policy low tolerance threshold.", "required": true, "type": "number" }, "noise_floor": { "description": "Service policy noise floor.", "required": true, "type": "string" }, "duration": { "description": "Service policy duration.", "required": true, "type": "number" }, "trigger_on_decreases": { "description": "Service policy trigger on decreases.", "required": true, "type": "string" }, "trigger_on_increases": { "description": "Service policy trigger on increases.", "required": true, "type": "string" } }, "id": "ServicePolicyParams", "type": "object" }, "name": { "description": "Service policy name.", "required": true, "type": "string" } }, "id": "ServicePolicy", "type": "object" }, "required": true, "id": "ServicePoliciesList", "type": "array" } }, "id": "ServiceConfig", "type": "object", "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" } }, "authorization": "required" }, "Get service thumbnail": { "description": "Get service diagram as a PNG image.", "parameters": { "width": { "required": false, "type": "number", "description": "Image width in pixels (570 by default)." }, "height": { "required": false, "type": "number", "description": "Image height in pixels (270 by default)." } }, "formats": [ "png" ], "httpmethod": "GET", "path": "services/{service_id}/thumbnail", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get policies": { "description": "Manage policies of one business service.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting element number." }, "sortby": { "required": false, "type": "string", "description": "Sorting field name." }, "sort": { "required": false, "type": "string", "description": "Sorting direction: 'asc' or 'desc' (default: 'asc')." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "services/{service_id}/policies", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of service policies defined for this business service.", "items": { "description": "Policies defined for this business service.", "required": false, "properties": { "id": { "description": "Service policy id.", "required": false, "type": "number" }, "tuning_parameters": { "description": "Tuning parameters.", "required": true, "properties": { "id": { "description": "Service policy parameter id.", "required": true, "type": "number" }, "tolerance_high": { "description": "Service policy high tolerance threshold.", "required": true, "type": "number" }, "name": { "description": "Service policy parameter name.", "required": true, "type": "string" }, "tolerance_low": { "description": "Service policy low tolerance threshold.", "required": true, "type": "number" }, "noise_floor": { "description": "Service policy noise floor.", "required": true, "type": "string" }, "duration": { "description": "Service policy duration.", "required": true, "type": "number" }, "trigger_on_decreases": { "description": "Service policy trigger on decreases.", "required": true, "type": "string" }, "trigger_on_increases": { "description": "Service policy trigger on increases.", "required": true, "type": "string" } }, "id": "ServicePolicyParams", "type": "object" }, "name": { "description": "Service policy name.", "required": true, "type": "string" } }, "id": "ServicePolicy", "type": "object" }, "id": "ServicePoliciesList", "type": "array", "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 } } ] }, "authorization": "required" }, "Get segments": { "description": "Manage segments of one business service.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting element number." }, "sortby": { "required": false, "type": "string", "description": "Sorting field name." }, "sort": { "required": false, "type": "string", "description": "Sorting direction: 'asc' or 'desc' (default: 'asc')." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "services/{service_id}/segments", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of segments defined for this business service.", "items": { "description": "Segments defined for this business service.", "required": false, "properties": { "alert_notification": { "description": "Alert notification flag.", "required": true, "type": "string" }, "id": { "description": "Service segment id.", "required": false, "type": "number" }, "definition": { "description": "Segment definition.", "items": { "description": "Service segment definition.", "required": false, "type": "string" }, "required": true, "id": "ServiceSegmentDefinition", "type": "array" }, "client_component_id": { "description": "Client component id.", "required": false, "type": "number" }, "status": { "description": "Service segment status.", "required": false, "type": "string", "enum": [ "ADDED", "DROPPED", "UNDECIDED" ] }, "locations": { "description": "Segment locations.", "items": { "description": "Segment locations.", "required": false, "properties": { "host_group_type_id": { "description": "Host group type id.", "required": true, "type": "number" }, "host_group_id": { "description": "Host group id.", "required": true, "type": "number" }, "location_id": { "description": "Location id.", "required": false, "type": "number" } }, "id": "SegmentLocation", "type": "object" }, "required": false, "id": "SegmentLocationsList", "type": "array" }, "server_component_name": { "description": "Server component name.", "required": true, "type": "string" }, "name": { "description": "Service segment name.", "required": true, "type": "string" }, "type": { "description": "Service segment type.", "required": false, "type": "string", "enum": [ "FRONT_END", "BACK_END" ] }, "monitored_metrics": { "description": "Monitored segment metrics.", "items": { "description": "Segment metrics.", "required": false, "properties": { "id": { "description": "Metric id.", "required": true, "type": "number" } }, "id": "SegmentMetric", "type": "object" }, "required": true, "id": "SegmentMetricsList", "type": "array" }, "location_type": { "description": "Location type.", "required": false, "type": "string", "enum": [ "ALL", "SUBSET" ] }, "server_component_id": { "description": "Server component id.", "required": false, "type": "number" }, "client_component_name": { "description": "Client component name.", "required": true, "type": "string" } }, "id": "ServiceSegment", "type": "object" }, "id": "ServiceSegmentsList", "type": "array", "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" } ] }, "authorization": "required" } } }, "Vnis": { "methods": { "List VNIs": { "description": "Get a list of Virtual Network Identifiers.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "vnis", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of VNIs (Virtual Network Identifiers of SDN setup).", "items": { "description": "Object representing a VNI.", "required": false, "properties": { "id": { "description": "ID of the VNI.", "required": true, "type": "number" }, "description": { "description": "Description of the VNI.", "required": false, "type": "string" }, "name": { "description": "Name of the VNI.", "required": false, "type": "string" } }, "id": "VNI", "type": "object" }, "id": "VNIs", "type": "array", "example": [ { "description": "Customer A. Blue Network.", "name": "Blue_Network", "id": 100 }, { "description": "Customer B. Blue Network.", "name": "Red_Network", "id": 200 } ] }, "authorization": "required" }, "Delete VNI": { "description": "Delete a Virtual Network Identifier.", "httpmethod": "DELETE", "path": "vnis/{vni_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Update VNIs": { "description": "Update one or many Virtual Network Identifiers.", "request": { "description": "List of VNIs (Virtual Network Identifiers of SDN setup).", "items": { "description": "Object representing a VNI.", "required": false, "properties": { "id": { "description": "ID of the VNI.", "required": true, "type": "number" }, "description": { "description": "Description of the VNI.", "required": false, "type": "string" }, "name": { "description": "Name of the VNI.", "required": false, "type": "string" } }, "id": "VNI", "type": "object" }, "id": "VNIs", "type": "array", "example": [ { "description": "Customer A. Blue Network.", "name": "Blue_Network", "id": 100 }, { "description": "Customer B. Blue Network.", "name": "Red_Network", "id": 200 } ] }, "httpmethod": "PUT", "path": "vnis", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get VNI": { "description": "Get a Virtual Network Identifier.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "vnis/{vni_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a VNI.", "properties": { "id": { "description": "ID of the VNI.", "required": true, "type": "number" }, "description": { "description": "Description of the VNI.", "required": false, "type": "string" }, "name": { "description": "Name of the VNI.", "required": false, "type": "string" } }, "id": "VNI", "type": "object", "example": { "description": "Customer A. Blue Network.", "name": "Blue_Network", "id": 100 } }, "authorization": "required" }, "Update VNI": { "description": "Update one Virtual Network Identifier.", "request": { "description": "Object representing a VNI.", "properties": { "id": { "description": "ID of the VNI.", "required": true, "type": "number" }, "description": { "description": "Description of the VNI.", "required": false, "type": "string" }, "name": { "description": "Name of the VNI.", "required": false, "type": "string" } }, "id": "VNI", "type": "object", "example": { "description": "Customer A. Blue Network.", "name": "Blue_Network", "id": 100 } }, "httpmethod": "PUT", "path": "vnis/{vni_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" } } }, "Recipients": { "methods": { "List recipients": { "description": "Get a list of recipients.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "recipients", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of recipient.", "items": { "description": "Object representing a recipient.", "required": false, "properties": { "id": { "description": "Recipient Number.", "required": true, "type": "number" }, "snmp_trap": { "description": "Snmp trap recipient.", "required": false, "properties": { "snmp_trap_addresses": { "description": "List of SNMPtrapAddress.", "items": { "description": "Object representing a snmp trap address.", "required": false, "properties": { "port": { "description": "Port number for the IP address.", "required": true, "type": "number" }, "ipaddr": { "description": "IP address of a snmp trap recipient.", "required": true, "type": "string" } }, "id": "SNMPTrapAddress", "type": "object" }, "required": true, "id": "SNMPTrapAddresses", "type": "array" }, "version": { "description": "snmp trap version, V1, V2, V3.", "required": true, "type": "string", "enum": [ "V1", "V2C", "V3" ] } }, "id": "SNMPTrapRecipient", "type": "object" }, "name": { "description": "Recipient Notification Label.", "required": true, "type": "string" }, "email": { "description": "Email recipient.", "required": false, "properties": { "format": { "description": "Format of a recipient's email, PDF or HTML.", "required": true, "type": "string", "enum": [ "EMAIL_FORMAT_PDF", "EMAIL_FORMAT_HTML" ] }, "address": { "description": "Email address of a recipient.", "required": true, "type": "string" } }, "id": "EmailRecipient", "type": "object" } }, "id": "Recipient", "type": "object" }, "id": "RecipientList", "type": "array", "example": [ { "id": -1, "name": "* Log Only" }, { "id": 1, "name": "Default" }, { "id": 2, "snmp_trap": { "snmp_trap_addresses": [ { "ipaddr": "10.0.0.1", "port": 10 }, { "ipaddr": "10.1.1.2", "port": 20 } ], "version": "V1" }, "email": { "address": "example@riverbed.com", "format": "EMAIL_FORMAT_PDF" }, "name": "example_name" } ] }, "authorization": "required" }, "Get recipient": { "description": "Get a recipient by id.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "recipients/{id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a recipient.", "properties": { "id": { "description": "Recipient Number.", "required": true, "type": "number" }, "snmp_trap": { "description": "Snmp trap recipient.", "required": false, "properties": { "snmp_trap_addresses": { "description": "List of SNMPtrapAddress.", "items": { "description": "Object representing a snmp trap address.", "required": false, "properties": { "port": { "description": "Port number for the IP address.", "required": true, "type": "number" }, "ipaddr": { "description": "IP address of a snmp trap recipient.", "required": true, "type": "string" } }, "id": "SNMPTrapAddress", "type": "object" }, "required": true, "id": "SNMPTrapAddresses", "type": "array" }, "version": { "description": "snmp trap version, V1, V2, V3.", "required": true, "type": "string", "enum": [ "V1", "V2C", "V3" ] } }, "id": "SNMPTrapRecipient", "type": "object" }, "name": { "description": "Recipient Notification Label.", "required": true, "type": "string" }, "email": { "description": "Email recipient.", "required": false, "properties": { "format": { "description": "Format of a recipient's email, PDF or HTML.", "required": true, "type": "string", "enum": [ "EMAIL_FORMAT_PDF", "EMAIL_FORMAT_HTML" ] }, "address": { "description": "Email address of a recipient.", "required": true, "type": "string" } }, "id": "EmailRecipient", "type": "object" } }, "id": "Recipient", "type": "object", "example": { "id": 128, "snmp_trap": { "snmp_trap_addresses": [ { "ipaddr": "10.0.0.1", "port": 10 }, { "ipaddr": "10.1.1.2", "port": 20 } ], "version": "V1" }, "email": { "address": "example@riverbed.com", "format": "EMAIL_FORMAT_PDF" }, "name": "example_name" } }, "authorization": "required" } } }, "Steelheads": { "methods": { "Disable Steelhead polling": { "description": "Disables data polling from Steelheads.", "request": { "description": "IP addresses object representing the list of Steelheads.", "items": { "description": "IP address collection object representing the list of Steelheads.", "required": false, "properties": { "ipaddr": { "description": "IP address representing a Steelhead.", "required": true, "type": "string" } }, "id": "SteelheadIPAddr", "type": "object" }, "id": "SteelheadIPAddrs", "type": "array", "example": [ { "ipaddr": "10.99.16.252" }, { "ipaddr": "10.99.15.252" }, { "ipaddr": "10.99.14.252" } ] }, "httpmethod": "POST", "path": "steelheads/sync/disable", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Enable Steelhead polling": { "description": "Enables data polling from Steelheads.", "request": { "description": "IP addresses object representing the list of Steelheads.", "items": { "description": "IP address collection object representing the list of Steelheads.", "required": false, "properties": { "ipaddr": { "description": "IP address representing a Steelhead.", "required": true, "type": "string" } }, "id": "SteelheadIPAddr", "type": "object" }, "id": "SteelheadIPAddrs", "type": "array", "example": [ { "ipaddr": "10.99.16.252" }, { "ipaddr": "10.99.15.252" }, { "ipaddr": "10.99.14.252" } ] }, "httpmethod": "POST", "path": "steelheads/sync/enable", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Delete Steelheads global OAuth": { "description": "Deletes global OAuth code.", "httpmethod": "DELETE", "path": "steelheads/oauth_code/global", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get Steelheads OAuth codes": { "description": "Get a list of steelheads CIDRs with OAuth code configured.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "steelheads/oauth_code", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of Cidr Objects.", "items": { "description": "Object representing an IP address, CIDR.", "required": false, "properties": { "cidr": { "description": "IP address, CIDR.", "required": true, "type": "string" } }, "id": "Cidr", "type": "object" }, "id": "Cidrs", "type": "array", "example": [ { "cidr": "10.10.0.60" }, { "cidr": "0/0" }, { "cidr": "10/8" } ] }, "authorization": "required" }, "Update Steelheads OAuth codes": { "description": "Creates or Updates Oauth Codes for a list of Steelheads.", "request": { "description": "List of OAuth code Objects.", "items": { "description": "Object representing an IP address, CIDR and its OAuth code.", "required": false, "properties": { "code": { "description": "OAuth code.", "required": true, "type": "string" }, "cidr": { "description": "IP address, CIDR.", "required": true, "type": "string" } }, "id": "Oauthcode", "type": "object" }, "id": "Oauthcodes", "type": "array", "example": [ { "cidr": "10.20.0.60", "code": "code_ip" }, { "cidr": "0/0", "code": "code_global" }, { "cidr": "10/8", "code": "code_region" } ] }, "httpmethod": "PUT", "path": "steelheads/oauth_code", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Sync Steelheads QoS data": { "description": "Retrieves QoS data from Steelheads on which polling is enabled.", "request": { "description": "IP addresses object representing the list of Steelheads.", "items": { "description": "IP address collection object representing the list of Steelheads.", "required": false, "properties": { "ipaddr": { "description": "IP address representing a Steelhead.", "required": true, "type": "string" } }, "id": "SteelheadIPAddr", "type": "object" }, "id": "SteelheadIPAddrs", "type": "array", "example": [ { "ipaddr": "10.99.16.252" }, { "ipaddr": "10.99.15.252" }, { "ipaddr": "10.99.14.252" } ] }, "httpmethod": "POST", "path": "steelheads/qos/sync", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Sync Steelhead apps": { "description": "Retrieves application data from Steelheads on which polling is enabled.", "request": { "description": "IP addresses object representing the list of Steelheads.", "items": { "description": "IP address collection object representing the list of Steelheads.", "required": false, "properties": { "ipaddr": { "description": "IP address representing a Steelhead.", "required": true, "type": "string" } }, "id": "SteelheadIPAddr", "type": "object" }, "id": "SteelheadIPAddrs", "type": "array", "example": [ { "ipaddr": "10.99.16.252" }, { "ipaddr": "10.99.15.252" }, { "ipaddr": "10.99.14.252" } ] }, "httpmethod": "POST", "path": "steelheads/apps/sync", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get Steelheads": { "description": "Get a Steelhead QoS Global Configuration by IP address.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "steelheads/{steelhead_ip}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a steelhead.", "properties": { "dpi": { "description": "Flag indicating if Deep Packet Inspection (DPI) is enabled on this Steelhead.", "required": false, "type": "string" }, "marking": { "description": "Flag indicating if QoS Marking is enabled on this Steelhead.", "required": false, "type": "string" }, "sync": { "description": "Object representing Steelhead syncronization information.", "required": true, "properties": { "apps": { "description": "Object representing Steelhead application syncronization information.", "required": true, "properties": { "enabled": { "description": "Flag - Enable application synchronization.", "required": true, "type": "string" }, "error_text": { "description": "Error description.", "required": true, "type": "string" }, "last_sync_ts": { "description": "Last attempted application synchronization time.", "required": true, "type": "number" }, "last_success_ts": { "description": "Last successful application synchronization time.", "required": true, "type": "number" }, "error_id": { "description": "Error ID.", "required": true, "type": "number" }, "state": { "description": "Synchronization status.", "required": true, "type": "string", "enum": [ "SYNC_INITIALIZING", "SYNC_FAILED", "SYNC_SUCCEEDED", "SYNC_DISABLED", "SYNC_NA" ] } }, "id": "SteelheadAppsObject", "type": "object" }, "qos": { "description": "Object representing Steelhead QoS syncronization information.", "required": true, "properties": { "enabled": { "description": "Flag indicating if QoS synchronization is enabled on this Steelhead.", "required": true, "type": "string" }, "error_text": { "description": "Error description.", "required": true, "type": "string" }, "last_sync_ts": { "description": "Last attempted QoS syncronization time.", "required": true, "type": "number" }, "last_success_ts": { "description": "Last successful QoS syncronization time.", "required": true, "type": "number" }, "error_id": { "description": "Error ID.", "required": true, "type": "number" }, "state": { "description": "Synchronization status.", "required": true, "type": "string", "enum": [ "SYNC_INITIALIZING", "SYNC_FAILED", "SYNC_SUCCEEDED", "SYNC_DISABLED", "SYNC_NA" ] } }, "id": "SteelheadQosObject", "type": "object" } }, "id": "SteelheadSyncObject", "type": "object" }, "ipaddr": { "description": "Steelhead IP address.", "required": true, "type": "string" }, "name": { "description": "Steelhead name.", "required": true, "type": "string" }, "oauth_custom": { "description": "Flag indicating if Custom OAuth code is configured on this Steelhead.", "required": true, "type": "string" }, "hier_mode": { "description": "Flag indicating if QoS Hierarchical Mode is enabled on this Steelhead.", "required": false, "type": "string" }, "shaping": { "description": "Flag indicating if QoS Shaping is enabled on this Steelhead.", "required": false, "type": "string" }, "easy_mode": { "description": "Flag indicating which QoS Configuration Mode (Basic/Advanced) is set (Basic if true).", "required": false, "type": "string" }, "bw_overcommit": { "description": "Flag indicating if QoS Bandwidth Overcommit is enabled on this Steelhead.", "required": false, "type": "string" } }, "id": "Steelhead", "type": "object", "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 } }, "authorization": "required" }, "Delete Steelheads OAuth codes": { "description": "Deletes OAuth codes for a list of Steelheads.", "request": { "description": "List of Cidr Objects.", "items": { "description": "Object representing an IP address, CIDR.", "required": false, "properties": { "cidr": { "description": "IP address, CIDR.", "required": true, "type": "string" } }, "id": "Cidr", "type": "object" }, "id": "Cidrs", "type": "array", "example": [ { "cidr": "10.10.0.60" }, { "cidr": "0/0" }, { "cidr": "10/8" } ] }, "httpmethod": "DELETE", "path": "steelheads/oauth_code", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Update Steelheads global OAuth": { "description": "Creates or Updates global OAuth code.", "request": { "description": "Global OAuth code object.", "properties": { "code": { "description": "OAuth Code.", "required": true, "type": "string" } }, "id": "Globalcode", "type": "object", "example": { "code": "code_global" } }, "httpmethod": "PUT", "path": "steelheads/oauth_code/global", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List Steelheads": { "description": "Get a list of Steelheads and their QoS global and application configuration.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "steelheads", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of Steelheads and their QoS and Application configuration data.", "items": { "description": "Steelhead QoS and Application Configuration Data.", "required": false, "properties": { "dpi": { "description": "Flag indicating if Deep Packet Inspection (DPI) is enabled on this Steelhead.", "required": false, "type": "string" }, "marking": { "description": "Flag indicating if QoS Marking is enabled on this Steelhead.", "required": false, "type": "string" }, "sync": { "description": "Object representing Steelhead syncronization information.", "required": true, "properties": { "apps": { "description": "Object representing Steelhead application syncronization information.", "required": true, "properties": { "enabled": { "description": "Flag - Enable application synchronization.", "required": true, "type": "string" }, "error_text": { "description": "Error description.", "required": true, "type": "string" }, "last_sync_ts": { "description": "Last attempted application synchronization time.", "required": true, "type": "number" }, "last_success_ts": { "description": "Last successful application synchronization time.", "required": true, "type": "number" }, "error_id": { "description": "Error ID.", "required": true, "type": "number" }, "state": { "description": "Synchronization status.", "required": true, "type": "string", "enum": [ "SYNC_INITIALIZING", "SYNC_FAILED", "SYNC_SUCCEEDED", "SYNC_DISABLED", "SYNC_NA" ] } }, "id": "SteelheadAppsObject", "type": "object" }, "qos": { "description": "Object representing Steelhead QoS syncronization information.", "required": true, "properties": { "enabled": { "description": "Flag indicating if QoS synchronization is enabled on this Steelhead.", "required": true, "type": "string" }, "error_text": { "description": "Error description.", "required": true, "type": "string" }, "last_sync_ts": { "description": "Last attempted QoS syncronization time.", "required": true, "type": "number" }, "last_success_ts": { "description": "Last successful QoS syncronization time.", "required": true, "type": "number" }, "error_id": { "description": "Error ID.", "required": true, "type": "number" }, "state": { "description": "Synchronization status.", "required": true, "type": "string", "enum": [ "SYNC_INITIALIZING", "SYNC_FAILED", "SYNC_SUCCEEDED", "SYNC_DISABLED", "SYNC_NA" ] } }, "id": "SteelheadQosObject", "type": "object" } }, "id": "SteelheadSyncObject", "type": "object" }, "ipaddr": { "description": "Steelhead IP address.", "required": true, "type": "string" }, "name": { "description": "Steelhead name.", "required": true, "type": "string" }, "oauth_custom": { "description": "Flag indicating if Custom OAuth code is configured on this Steelhead.", "required": true, "type": "string" }, "hier_mode": { "description": "Flag indicating if QoS Hierarchical Mode is enabled on this Steelhead.", "required": false, "type": "string" }, "shaping": { "description": "Flag indicating if QoS Shaping is enabled on this Steelhead.", "required": false, "type": "string" }, "easy_mode": { "description": "Flag indicating which QoS Configuration Mode (Basic/Advanced) is set (Basic if true).", "required": false, "type": "string" }, "bw_overcommit": { "description": "Flag indicating if QoS Bandwidth Overcommit is enabled on this Steelhead.", "required": false, "type": "string" } }, "id": "Steelhead", "type": "object" }, "id": "Steelheads", "type": "array", "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 } ] }, "authorization": "required" }, "Ping Steelhead": { "description": "Pings a Steelhead by IP address.", "httpmethod": "GET", "path": "steelheads/{steelhead_ip}/ping", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Check Steelheads global OAuth": { "description": "Checks if the global OAuth code is configured.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "steelheads/oauth_code/global", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing the global OAuth code is configured.", "properties": { "configured": { "description": "True if the global ouath code is configured.", "required": true, "type": "string" } }, "id": "Oauthcodeglobal", "type": "object", "example": { "configured": true } }, "authorization": "required" } } }, "Devices": { "methods": { "Enable REST polling": { "description": "Globally disable REST polling for all devices.", "httpmethod": "POST", "path": "devices/restsync/enable", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get device": { "description": "Get a device by IP Address.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "devices/{device_ip}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a device.", "properties": { "id": { "description": "Device identifier (ID). Used internally in the product and in the API.", "required": true, "type": "number" }, "type_id": { "description": "Device type ID; a way to represent device type that is more friendly to programs.", "required": true, "type": "number" }, "ipaddr": { "description": "Device IP address.", "required": true, "type": "string" }, "name": { "description": "Device name, which usually comes from SNMP or DNS.", "required": true, "type": "string" }, "type": { "description": "Device type, e.g. SteelCentral Flow Gateway, SteelCentral NetShark or Netflow device.", "required": true, "type": "string" }, "version": { "description": "Version of the protocol used to communicate with the device.", "required": true, "type": "string" } }, "id": "Device", "type": "object", "example": { "name": "MyNetflowDevice", "type_id": 2, "ipaddr": "10.0.0.1", "version": "N/A", "type": "Netflow", "id": 123 } }, "authorization": "required" }, "List devices": { "description": "Get a list of devices.", "parameters": { "type_id": { "required": false, "type": "number", "description": "Filter devices by device type." }, "cidr": { "required": false, "type": "string", "description": "Filter devices by IP or Subnet (e.g. 10.0.0.0/8)." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "devices", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of network devices that report data to Profiler.", "items": { "description": "One device from the list of devices that report data.", "required": false, "properties": { "id": { "description": "Device identifier (ID). Used internally in the product and in the API.", "required": true, "type": "number" }, "type_id": { "description": "Device type ID; a way to represent device type that is more friendly to programs.", "required": true, "type": "number" }, "ipaddr": { "description": "Device IP address.", "required": true, "type": "string" }, "name": { "description": "Device name, which usually comes from SNMP or DNS.", "required": true, "type": "string" }, "type": { "description": "Device type, e.g. SteelCentral Flow Gateway, SteelCentral NetShark or Netflow device.", "required": true, "type": "string" }, "version": { "description": "Version of the protocol used to communicate with the device.", "required": true, "type": "string" } }, "id": "Device", "type": "object" }, "id": "Devices", "type": "array", "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 } ] }, "authorization": "required" }, "Check REST polling": { "description": "Get global flag showing whether REST polling is enabled for all devices.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "devices/restsync", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing global REST sync enabled flag for devices on Profiler.", "properties": { "enabled": { "description": "Global REST sync enabled flag for devices on Profiler.", "required": true, "type": "string" } }, "id": "DevicesRestSyncEnabled", "type": "object" }, "authorization": "required" }, "Delete device": { "description": "Delete a device by IP Address. The operation is asynchronous. The device will be deleted within few minutes to hours depending on how busy is the system.", "httpmethod": "DELETE", "path": "devices/{device_ip}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Disable REST polling": { "description": "Globally enable REST polling for all devices.", "httpmethod": "POST", "path": "devices/restsync/disable", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" } } }, "Dscps": { "methods": { "List DSCPs": { "description": "Get complete DSCP configuration.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "dscps", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of DSCP objects.", "items": { "description": "Object representing DSCP information.", "required": false, "properties": { "id": { "description": "ID of the DSCP.", "required": true, "type": "number" }, "description": { "description": "Description of the DSCP.", "required": true, "type": "string" }, "name": { "description": "Name of the DSCP.", "required": true, "type": "string" } }, "id": "DSCPDef", "type": "object" }, "id": "CDSCPDefs", "type": "array", "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 } ] }, "authorization": "required" }, "Get DSCP": { "description": "Get information about a specific DSCP.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "dscps/{dscp_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing DSCP information.", "properties": { "id": { "description": "ID of the DSCP.", "required": true, "type": "number" }, "description": { "description": "Description of the DSCP.", "required": true, "type": "string" }, "name": { "description": "Name of the DSCP.", "required": true, "type": "string" } }, "id": "DSCPDef", "type": "object", "example": { "description": "Assured Forwarding Class 1 Low Drop", "name": "AF11", "id": 10 } }, "authorization": "required" }, "Update DSCPs": { "description": "Update DSCP configuration (only name and description can be updated).", "request": { "description": "List of DSCP objects.", "items": { "description": "Object representing DSCP information.", "required": false, "properties": { "id": { "description": "ID of the DSCP.", "required": true, "type": "number" }, "description": { "description": "Description of the DSCP.", "required": true, "type": "string" }, "name": { "description": "Name of the DSCP.", "required": true, "type": "string" } }, "id": "DSCPDef", "type": "object" }, "id": "CDSCPDefs", "type": "array", "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 } ] }, "httpmethod": "PUT", "path": "dscps", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Update DSCP": { "description": "Update information for a specific DSCP.", "request": { "description": "Object representing DSCP information.", "properties": { "id": { "description": "ID of the DSCP.", "required": true, "type": "number" }, "description": { "description": "Description of the DSCP.", "required": true, "type": "string" }, "name": { "description": "Name of the DSCP.", "required": true, "type": "string" } }, "id": "DSCPDef", "type": "object", "example": { "description": "Assured Forwarding Class 1 Low Drop", "name": "AF11", "id": 10 } }, "httpmethod": "PUT", "path": "dscps/{dscp_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" } } }, "Load_Balancers": { "methods": { "Import load balancers": { "description": ".", "parameters": { "overwrite": { "required": false, "type": "string", "description": "If it is true, existing load balancer is overwritten (default is false)." } }, "formats": [ "xml", "json" ], "request": { "description": "List of network load balancers data.", "items": { "description": "Load balancer data.", "required": false, "properties": { "password": { "description": "Password.", "required": false, "type": "string" }, "id": { "description": "Load balancer id assigned by the profiler.", "required": false, "type": "number" }, "username": { "description": "User name.", "required": false, "type": "string" }, "status": { "description": "Object representing a load balancer status data.", "required": false, "properties": { "last_attempt_query": { "description": "Description of last query: load balancer target IP, query type.", "required": false, "type": "string" }, "last_status": { "description": "Last retrieved load balancer status.", "required": false, "type": "number" }, "last_success_time": { "description": "Last time when load balancer status is successfully queried.", "required": false, "type": "number" }, "last_attempt_time": { "description": "Time stamp when the last query is conducted.", "required": false, "type": "number" } }, "id": "LoadBalancerStatus", "type": "object" }, "virtualservers": { "description": "Object representing a collection of virtual servers. This object is only available in load balancers export.", "items": { "description": "Virtual server configuration information.", "required": false, "properties": { "port": { "description": "Virtual server port.", "required": true, "type": "number" }, "lbname": { "description": "Load balancer name.", "required": true, "type": "string" }, "protocol": { "description": "Virtual server protocol.", "required": true, "type": "number" }, "id": { "description": "Load balancer database ID.", "required": true, "type": "number" }, "vsname": { "description": "Virtual server name.", "required": true, "type": "string" }, "iplist": { "description": "Virtual server IP list.", "items": { "description": "IP Address.", "required": false, "type": "string" }, "required": true, "id": "IPList", "type": "array" } }, "id": "VirtualServer", "type": "object" }, "required": false, "id": "VirtualServers", "type": "array" }, "name": { "description": "Load balancer name.", "required": true, "type": "string" }, "type": { "description": "Load balancer type. Note: type SIMULATED is reserved for internal use only.", "required": true, "type": "string", "enum": [ "OTHER", "SIMULATED", "F5_LTM", "STEELAPP" ] }, "hostportlist": { "description": "Load balancer management IP addresses and their ports. If used as a UI input, it could be either a DNS name or IP address. For SteelApp load balancer, a configurable network port is available.", "items": { "description": "Object representing IP address, its DNS name, and network port.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "ipaddr": { "description": "IP address. When used for input, it can be either IP address or DNS name.", "required": false, "type": "string" }, "name": { "description": "DNS name of an IP address.", "required": false, "type": "string" } }, "id": "HostPort", "type": "object" }, "required": false, "id": "HostPortList", "type": "array" } }, "id": "LoadBalancer", "type": "object" }, "id": "LoadBalancers", "type": "array", "example": [ { "status": { "last_attempt_query": "list query via 10.0.0.1", "last_success_time": 1395081752, "last_status": 0, "last_attempt_time": 1395081752 }, "username": "admin", "name": "web server load_balancer", "hostportlist": [ { "ipaddr": "10.0.0.1" }, { "ipaddr": "10.0.0.2" } ], "password": "string", "type": "F5_LTM" } ] }, "httpmethod": "POST", "path": "load_balancers/import", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing the result of importing load balancers.", "properties": { "imported": { "description": "number of load balancers imported into the database.", "required": true, "type": "number" }, "parsed": { "description": "number of load balancers found in the input text.", "required": true, "type": "number" } }, "id": "LBImportRestuls", "type": "object" }, "authorization": "required" }, "List virtual servers": { "description": ".", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting row number." }, "lbid": { "required": false, "type": "number", "description": "load balancer id. If provided, all virtual servers of the requested load balancer are returned." }, "vs_name": { "required": false, "type": "string", "description": "virtual server name." }, "sortby": { "required": false, "type": "string", "description": "Sort by one of the following options: id (default), vs_name, vs_ip, vs_proto, and vs_port." }, "sort": { "required": false, "type": "string", "description": "Sort order: asc or desc (default)." }, "vs_protocol": { "required": false, "type": "number", "description": "virtual server protocol id (value range: 1 - 255)." }, "vs_host": { "required": false, "type": "string", "description": "virtual server host IP address or CIDR notation; DNS name is not supported." }, "vs_port": { "required": false, "type": "number", "description": "virtual server port number (value range: 0 - 65535). If a zero is given, it is for all ports." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." }, "exact_name": { "required": false, "type": "string", "description": "if it is true, exact vs_name match is performed." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "load_balancers/virtual_servers", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a collection of virtual servers.", "items": { "description": "Virtual server configuration information.", "required": false, "properties": { "port": { "description": "Virtual server port.", "required": true, "type": "number" }, "lbname": { "description": "Load balancer name.", "required": true, "type": "string" }, "protocol": { "description": "Virtual server protocol.", "required": true, "type": "number" }, "id": { "description": "Load balancer database ID.", "required": true, "type": "number" }, "vsname": { "description": "Virtual server name.", "required": true, "type": "string" }, "iplist": { "description": "Virtual server IP list.", "items": { "description": "IP Address.", "required": false, "type": "string" }, "required": true, "id": "IPList", "type": "array" } }, "id": "VirtualServer", "type": "object" }, "id": "VirtualServers", "type": "array", "example": [ { "protocol": 6, "vsname": "tcp_all_ports", "port": 0, "lbname": "f5", "iplist": [ "10.8.0.41" ], "id": 1000 }, { "protocol": 6, "vsname": "vs_http_perf", "port": 80, "lbname": "stingray", "iplist": [ "10.9.0.39", "10.9.0.40" ], "id": 1001 } ] }, "authorization": "required" }, "Delete a load_balancer_id": { "description": "Delete a network load balancer.", "httpmethod": "DELETE", "path": "load_balancers/{load_balancer_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List of load balancers": { "description": "Get a list of load balancers.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting row number." }, "sortby": { "required": false, "type": "string", "description": "Sort by one of the following options: id (default), name, iplist and type." }, "sort": { "required": false, "type": "string", "description": "Sort order: asc or desc (default)." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "load_balancers", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of network load balancers data.", "items": { "description": "Load balancer data.", "required": false, "properties": { "password": { "description": "Password.", "required": false, "type": "string" }, "id": { "description": "Load balancer id assigned by the profiler.", "required": false, "type": "number" }, "username": { "description": "User name.", "required": false, "type": "string" }, "status": { "description": "Object representing a load balancer status data.", "required": false, "properties": { "last_attempt_query": { "description": "Description of last query: load balancer target IP, query type.", "required": false, "type": "string" }, "last_status": { "description": "Last retrieved load balancer status.", "required": false, "type": "number" }, "last_success_time": { "description": "Last time when load balancer status is successfully queried.", "required": false, "type": "number" }, "last_attempt_time": { "description": "Time stamp when the last query is conducted.", "required": false, "type": "number" } }, "id": "LoadBalancerStatus", "type": "object" }, "virtualservers": { "description": "Object representing a collection of virtual servers. This object is only available in load balancers export.", "items": { "description": "Virtual server configuration information.", "required": false, "properties": { "port": { "description": "Virtual server port.", "required": true, "type": "number" }, "lbname": { "description": "Load balancer name.", "required": true, "type": "string" }, "protocol": { "description": "Virtual server protocol.", "required": true, "type": "number" }, "id": { "description": "Load balancer database ID.", "required": true, "type": "number" }, "vsname": { "description": "Virtual server name.", "required": true, "type": "string" }, "iplist": { "description": "Virtual server IP list.", "items": { "description": "IP Address.", "required": false, "type": "string" }, "required": true, "id": "IPList", "type": "array" } }, "id": "VirtualServer", "type": "object" }, "required": false, "id": "VirtualServers", "type": "array" }, "name": { "description": "Load balancer name.", "required": true, "type": "string" }, "type": { "description": "Load balancer type. Note: type SIMULATED is reserved for internal use only.", "required": true, "type": "string", "enum": [ "OTHER", "SIMULATED", "F5_LTM", "STEELAPP" ] }, "hostportlist": { "description": "Load balancer management IP addresses and their ports. If used as a UI input, it could be either a DNS name or IP address. For SteelApp load balancer, a configurable network port is available.", "items": { "description": "Object representing IP address, its DNS name, and network port.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "ipaddr": { "description": "IP address. When used for input, it can be either IP address or DNS name.", "required": false, "type": "string" }, "name": { "description": "DNS name of an IP address.", "required": false, "type": "string" } }, "id": "HostPort", "type": "object" }, "required": false, "id": "HostPortList", "type": "array" } }, "id": "LoadBalancer", "type": "object" }, "id": "LoadBalancers", "type": "array", "example": [ { "status": { "last_attempt_query": "list query via 10.0.0.1", "last_success_time": 1395081752, "last_status": 0, "last_attempt_time": 1395081752 }, "username": "admin", "name": "web server load_balancer", "hostportlist": [ { "ipaddr": "10.0.0.1" }, { "ipaddr": "10.0.0.2" } ], "password": "string", "type": "F5_LTM" } ] }, "authorization": "required" }, "Create a network load balancer": { "description": "Create a network balancer.", "formats": [ "xml", "json" ], "request": { "description": "Object representing a load balancer.", "properties": { "password": { "description": "Password.", "required": false, "type": "string" }, "id": { "description": "Load balancer id assigned by the profiler.", "required": false, "type": "number" }, "username": { "description": "User name.", "required": false, "type": "string" }, "status": { "description": "Object representing a load balancer status data.", "required": false, "properties": { "last_attempt_query": { "description": "Description of last query: load balancer target IP, query type.", "required": false, "type": "string" }, "last_status": { "description": "Last retrieved load balancer status.", "required": false, "type": "number" }, "last_success_time": { "description": "Last time when load balancer status is successfully queried.", "required": false, "type": "number" }, "last_attempt_time": { "description": "Time stamp when the last query is conducted.", "required": false, "type": "number" } }, "id": "LoadBalancerStatus", "type": "object" }, "virtualservers": { "description": "Object representing a collection of virtual servers. This object is only available in load balancers export.", "items": { "description": "Virtual server configuration information.", "required": false, "properties": { "port": { "description": "Virtual server port.", "required": true, "type": "number" }, "lbname": { "description": "Load balancer name.", "required": true, "type": "string" }, "protocol": { "description": "Virtual server protocol.", "required": true, "type": "number" }, "id": { "description": "Load balancer database ID.", "required": true, "type": "number" }, "vsname": { "description": "Virtual server name.", "required": true, "type": "string" }, "iplist": { "description": "Virtual server IP list.", "items": { "description": "IP Address.", "required": false, "type": "string" }, "required": true, "id": "IPList", "type": "array" } }, "id": "VirtualServer", "type": "object" }, "required": false, "id": "VirtualServers", "type": "array" }, "name": { "description": "Load balancer name.", "required": true, "type": "string" }, "type": { "description": "Load balancer type. Note: type SIMULATED is reserved for internal use only.", "required": true, "type": "string", "enum": [ "OTHER", "SIMULATED", "F5_LTM", "STEELAPP" ] }, "hostportlist": { "description": "Load balancer management IP addresses and their ports. If used as a UI input, it could be either a DNS name or IP address. For SteelApp load balancer, a configurable network port is available.", "items": { "description": "Object representing IP address, its DNS name, and network port.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "ipaddr": { "description": "IP address. When used for input, it can be either IP address or DNS name.", "required": false, "type": "string" }, "name": { "description": "DNS name of an IP address.", "required": false, "type": "string" } }, "id": "HostPort", "type": "object" }, "required": false, "id": "HostPortList", "type": "array" } }, "id": "LoadBalancer", "type": "object", "example": { "status": { "last_attempt_query": "list query via 10.0.0.1", "last_success_time": 1395081752, "last_status": 0, "last_attempt_time": 1395081752 }, "username": "admin", "name": "web server load_balancer", "hostportlist": [ { "ipaddr": "10.0.0.1", "port": 9070 }, { "ipaddr": "10.0.0.2", "port": 9071 } ], "password": "string", "type": "STEELAPP" } }, "httpmethod": "POST", "path": "load_balancers", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a load balancer.", "properties": { "password": { "description": "Password.", "required": false, "type": "string" }, "id": { "description": "Load balancer id assigned by the profiler.", "required": false, "type": "number" }, "username": { "description": "User name.", "required": false, "type": "string" }, "status": { "description": "Object representing a load balancer status data.", "required": false, "properties": { "last_attempt_query": { "description": "Description of last query: load balancer target IP, query type.", "required": false, "type": "string" }, "last_status": { "description": "Last retrieved load balancer status.", "required": false, "type": "number" }, "last_success_time": { "description": "Last time when load balancer status is successfully queried.", "required": false, "type": "number" }, "last_attempt_time": { "description": "Time stamp when the last query is conducted.", "required": false, "type": "number" } }, "id": "LoadBalancerStatus", "type": "object" }, "virtualservers": { "description": "Object representing a collection of virtual servers. This object is only available in load balancers export.", "items": { "description": "Virtual server configuration information.", "required": false, "properties": { "port": { "description": "Virtual server port.", "required": true, "type": "number" }, "lbname": { "description": "Load balancer name.", "required": true, "type": "string" }, "protocol": { "description": "Virtual server protocol.", "required": true, "type": "number" }, "id": { "description": "Load balancer database ID.", "required": true, "type": "number" }, "vsname": { "description": "Virtual server name.", "required": true, "type": "string" }, "iplist": { "description": "Virtual server IP list.", "items": { "description": "IP Address.", "required": false, "type": "string" }, "required": true, "id": "IPList", "type": "array" } }, "id": "VirtualServer", "type": "object" }, "required": false, "id": "VirtualServers", "type": "array" }, "name": { "description": "Load balancer name.", "required": true, "type": "string" }, "type": { "description": "Load balancer type. Note: type SIMULATED is reserved for internal use only.", "required": true, "type": "string", "enum": [ "OTHER", "SIMULATED", "F5_LTM", "STEELAPP" ] }, "hostportlist": { "description": "Load balancer management IP addresses and their ports. If used as a UI input, it could be either a DNS name or IP address. For SteelApp load balancer, a configurable network port is available.", "items": { "description": "Object representing IP address, its DNS name, and network port.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "ipaddr": { "description": "IP address. When used for input, it can be either IP address or DNS name.", "required": false, "type": "string" }, "name": { "description": "DNS name of an IP address.", "required": false, "type": "string" } }, "id": "HostPort", "type": "object" }, "required": false, "id": "HostPortList", "type": "array" } }, "id": "LoadBalancer", "type": "object", "example": { "status": { "last_attempt_query": "list query via 10.0.0.1", "last_success_time": 1395081752, "last_status": 0, "last_attempt_time": 1395081752 }, "username": "admin", "name": "web server load_balancer", "hostportlist": [ { "ipaddr": "10.0.0.1", "port": 9070 }, { "ipaddr": "10.0.0.2", "port": 9071 } ], "password": "string", "type": "STEELAPP" } }, "authorization": "required" }, "Update load_balancers": { "description": "Update network a load balancer (fields that can be updated are name, type, primary ip, secondary ip, user name, and password).", "request": { "description": "Object representing a load balancer.", "properties": { "password": { "description": "Password.", "required": false, "type": "string" }, "id": { "description": "Load balancer id assigned by the profiler.", "required": false, "type": "number" }, "username": { "description": "User name.", "required": false, "type": "string" }, "status": { "description": "Object representing a load balancer status data.", "required": false, "properties": { "last_attempt_query": { "description": "Description of last query: load balancer target IP, query type.", "required": false, "type": "string" }, "last_status": { "description": "Last retrieved load balancer status.", "required": false, "type": "number" }, "last_success_time": { "description": "Last time when load balancer status is successfully queried.", "required": false, "type": "number" }, "last_attempt_time": { "description": "Time stamp when the last query is conducted.", "required": false, "type": "number" } }, "id": "LoadBalancerStatus", "type": "object" }, "virtualservers": { "description": "Object representing a collection of virtual servers. This object is only available in load balancers export.", "items": { "description": "Virtual server configuration information.", "required": false, "properties": { "port": { "description": "Virtual server port.", "required": true, "type": "number" }, "lbname": { "description": "Load balancer name.", "required": true, "type": "string" }, "protocol": { "description": "Virtual server protocol.", "required": true, "type": "number" }, "id": { "description": "Load balancer database ID.", "required": true, "type": "number" }, "vsname": { "description": "Virtual server name.", "required": true, "type": "string" }, "iplist": { "description": "Virtual server IP list.", "items": { "description": "IP Address.", "required": false, "type": "string" }, "required": true, "id": "IPList", "type": "array" } }, "id": "VirtualServer", "type": "object" }, "required": false, "id": "VirtualServers", "type": "array" }, "name": { "description": "Load balancer name.", "required": true, "type": "string" }, "type": { "description": "Load balancer type. Note: type SIMULATED is reserved for internal use only.", "required": true, "type": "string", "enum": [ "OTHER", "SIMULATED", "F5_LTM", "STEELAPP" ] }, "hostportlist": { "description": "Load balancer management IP addresses and their ports. If used as a UI input, it could be either a DNS name or IP address. For SteelApp load balancer, a configurable network port is available.", "items": { "description": "Object representing IP address, its DNS name, and network port.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "ipaddr": { "description": "IP address. When used for input, it can be either IP address or DNS name.", "required": false, "type": "string" }, "name": { "description": "DNS name of an IP address.", "required": false, "type": "string" } }, "id": "HostPort", "type": "object" }, "required": false, "id": "HostPortList", "type": "array" } }, "id": "LoadBalancer", "type": "object", "example": { "status": { "last_attempt_query": "list query via 10.0.0.1", "last_success_time": 1395081752, "last_status": 0, "last_attempt_time": 1395081752 }, "username": "admin", "name": "web server load_balancer", "hostportlist": [ { "ipaddr": "10.0.0.1", "port": 9070 }, { "ipaddr": "10.0.0.2", "port": 9071 } ], "password": "string", "type": "STEELAPP" } }, "httpmethod": "PUT", "path": "load_balancers/{load_balancer_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Detect a load balancer's SNATs that match a list of IP protocol port or CIDR notation specified by user": { "description": "Detect a load balancer's SNATs that match a list of IP protocol port or CIDR notation specified by user.", "formats": [ "xml", "json" ], "request": { "description": "Object representing a list of ip protocol port or cidr.", "items": { "description": "Object representing ip protocol port or cidr.", "required": false, "properties": { "cidr": { "description": "Network CIDR (string).", "required": false, "type": "string" }, "ipprotoport": { "description": "Object representing ip protocol port.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "protocol": { "description": "Network protocol.", "required": false, "type": "number" }, "ipaddr": { "description": "Network IP address.", "required": true, "type": "string" } }, "id": "IPProtoPort", "type": "object" } }, "id": "IPProtoPortCidr", "type": "object" }, "id": "IPProtoPortCidrList", "type": "array", "example": [ { "ipprotoport": { "ipaddr": "1.1.1.1" } }, { "ipprotoport": { "ipaddr": "2.2.2.2", "protocol": 6, "port": 80 } }, { "cidr": "10/8" } ] }, "httpmethod": "POST", "path": "load_balancers/{load_balancer_id}/detect_snats", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing SNATs info and a possible operation related warning message.", "properties": { "type": { "description": "SNAT type that could be either NOT_USED, SOMETIMES, or ALWAYS.", "required": false, "type": "string", "enum": [ "NOT_USED", "SOMETIMES", "ALWAYS" ] }, "snats": { "description": "Object representing a list of SNATs IP addresses.", "items": { "description": "IP Address.", "required": false, "type": "string" }, "required": false, "id": "IPList", "type": "array" }, "warning": { "description": "A possible warning message providing more details on the requested operation.", "required": false, "type": "string" } }, "id": "SNATInfo", "type": "object", "example": { "type": "SOMETIMES", "snats": [ "1.1.1.1", "2.2.2.2" ] } }, "authorization": "required" }, "Detect load balancer's real servers that match a list of IP protocol port or CIDR notation specified by user": { "description": "Detect load balancer's real servers that match a list of IP protocol port or CIDR notation specified by user.", "formats": [ "xml", "json" ], "request": { "description": "Object representing a list of ip protocol port or cidr.", "items": { "description": "Object representing ip protocol port or cidr.", "required": false, "properties": { "cidr": { "description": "Network CIDR (string).", "required": false, "type": "string" }, "ipprotoport": { "description": "Object representing ip protocol port.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "protocol": { "description": "Network protocol.", "required": false, "type": "number" }, "ipaddr": { "description": "Network IP address.", "required": true, "type": "string" } }, "id": "IPProtoPort", "type": "object" } }, "id": "IPProtoPortCidr", "type": "object" }, "id": "IPProtoPortCidrList", "type": "array", "example": [ { "ipprotoport": { "ipaddr": "1.1.1.1" } }, { "ipprotoport": { "ipaddr": "2.2.2.2", "protocol": 6, "port": 80 } }, { "cidr": "10/8" } ] }, "httpmethod": "POST", "path": "load_balancers/{load_balancer_id}/detect_realservers", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing real server list info and a possible operation related warning message.", "properties": { "realservers": { "description": "Object representing real servers.", "items": { "description": "Object representing a real server which is an IPProtoPort.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "protocol": { "description": "Network protocol.", "required": false, "type": "number" }, "ipaddr": { "description": "Network IP address.", "required": true, "type": "string" } }, "id": "IPProtoPort", "type": "object" }, "required": false, "id": "RealServerList", "type": "array" }, "warning": { "description": "A possible warning message providing more details on the requested operation.", "required": false, "type": "string" } }, "id": "RealServerListInfo", "type": "object", "example": [] }, "authorization": "required" }, "Refresh load balancer virtual servers": { "description": "Refresh load balancer virtual servers.", "httpmethod": "POST", "path": "load_balancers/{load_balancer_id}/refresh", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List of virtual servers": { "description": ".", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting row number." }, "vs_name": { "required": false, "type": "string", "description": "virtual server name." }, "sortby": { "required": false, "type": "string", "description": "Sort by one of the following options: id (default), vs_name, vs_ip, vs_proto, and vs_port." }, "sort": { "required": false, "type": "string", "description": "Sort order: asc or desc (default)." }, "vs_protocol": { "required": false, "type": "number", "description": "virtual server protocol id (value range: 1 - 255)." }, "vs_host": { "required": false, "type": "string", "description": "virtual server host IP address or CIDR notation; DNS name is not supported." }, "vs_port": { "required": false, "type": "number", "description": "virtual server port number (value range: 0 - 65535). If a zero is given, it is for all ports." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." }, "exact_name": { "required": false, "type": "string", "description": "if it is true, exact vs_name match is performed." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "load_balancers/{load_balancer_id}/virtual_servers", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a collection of virtual servers.", "items": { "description": "Virtual server configuration information.", "required": false, "properties": { "port": { "description": "Virtual server port.", "required": true, "type": "number" }, "lbname": { "description": "Load balancer name.", "required": true, "type": "string" }, "protocol": { "description": "Virtual server protocol.", "required": true, "type": "number" }, "id": { "description": "Load balancer database ID.", "required": true, "type": "number" }, "vsname": { "description": "Virtual server name.", "required": true, "type": "string" }, "iplist": { "description": "Virtual server IP list.", "items": { "description": "IP Address.", "required": false, "type": "string" }, "required": true, "id": "IPList", "type": "array" } }, "id": "VirtualServer", "type": "object" }, "id": "VirtualServers", "type": "array", "example": [ { "protocol": 6, "vsname": "tcp_all_ports", "port": 0, "lbname": "f5", "iplist": [ "10.8.0.41" ], "id": 1000 }, { "protocol": 6, "vsname": "vs_http_perf", "port": 80, "lbname": "stingray", "iplist": [ "10.9.0.39", "10.9.0.40" ], "id": 1001 } ] }, "authorization": "required" }, "Get a load balancer": { "description": ".", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "load_balancers/{load_balancer_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a load balancer.", "properties": { "password": { "description": "Password.", "required": false, "type": "string" }, "id": { "description": "Load balancer id assigned by the profiler.", "required": false, "type": "number" }, "username": { "description": "User name.", "required": false, "type": "string" }, "status": { "description": "Object representing a load balancer status data.", "required": false, "properties": { "last_attempt_query": { "description": "Description of last query: load balancer target IP, query type.", "required": false, "type": "string" }, "last_status": { "description": "Last retrieved load balancer status.", "required": false, "type": "number" }, "last_success_time": { "description": "Last time when load balancer status is successfully queried.", "required": false, "type": "number" }, "last_attempt_time": { "description": "Time stamp when the last query is conducted.", "required": false, "type": "number" } }, "id": "LoadBalancerStatus", "type": "object" }, "virtualservers": { "description": "Object representing a collection of virtual servers. This object is only available in load balancers export.", "items": { "description": "Virtual server configuration information.", "required": false, "properties": { "port": { "description": "Virtual server port.", "required": true, "type": "number" }, "lbname": { "description": "Load balancer name.", "required": true, "type": "string" }, "protocol": { "description": "Virtual server protocol.", "required": true, "type": "number" }, "id": { "description": "Load balancer database ID.", "required": true, "type": "number" }, "vsname": { "description": "Virtual server name.", "required": true, "type": "string" }, "iplist": { "description": "Virtual server IP list.", "items": { "description": "IP Address.", "required": false, "type": "string" }, "required": true, "id": "IPList", "type": "array" } }, "id": "VirtualServer", "type": "object" }, "required": false, "id": "VirtualServers", "type": "array" }, "name": { "description": "Load balancer name.", "required": true, "type": "string" }, "type": { "description": "Load balancer type. Note: type SIMULATED is reserved for internal use only.", "required": true, "type": "string", "enum": [ "OTHER", "SIMULATED", "F5_LTM", "STEELAPP" ] }, "hostportlist": { "description": "Load balancer management IP addresses and their ports. If used as a UI input, it could be either a DNS name or IP address. For SteelApp load balancer, a configurable network port is available.", "items": { "description": "Object representing IP address, its DNS name, and network port.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "ipaddr": { "description": "IP address. When used for input, it can be either IP address or DNS name.", "required": false, "type": "string" }, "name": { "description": "DNS name of an IP address.", "required": false, "type": "string" } }, "id": "HostPort", "type": "object" }, "required": false, "id": "HostPortList", "type": "array" } }, "id": "LoadBalancer", "type": "object", "example": { "status": { "last_attempt_query": "list query via 10.0.0.1", "last_success_time": 1395081752, "last_status": 0, "last_attempt_time": 1395081752 }, "username": "admin", "name": "web server load_balancer", "hostportlist": [ { "ipaddr": "10.0.0.1", "port": 9070 }, { "ipaddr": "10.0.0.2", "port": 9071 } ], "password": "string", "type": "STEELAPP" } }, "authorization": "required" }, "Export load balancers": { "description": ".", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "load_balancers/export", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of network load balancers data.", "items": { "description": "Load balancer data.", "required": false, "properties": { "password": { "description": "Password.", "required": false, "type": "string" }, "id": { "description": "Load balancer id assigned by the profiler.", "required": false, "type": "number" }, "username": { "description": "User name.", "required": false, "type": "string" }, "status": { "description": "Object representing a load balancer status data.", "required": false, "properties": { "last_attempt_query": { "description": "Description of last query: load balancer target IP, query type.", "required": false, "type": "string" }, "last_status": { "description": "Last retrieved load balancer status.", "required": false, "type": "number" }, "last_success_time": { "description": "Last time when load balancer status is successfully queried.", "required": false, "type": "number" }, "last_attempt_time": { "description": "Time stamp when the last query is conducted.", "required": false, "type": "number" } }, "id": "LoadBalancerStatus", "type": "object" }, "virtualservers": { "description": "Object representing a collection of virtual servers. This object is only available in load balancers export.", "items": { "description": "Virtual server configuration information.", "required": false, "properties": { "port": { "description": "Virtual server port.", "required": true, "type": "number" }, "lbname": { "description": "Load balancer name.", "required": true, "type": "string" }, "protocol": { "description": "Virtual server protocol.", "required": true, "type": "number" }, "id": { "description": "Load balancer database ID.", "required": true, "type": "number" }, "vsname": { "description": "Virtual server name.", "required": true, "type": "string" }, "iplist": { "description": "Virtual server IP list.", "items": { "description": "IP Address.", "required": false, "type": "string" }, "required": true, "id": "IPList", "type": "array" } }, "id": "VirtualServer", "type": "object" }, "required": false, "id": "VirtualServers", "type": "array" }, "name": { "description": "Load balancer name.", "required": true, "type": "string" }, "type": { "description": "Load balancer type. Note: type SIMULATED is reserved for internal use only.", "required": true, "type": "string", "enum": [ "OTHER", "SIMULATED", "F5_LTM", "STEELAPP" ] }, "hostportlist": { "description": "Load balancer management IP addresses and their ports. If used as a UI input, it could be either a DNS name or IP address. For SteelApp load balancer, a configurable network port is available.", "items": { "description": "Object representing IP address, its DNS name, and network port.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "ipaddr": { "description": "IP address. When used for input, it can be either IP address or DNS name.", "required": false, "type": "string" }, "name": { "description": "DNS name of an IP address.", "required": false, "type": "string" } }, "id": "HostPort", "type": "object" }, "required": false, "id": "HostPortList", "type": "array" } }, "id": "LoadBalancer", "type": "object" }, "id": "LoadBalancers", "type": "array", "example": [ { "status": { "last_attempt_query": "list query via 10.0.0.1", "last_success_time": 1395081752, "last_status": 0, "last_attempt_time": 1395081752 }, "username": "admin", "name": "web server load_balancer", "hostportlist": [ { "ipaddr": "10.0.0.1" }, { "ipaddr": "10.0.0.2" } ], "password": "string", "type": "F5_LTM" } ] }, "authorization": "required" }, "Detect load balancers that match a list of IP protocol port or CIDR notation specified by user": { "description": "Detect load balancers that match a list of IP protocol port or CIDR notation specified by user.", "formats": [ "xml", "json" ], "request": { "description": "Object representing a list of ip protocol port or cidr.", "items": { "description": "Object representing ip protocol port or cidr.", "required": false, "properties": { "cidr": { "description": "Network CIDR (string).", "required": false, "type": "string" }, "ipprotoport": { "description": "Object representing ip protocol port.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "protocol": { "description": "Network protocol.", "required": false, "type": "number" }, "ipaddr": { "description": "Network IP address.", "required": true, "type": "string" } }, "id": "IPProtoPort", "type": "object" } }, "id": "IPProtoPortCidr", "type": "object" }, "id": "IPProtoPortCidrList", "type": "array", "example": [ { "ipprotoport": { "ipaddr": "1.1.1.1" } }, { "ipprotoport": { "ipaddr": "2.2.2.2", "protocol": 6, "port": 80 } }, { "cidr": "10/8" } ] }, "httpmethod": "POST", "path": "load_balancers/detect", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a list of LBIPProtoPortCidrList and a possible operation related warning message.", "properties": { "lb_ipprotoport_cidr_lists": { "description": "Object representing LBIPProtoPortCidrLists.", "items": { "description": "a list of load balancer ip protocol port or cidr.", "required": false, "properties": { "id": { "description": "Load balancer database ID.", "required": true, "type": "number" }, "name": { "description": "Load balancer name.", "required": false, "type": "string" }, "type": { "description": "Load balancer type.", "required": false, "type": "string", "enum": [ "OTHER", "SIMULATED", "F5_LTM", "STEELAPP" ] }, "ipprotoport_cidr_list": { "description": "A list of ip protocol port or cidr notation.", "items": { "description": "Object representing ip protocol port or cidr.", "required": false, "properties": { "cidr": { "description": "Network CIDR (string).", "required": false, "type": "string" }, "ipprotoport": { "description": "Object representing ip protocol port.", "required": false, "properties": { "port": { "description": "Network port number.", "required": false, "type": "number" }, "protocol": { "description": "Network protocol.", "required": false, "type": "number" }, "ipaddr": { "description": "Network IP address.", "required": true, "type": "string" } }, "id": "IPProtoPort", "type": "object" } }, "id": "IPProtoPortCidr", "type": "object" }, "required": true, "id": "IPProtoPortCidrList", "type": "array" } }, "id": "LBIPProtoPortCidrList", "type": "object" }, "required": false, "id": "LBIPProtoPortCidrLists", "type": "array" }, "warning": { "description": "A possible warning message providing more details on the requested operation.", "required": false, "type": "string" } }, "id": "LBIPProtoPortCidrListsInfo", "type": "object", "example": { "lb_ipprotoport_cidr_lists": [ { "ipprotoport_cidr_list": [ { "ipprotoport": { "ipaddr": "1.1.1.1" } } ], "id": 0 }, { "ipprotoport_cidr_list": [ { "ipprotoport": { "ipaddr": "2.2.2.2", "protocol": 6, "port": 80 } } ], "type": "STEELAPP", "id": 1 } ] } }, "authorization": "required" } } }, "Cbqos": { "methods": { "Sync cbqos devices config": { "description": "Retrieves configuration data from cbqos devices on which polling is enabled.", "request": { "description": "IP addresses collection object representing the list of devices with cbqos settings.", "items": { "description": "IP address object representing a device with cbqos settings.", "required": false, "properties": { "ipaddr": { "description": "IP address representing a device with cbqos settings.", "required": true, "type": "string" } }, "id": "CbqosIPAddr", "type": "object" }, "id": "CbqosIPAddrs", "type": "array", "example": [ { "ipaddr": "10.99.16.252" }, { "ipaddr": "10.99.15.252" }, { "ipaddr": "10.99.14.252" } ] }, "httpmethod": "POST", "path": "cbqos/devices/config/sync", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Enable cbqos devices polling": { "description": "Enables data polling from cbqos devices.", "request": { "description": "List of objects representing config information for enabling a device polling.", "items": { "description": "Object representing config information for enabling a device polling.", "required": false, "properties": { "polling_interval": { "description": "Time between two polls.", "required": true, "type": "number" }, "use64bit": { "description": "Use 64 bit counter.", "required": true, "type": "string" }, "ipaddr": { "description": "Device IP address.", "required": true, "type": "string" } }, "id": "CbqosConfig", "type": "object" }, "id": "CbqosConfigs", "type": "array", "example": [ { "ipaddr": "10.99.16.252", "use64bit": true, "polling_interval": 300 }, { "ipaddr": "10.99.15.252", "use64bit": false, "polling_interval": 900 }, { "ipaddr": "10.99.14.252", "use64bit": false, "polling_interval": 300 } ] }, "httpmethod": "POST", "path": "cbqos/devices/sync/enable", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get cbqos device": { "description": "Get a device with cbqos settings by device ip.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "cbqos/devices/{device_ip}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a device with cbqos settings.", "properties": { "polling_interval": { "description": "Time between two polls.", "required": true, "type": "number" }, "last_stats_resp_ts": { "description": "Timestamp of the last stats poll response.", "required": true, "type": "number" }, "last_config_req_ts": { "description": "Timestamp of the last config poll request.", "required": true, "type": "number" }, "use64bit": { "description": "Use 64 bit counter.", "required": true, "type": "string" }, "type_id": { "description": "Device type id (2 - NetFlow, 11 - Cascade Shark, etc.)", "required": true, "type": "number" }, "last_stats_req_ts": { "description": "Timestamp of the last stats poll request.", "required": true, "type": "number" }, "last_config_status": { "description": "Status of the last config poll.", "required": true, "type": "string" }, "last_stats_status": { "description": "Status of the last stats poll.", "required": true, "type": "string" }, "ipaddr": { "description": "Device IP address.", "required": true, "type": "string" }, "name": { "description": "Device name.", "required": true, "type": "string" }, "last_config_resp_ts": { "description": "Timestamp of the last config poll response.", "required": true, "type": "number" } }, "id": "CbqosDevice", "type": "object", "example": { "last_stats_status": "TIMEOUT", "last_config_status": "OK", "name": "shark-Columbus", "type_id": 11, "ipaddr": "10.99.14.253", "last_stats_resp_ts": 1450120092, "last_stats_req_ts": 1450120080, "last_config_resp_ts": 1450120060, "last_config_req_ts": 1450120050, "polling_interval": 300, "use64bit": false } }, "authorization": "required" }, "Disable cbqos devices polling": { "description": "Disables data polling from cbqos devices.", "request": { "description": "IP addresses collection object representing the list of devices with cbqos settings.", "items": { "description": "IP address object representing a device with cbqos settings.", "required": false, "properties": { "ipaddr": { "description": "IP address representing a device with cbqos settings.", "required": true, "type": "string" } }, "id": "CbqosIPAddr", "type": "object" }, "id": "CbqosIPAddrs", "type": "array", "example": [ { "ipaddr": "10.99.16.252" }, { "ipaddr": "10.99.15.252" }, { "ipaddr": "10.99.14.252" } ] }, "httpmethod": "POST", "path": "cbqos/devices/sync/disable", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List cbqos/devices": { "description": "Get a list of devices with cbqos settings.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting row number." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "cbqos/devices", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of devices with their cbqos settings.", "items": { "description": "Object representing a device with cbqos settings.", "required": false, "properties": { "polling_interval": { "description": "Time between two polls.", "required": true, "type": "number" }, "last_stats_resp_ts": { "description": "Timestamp of the last stats poll response.", "required": true, "type": "number" }, "last_config_req_ts": { "description": "Timestamp of the last config poll request.", "required": true, "type": "number" }, "use64bit": { "description": "Use 64 bit counter.", "required": true, "type": "string" }, "type_id": { "description": "Device type id (2 - NetFlow, 11 - Cascade Shark, etc.)", "required": true, "type": "number" }, "last_stats_req_ts": { "description": "Timestamp of the last stats poll request.", "required": true, "type": "number" }, "last_config_status": { "description": "Status of the last config poll.", "required": true, "type": "string" }, "last_stats_status": { "description": "Status of the last stats poll.", "required": true, "type": "string" }, "ipaddr": { "description": "Device IP address.", "required": true, "type": "string" }, "name": { "description": "Device name.", "required": true, "type": "string" }, "last_config_resp_ts": { "description": "Timestamp of the last config poll response.", "required": true, "type": "number" } }, "id": "CbqosDevice", "type": "object" }, "id": "CbqosDevices", "type": "array", "example": [ { "last_stats_status": "TIMEOUT", "last_config_status": "OK", "name": "shark-Columbus", "type_id": 11, "ipaddr": "10.99.14.253", "last_stats_resp_ts": 1450120092, "last_stats_req_ts": 1450120080, "last_config_resp_ts": 1450120060, "last_config_req_ts": 1450120050, "polling_interval": 300, "use64bit": false }, { "last_stats_status": "TIMEOUT", "last_config_status": "OK", "name": "WAN-RTR-Philadelphia", "type_id": 2, "ipaddr": "10.99.17.254", "last_stats_resp_ts": 1450120032, "last_stats_req_ts": 1450120020, "last_config_resp_ts": 1450120010, "last_config_req_ts": 1450120005, "polling_interval": 900, "use64bit": true } ] }, "authorization": "required" } } }, "Ping": { "methods": { "Ping": { "description": "Simple test of service availability.", "httpmethod": "GET", "path": "ping", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" } } }, "Hns": { "methods": { "Resolve IP addresses to names": { "description": "Resolve IP addresses to names.", "formats": [ "xml", "json" ], "request": { "description": "List of IP addresses.", "items": { "description": "IP address.", "required": false, "type": "string" }, "id": "IPAddrs", "type": "array", "example": [ "10.99.16.252", "10.100.5.12", "10.99.16.253" ] }, "httpmethod": "POST", "path": "hns/ip2name", "response": { "description": "IP address to name map.", "additionalProperties": { "description": "Name resolved from IP address.", "required": false, "xmlKeyName": "key", "type": "string" }, "id": "IP2NameMap", "type": "object", "example": { "10.100.5.12": "DCCluster1-EH3", "10.99.16.252": "SH-Austin", "10.99.16.253": "shark-Austin" } }, "authorization": "none" } } }, "Sharks": { "methods": { "Enable Sharks polling": { "description": "Enables data polling from Sharks.", "parameters": { "source": { "required": false, "type": "string", "description": "Get data from Shark or Alloy: 'shark' or 'alloy'(default 'shark')." } }, "request": { "description": "IP addresses object representing the list of all Sharks.", "items": { "description": "IP address collection object representing the list of all Sharks.", "required": false, "properties": { "ipaddr": { "description": "IP address representing a Shark.", "required": true, "type": "string" } }, "id": "SharkIPAddr", "type": "object" }, "id": "SharkIPAddrs", "type": "array", "example": [ { "ipaddr": "10.99.16.252" }, { "ipaddr": "10.99.15.252" }, { "ipaddr": "10.99.14.252" } ] }, "httpmethod": "POST", "path": "sharks/sync/enable", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Sync Sharks apps": { "description": "Retrieves application data from Sharks on which polling is enabled.", "parameters": { "source": { "required": false, "type": "string", "description": "Get data from Shark or Alloy: 'shark' or 'alloy'(default 'shark')." } }, "request": { "description": "IP addresses object representing the list of all Sharks.", "items": { "description": "IP address collection object representing the list of all Sharks.", "required": false, "properties": { "ipaddr": { "description": "IP address representing a Shark.", "required": true, "type": "string" } }, "id": "SharkIPAddr", "type": "object" }, "id": "SharkIPAddrs", "type": "array", "example": [ { "ipaddr": "10.99.16.252" }, { "ipaddr": "10.99.15.252" }, { "ipaddr": "10.99.14.252" } ] }, "httpmethod": "POST", "path": "sharks/apps/sync", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get Shark apps": { "description": "Get configuration of a Shark by IP address.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "sharks/{shark_ip}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a Shark.", "properties": { "sync": { "description": "Object representing Shark syncronization information.", "required": true, "properties": { "apps": { "description": "Object representing Shark application syncronization information.", "required": true, "properties": { "enabled": { "description": "Flag indicating if application synchronization is enabled on this Shark.", "required": true, "type": "string" }, "error_text": { "description": "Error description.", "required": true, "type": "string" }, "last_sync_ts": { "description": "Last attempted application syncronization time.", "required": true, "type": "number" }, "last_success_ts": { "description": "Last successful application syncronization time.", "required": true, "type": "number" }, "is_alloy": { "description": "Device is AppResponse-based.", "required": true, "type": "string" }, "error_id": { "description": "Error ID.", "required": true, "type": "number" }, "state": { "description": "Synchronization status.", "required": true, "type": "string", "enum": [ "SYNC_INITIALIZING", "SYNC_FAILED", "SYNC_SUCCEEDED", "SYNC_DISABLED", "SYNC_NA" ] } }, "id": "SharkAppsObject", "type": "object" } }, "id": "SharkSyncObject", "type": "object" }, "ipaddr": { "description": "Shark IP address.", "required": true, "type": "string" } }, "id": "Shark", "type": "object" }, "authorization": "required" }, "Ping Shark": { "description": "Ping a Shark by IP address.", "httpmethod": "GET", "path": "sharks/{shark_ip}/ping", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Disable Sharks polling": { "description": "Disables data polling from Sharks.", "parameters": { "source": { "required": false, "type": "string", "description": "Get data from Shark or Alloy: 'shark' or 'alloy'(default 'shark')." } }, "request": { "description": "IP addresses object representing the list of all Sharks.", "items": { "description": "IP address collection object representing the list of all Sharks.", "required": false, "properties": { "ipaddr": { "description": "IP address representing a Shark.", "required": true, "type": "string" } }, "id": "SharkIPAddr", "type": "object" }, "id": "SharkIPAddrs", "type": "array", "example": [ { "ipaddr": "10.99.16.252" }, { "ipaddr": "10.99.15.252" }, { "ipaddr": "10.99.14.252" } ] }, "httpmethod": "POST", "path": "sharks/sync/disable", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List Sharks": { "description": "Get a list of Sharks and their application configuration data.", "parameters": { "source": { "required": false, "type": "string", "description": "Get data from Shark or Alloy: 'shark' or 'alloy'(default 'shark')." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "sharks", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of Sharks and their configuration data.", "items": { "description": "Shark configuration data.", "required": false, "properties": { "sync": { "description": "Object representing Shark syncronization information.", "required": true, "properties": { "apps": { "description": "Object representing Shark application syncronization information.", "required": true, "properties": { "enabled": { "description": "Flag indicating if application synchronization is enabled on this Shark.", "required": true, "type": "string" }, "error_text": { "description": "Error description.", "required": true, "type": "string" }, "last_sync_ts": { "description": "Last attempted application syncronization time.", "required": true, "type": "number" }, "last_success_ts": { "description": "Last successful application syncronization time.", "required": true, "type": "number" }, "is_alloy": { "description": "Device is AppResponse-based.", "required": true, "type": "string" }, "error_id": { "description": "Error ID.", "required": true, "type": "number" }, "state": { "description": "Synchronization status.", "required": true, "type": "string", "enum": [ "SYNC_INITIALIZING", "SYNC_FAILED", "SYNC_SUCCEEDED", "SYNC_DISABLED", "SYNC_NA" ] } }, "id": "SharkAppsObject", "type": "object" } }, "id": "SharkSyncObject", "type": "object" }, "ipaddr": { "description": "Shark IP address.", "required": true, "type": "string" } }, "id": "Shark", "type": "object" }, "id": "Sharks", "type": "array", "example": [] }, "authorization": "required" } } }, "Interfaces": { "methods": { "Delete interfaces": { "description": "Delete network interfaces with the given field values.", "request": { "description": "List of interfaces to delete.", "items": { "description": "object representing interface to delete.", "required": false, "properties": { "ipaddr": { "description": "IP address of interface to delete.", "required": true, "type": "string" }, "ifindex": { "description": "interface's index of interface to delete.", "required": true, "type": "number" } }, "id": "CInterfaceDeleteDef", "type": "object" }, "id": "CInterfaceDeleteDefs", "type": "array", "example": [ { "ifindex": 2, "ipaddr": "10.2.3.5" }, { "ifindex": 3, "ipaddr": "10.2.3.5" } ] }, "httpmethod": "DELETE", "path": "interfaces", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List silent interfaces": { "description": "Get all silent interafces by excluding all active interfaces listed in the given report.", "parameters": { "include_modified": { "required": false, "type": "string", "description": "if it is false, no modified interfaces will be considered silent (default is true)." }, "report_id": { "required": true, "type": "string", "description": "ID of the report containing all active interafces." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "interfaces/silent", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of interfaces.", "items": { "description": "Object representing an interface.", "required": false, "properties": { "mac": { "description": "Interface's mac address.", "required": true, "type": "string" }, "id": { "description": "Interface's ID.", "required": true, "type": "number" }, "fast_data_tracked": { "description": "Flag, that shows if the interface is fast data source tracked.", "required": false, "type": "string" }, "ifdescr": { "description": "Name (ifDescr).", "required": true, "type": "string" }, "outbound_speed": { "description": "Interface's reported outbound speed.", "required": false, "type": "number" }, "ifalias_override": { "description": "ifAlias (Override).", "required": false, "type": "string" }, "user_inbound_speed": { "description": "Interface's inbound speed declared by the user.", "required": false, "type": "number" }, "ipaddr": { "description": "IP address of the interface.", "required": true, "type": "string" }, "name": { "description": "Device name.", "required": true, "type": "string" }, "label": { "description": "Interface's label.", "required": true, "type": "string" }, "user_outbound_speed": { "description": "Interface's outbound speed declared by the user.", "required": false, "type": "number" }, "ifalias": { "description": "Description (ifAlias).", "required": true, "type": "string" }, "inbound_speed": { "description": "Interface's reported inbound speed.", "required": false, "type": "number" }, "ifindex": { "description": "Interface's index.", "required": true, "type": "number" } }, "id": "CInterfaceDef", "type": "object" }, "id": "CInterfaceDefs", "type": "array", "example": [ { "name": "Router1", "ipaddr": "10.2.5.5", "ifdescr": "6", "ifalias": "alias", "user_inbound_speed": 140736208929648, "inbound_speed": 140736208929120, "label": "4", "mac": "08:00:2b:01:02:04", "ifalias_override": "alias override", "fast_data_tracked": true, "ifindex": 2, "outbound_speed": 140736208929104, "user_outbound_speed": 44153724, "id": 3 }, { "name": "Router2", "ipaddr": "10.2.5.5", "ifdescr": "6", "ifalias": "alias", "user_inbound_speed": 140736208929648, "inbound_speed": 140736208929120, "label": "unique", "mac": "08:00:2b:01:02:05", "ifalias_override": "alias override", "fast_data_tracked": false, "ifindex": 2, "outbound_speed": 140736208929104, "user_outbound_speed": 44153724, "id": 4 } ] }, "authorization": "required" }, "Delete interface": { "description": "Delete one network interface. The operation is asynchronous. The interface will be deleted within few minutes to hours depending on how busy is the system.", "httpmethod": "DELETE", "path": "interfaces/{ip:ifindex}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Update interfaces": { "description": "Update network interfaces (fields that can be update: label, inbound speed, outbound speed).", "request": { "description": "List of update interfaces.", "items": { "description": "object representing update interface.", "required": false, "properties": { "fast_data_tracked": { "description": "update the flag, that shows if the interface is fast data source tracked, will be updated within a minute or two.", "required": false, "type": "string" }, "ifalias_override": { "description": "update interface's ifalias override.", "required": false, "type": "string" }, "user_inbound_speed": { "description": "update interface's inbound speed declared by the user.", "required": false, "type": "number" }, "ipaddr": { "description": "update interface's IP address.", "required": true, "type": "string" }, "label": { "description": "update interface's label.", "required": false, "type": "string" }, "user_outbound_speed": { "description": "update interface's outbound speed declared by the user.", "required": false, "type": "number" }, "ifindex": { "description": "update interface's index.", "required": true, "type": "number" } }, "id": "CInterfaceUpdateDef", "type": "object" }, "id": "CInterfaceUpdateDefs", "type": "array", "example": [ { "ipaddr": "10.2.3.5", "user_inbound_speed": 140736208929648, "label": "hsdgs", "ifalias_override": "my alias override", "fast_data_tracked": true, "ifindex": 2, "user_outbound_speed": 44153724 }, { "ipaddr": "10.2.3.5", "user_inbound_speed": 140736208929648, "label": "jhgvas", "ifalias_override": "my alias override", "fast_data_tracked": false, "ifindex": 3, "user_outbound_speed": 44153724 } ] }, "httpmethod": "PUT", "path": "interfaces", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get interface": { "description": "Get one network interface.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "interfaces/{ip:ifindex}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing an interface.", "properties": { "mac": { "description": "Interface's mac address.", "required": true, "type": "string" }, "id": { "description": "Interface's ID.", "required": true, "type": "number" }, "fast_data_tracked": { "description": "Flag, that shows if the interface is fast data source tracked.", "required": false, "type": "string" }, "ifdescr": { "description": "Name (ifDescr).", "required": true, "type": "string" }, "outbound_speed": { "description": "Interface's reported outbound speed.", "required": false, "type": "number" }, "ifalias_override": { "description": "ifAlias (Override).", "required": false, "type": "string" }, "user_inbound_speed": { "description": "Interface's inbound speed declared by the user.", "required": false, "type": "number" }, "ipaddr": { "description": "IP address of the interface.", "required": true, "type": "string" }, "name": { "description": "Device name.", "required": true, "type": "string" }, "label": { "description": "Interface's label.", "required": true, "type": "string" }, "user_outbound_speed": { "description": "Interface's outbound speed declared by the user.", "required": false, "type": "number" }, "ifalias": { "description": "Description (ifAlias).", "required": true, "type": "string" }, "inbound_speed": { "description": "Interface's reported inbound speed.", "required": false, "type": "number" }, "ifindex": { "description": "Interface's index.", "required": true, "type": "number" } }, "id": "CInterfaceDef", "type": "object", "example": { "name": "Device1", "ipaddr": "10.2.3.5", "ifdescr": "6", "ifalias": "alias", "user_inbound_speed": 140736208929648, "inbound_speed": 140736208929120, "label": "4", "mac": "08:00:2b:01:02:04", "ifalias_override": "my alias override", "fast_data_tracked": true, "ifindex": 2, "outbound_speed": 140736208929104, "user_outbound_speed": 44153724, "id": 2 } }, "authorization": "required" }, "List interfaces": { "description": "Get a list of all known network interfaces.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting element number." }, "ipaddr": { "required": false, "type": "string", "description": "Filter network interfaces by an IP address." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "interfaces", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of interfaces.", "items": { "description": "Object representing an interface.", "required": false, "properties": { "mac": { "description": "Interface's mac address.", "required": true, "type": "string" }, "id": { "description": "Interface's ID.", "required": true, "type": "number" }, "fast_data_tracked": { "description": "Flag, that shows if the interface is fast data source tracked.", "required": false, "type": "string" }, "ifdescr": { "description": "Name (ifDescr).", "required": true, "type": "string" }, "outbound_speed": { "description": "Interface's reported outbound speed.", "required": false, "type": "number" }, "ifalias_override": { "description": "ifAlias (Override).", "required": false, "type": "string" }, "user_inbound_speed": { "description": "Interface's inbound speed declared by the user.", "required": false, "type": "number" }, "ipaddr": { "description": "IP address of the interface.", "required": true, "type": "string" }, "name": { "description": "Device name.", "required": true, "type": "string" }, "label": { "description": "Interface's label.", "required": true, "type": "string" }, "user_outbound_speed": { "description": "Interface's outbound speed declared by the user.", "required": false, "type": "number" }, "ifalias": { "description": "Description (ifAlias).", "required": true, "type": "string" }, "inbound_speed": { "description": "Interface's reported inbound speed.", "required": false, "type": "number" }, "ifindex": { "description": "Interface's index.", "required": true, "type": "number" } }, "id": "CInterfaceDef", "type": "object" }, "id": "CInterfaceDefs", "type": "array", "example": [ { "name": "Router1", "ipaddr": "10.2.5.5", "ifdescr": "6", "ifalias": "alias", "user_inbound_speed": 140736208929648, "inbound_speed": 140736208929120, "label": "4", "mac": "08:00:2b:01:02:04", "ifalias_override": "alias override", "fast_data_tracked": true, "ifindex": 2, "outbound_speed": 140736208929104, "user_outbound_speed": 44153724, "id": 3 }, { "name": "Router2", "ipaddr": "10.2.5.5", "ifdescr": "6", "ifalias": "alias", "user_inbound_speed": 140736208929648, "inbound_speed": 140736208929120, "label": "unique", "mac": "08:00:2b:01:02:05", "ifalias_override": "alias override", "fast_data_tracked": false, "ifindex": 2, "outbound_speed": 140736208929104, "user_outbound_speed": 44153724, "id": 4 } ] }, "authorization": "required" } } }, "Autonomous_Systems": { "methods": { "Delete autonomous_system": { "description": "Delete a private Autonomous System. The data is cached, please do a system restart after using this operation .../system/restart.", "httpmethod": "DELETE", "path": "autonomous_systems/{number}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get autonomous_system": { "description": "Get a Autonomous System by AS Number.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "autonomous_systems/{number}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a Autonomous System.", "properties": { "id": { "description": "Autonomous System Number.", "required": true, "type": "number" }, "is_public": { "description": "Flag indicating if the Autonomous System is public.", "required": true, "type": "string" }, "name": { "description": "Autonomous System Name.", "required": true, "type": "string" } }, "id": "BGPAS", "type": "object", "example": { "is_public": false, "name": "RVBD-AS", "id": 64530 } }, "authorization": "required" }, "List autonomous_systems": { "description": "Get a list of Autonomous Systems.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting row number." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "autonomous_systems", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of Autonomous Systems.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": true, "type": "number" }, "is_public": { "description": "Flag indicating if the Autonomous System is public.", "required": true, "type": "string" }, "name": { "description": "Autonomous System Name.", "required": true, "type": "string" } }, "id": "BGPAS", "type": "object" }, "id": "BGPASList", "type": "array", "example": [ { "is_public": true, "name": "IANA-RSVD-0", "id": 0 }, { "is_public": true, "name": "LVLT-1", "id": 1 }, { "is_public": true, "name": "UDEL-DCN", "id": 2 }, { "is_public": true, "name": "MIT-GATEWAYS", "id": 3 }, { "is_public": true, "name": "ISI-AS", "id": 4 } ] }, "authorization": "required" }, "Update autonomous_system": { "description": "Update a private Autonomous System. The data is cached, please do a system restart after using this operation .../system/restart.", "request": { "description": "Object representing a Autonomous System.", "properties": { "id": { "description": "Autonomous System Number.", "required": true, "type": "number" }, "is_public": { "description": "Flag indicating if the Autonomous System is public.", "required": true, "type": "string" }, "name": { "description": "Autonomous System Name.", "required": true, "type": "string" } }, "id": "BGPAS", "type": "object", "example": { "is_public": false, "name": "RVBD-AS", "id": 64530 } }, "httpmethod": "PUT", "path": "autonomous_systems/{number}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Create autonomous_systems": { "description": "Create a new private Autonomous System. The data is cached, please do a system restart after using this operation .../system/restart.", "formats": [ "xml", "json" ], "request": { "description": "Object representing a Autonomous System.", "properties": { "id": { "description": "Autonomous System Number.", "required": true, "type": "number" }, "is_public": { "description": "Flag indicating if the Autonomous System is public.", "required": true, "type": "string" }, "name": { "description": "Autonomous System Name.", "required": true, "type": "string" } }, "id": "BGPAS", "type": "object", "example": { "is_public": false, "name": "RVBD-AS", "id": 64530 } }, "httpmethod": "POST", "path": "autonomous_systems", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a Autonomous System.", "properties": { "id": { "description": "Autonomous System Number.", "required": true, "type": "number" }, "is_public": { "description": "Flag indicating if the Autonomous System is public.", "required": true, "type": "string" }, "name": { "description": "Autonomous System Name.", "required": true, "type": "string" } }, "id": "BGPAS", "type": "object", "example": { "is_public": false, "name": "RVBD-AS", "id": 64530 } }, "authorization": "required" } } }, "User_Defined_Policies": { "methods": { "Enable policy": { "description": "Enable a user defined policy.", "httpmethod": "POST", "path": "user_defined_policies/{id}/enable", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Export all policies": { "description": "Export all user defined policies in one operation.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "user_defined_policies/export", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List/Export of User defined policy objects.", "items": { "description": "User defined policy object, includes traffic filters.", "required": false, "properties": { "enabled": { "description": "When true the policy is enabled and it will be monitored by the system.", "required": true, "type": "string" }, "alert_notification": { "description": "Object that includes an alert notification information.", "required": true, "properties": { "low_alert_recipient": { "description": "Low recipient name.", "required": false, "type": "string" }, "medium_alert_recipient_id": { "description": "Medium recipient id.", "required": false, "type": "number" }, "high_alert_recipient_id": { "description": "High recipient id.", "required": false, "type": "number" }, "low_alert_recipient_id": { "description": "Low recipient id.", "required": false, "type": "number" }, "high_alert_recipient": { "description": "High recipient name.", "required": false, "type": "string" }, "medium_alert_recipient": { "description": "Medium recipient name.", "required": false, "type": "string" } }, "id": "RuleAlertNotification", "type": "object" }, "id": { "description": "Policy identifier.", "required": false, "type": "number" }, "schedule": { "description": "Object that includes policy schedule information (when to track and fire events).", "required": true, "properties": { "time_zone_name": { "description": "Time zone name.", "required": false, "type": "string" }, "days": { "description": "List of days.", "items": { "description": "Day of the week.", "required": false, "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "required": true, "id": "RuleScheduleDays", "type": "array" }, "time_start": { "description": "Start time.", "required": true, "type": "number" }, "time_end": { "description": "End time.", "required": true, "type": "number" }, "time_zone_id": { "description": "Time zone id.", "required": false, "type": "number" } }, "id": "RuleSchedule", "type": "object" }, "deleted": { "description": "When true the policy is marked deleted. Deleted policies are kept for historical reasons and can be retrieved using the API.", "required": false, "type": "string" }, "revision_id": { "description": "When the policy is edited, this id is incremented.", "required": false, "type": "number" }, "filters": { "description": "Object that includes all traffic filters.", "required": true, "properties": { "server_hosts_count": { "description": "Statistics: flag to indicate how to count the server hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "ports": { "description": "Object that includes all traffic port/protocol/port group filters.", "required": false, "properties": { "ports": { "description": "List of port objects (Protocol/port).", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "negated": { "description": "Boolean flag indication whether the ports/protocols/port groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of port group objects.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "protocols": { "description": "List of protocol objects.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" } }, "id": "CPortsInput", "type": "object" }, "client_hosts": { "description": "Object that includes all traffic client host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces_path": { "description": "Object that includes all traffic interface/device/interface group in network path filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "client_hosts_count": { "description": "Statistics: flag to indicate how to count the client hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "server_hosts": { "description": "Object that includes all traffic server host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces": { "description": "Object that includes all traffic interface/device/interface group filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "dscps": { "description": "Object that includes all traffic dscp filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the DSCPs should be included (false) or excluded (true).", "required": false, "type": "string" }, "dscps": { "description": "List of DSCP objects.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" } }, "id": "CDSCPsInput", "type": "object" }, "applications": { "description": "Object that includes all traffic application filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the applications should be included (false) or excluded (true).", "required": false, "type": "string" }, "applications": { "description": "List of application objects.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "CApplicationsInput", "type": "object" } }, "id": "RuleFilters", "type": "object" }, "description": { "description": "Policy description.", "required": true, "type": "string" }, "name": { "description": "Policy name. Must be unique in the system.", "required": true, "type": "string" }, "type": { "description": "Policy type.", "required": true, "type": "string", "enum": [ "HOST", "INTERFACE", "RESPONSE_TIME" ] }, "threshold": { "description": "Object that includes threshold information (what metric to be tracked and how).", "required": true, "properties": { "metric": { "description": "Metric to be tracked.", "required": true, "type": "string", "enum": [ "BYTES", "PACKETS", "CONNS_NEW", "UTILIZATION", "SRV_DELAY", "RESP_RTT", "NET_RTT", "RETRANS_BYTES", "RETRANS_PACKETS", "RETRANS_BYTES_PCT", "RETRANS_PACKETS_PCT", "RESETS", "CONNS_ACTIVE", "CONNS_DURATION", "APP_THRUPUT_PERSECCONN", "MOS", "RFACTOR", "JITTER", "LOSS", "LOSS_PCT" ] }, "severity": { "description": "Threshold severity - the bigger the number the more serious the events would be considered (min 0, max 100, default 100).", "required": false, "type": "number" }, "scope": { "description": "Threshold scope: INDIVIDUAL: the threshold violates if any individual host violates; AVERAGE: the threshold violates if the average for the group violates (applies for response type policies only, default INDIVIDUAL).", "required": false, "type": "string", "enum": [ "INDIVIDUAL", "AVERAGE" ] }, "type": { "description": "Set to Below when the policy needs to trigger when the metric value goes below the threshold otherwise the policy triggers when the metric value goes above the threshold.", "required": true, "type": "string", "enum": [ "ABOVE", "BELOW" ] }, "direction": { "description": "Tracked direction.", "required": false, "type": "string", "enum": [ "A2B", "B2A", "EITHER_A2B_OR_B2A", "A2B_PLUS_B2A", "IN", "OUT", "IN_OR_OUT" ] }, "value": { "description": "Threshold value.", "required": true, "type": "string" }, "duration": { "description": "Number of consecutive minutes that metric must violate before an event is triggered (min 1, default 1).", "required": false, "type": "number" }, "rate": { "description": "Threshold rate (seconds, minutes, milliseconds).", "required": false, "type": "string", "enum": [ "PERMS", "PERSEC", "PERMIN" ] } }, "id": "RuleThreshold", "type": "object" } }, "id": "RuleDetail", "type": "object" }, "id": "RuleDetailList", "type": "array", "example": [ { "name": "HostPolicy1", "schedule": { "time_zone_id": 160, "time_zone_name": "America/New_York", "time_start": 0, "time_end": 86399, "days": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "deleted": false, "description": "Description text", "enabled": true, "filters": { "server_hosts": { "negated": true, "role": "SERVER", "hosts": [ { "ipaddr": "10.0.0.1" } ] }, "dscps": { "dscps": [ { "code_point": 10, "name": "AF11" }, { "code_point": 14, "name": "AF13" } ], "negated": false }, "interfaces": { "negated": false, "interfaces": [ { "ifindex": 1, "direction": "INBOUND", "ipaddr": "10.99.11.252" } ], "devices": [ { "ipaddr": "10.38.8.71" } ], "groups": [ { "path": "/WAN", "group_id": 2 } ] }, "server_hosts_count": "PERHOST", "applications": { "negated": false, "applications": [ { "tunneled": false, "id": 617, "name": "Facebook" }, { "tunneled": false, "id": 603, "name": "WEB" } ] }, "interfaces_path": { "negated": true, "groups": [ { "path": "/WAN/Optimized", "group_id": 3 } ] }, "client_hosts_count": "AGGREGATE", "client_hosts": { "negated": false, "role": "CLIENT", "hosts": [ { "ipaddr": "100.0.0.2" }, { "ipaddr": "100.0.0.1" } ], "cidrs": [ "10.0.0.0/8" ], "host_groups": [ { "group_type_id": 102, "group_id": 5, "group_type_name": "ByLocation", "group_name": "Boston" }, { "group_type_id": 102, "group_id": 4, "group_type_name": "ByLocation", "group_name": "Dallas" } ] }, "ports": { "negated": false, "protocols": [ { "id": 6, "name": "tcp" } ], "ports": [ { "protocol": 17, "name": "udp/80", "port": 80 } ], "groups": [ { "group_id": 2, "name": "Email" } ] } }, "threshold": { "direction": "EITHER_A2B_OR_B2A", "severity": 100, "metric": "BYTES", "value": 1, "rate": "PERSEC", "duration": 1, "type": "ABOVE" }, "revision_id": 12023, "type": "HOST", "id": 12024, "alert_notification": { "low_alert_recipient": "Default", "high_alert_recipient": "Mark", "high_alert_recipient_id": 65, "medium_alert_recipient": "* Owner", "medium_alert_recipient_id": 2, "low_alert_recipient_id": 1 } } ] }, "authorization": "required" }, "Get policy": { "description": "Get a user defined policy.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "user_defined_policies/{id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a User defined policy, includes traffic filters.", "properties": { "enabled": { "description": "When true the policy is enabled and it will be monitored by the system.", "required": true, "type": "string" }, "alert_notification": { "description": "Object that includes an alert notification information.", "required": true, "properties": { "low_alert_recipient": { "description": "Low recipient name.", "required": false, "type": "string" }, "medium_alert_recipient_id": { "description": "Medium recipient id.", "required": false, "type": "number" }, "high_alert_recipient_id": { "description": "High recipient id.", "required": false, "type": "number" }, "low_alert_recipient_id": { "description": "Low recipient id.", "required": false, "type": "number" }, "high_alert_recipient": { "description": "High recipient name.", "required": false, "type": "string" }, "medium_alert_recipient": { "description": "Medium recipient name.", "required": false, "type": "string" } }, "id": "RuleAlertNotification", "type": "object" }, "id": { "description": "Policy identifier.", "required": false, "type": "number" }, "schedule": { "description": "Object that includes policy schedule information (when to track and fire events).", "required": true, "properties": { "time_zone_name": { "description": "Time zone name.", "required": false, "type": "string" }, "days": { "description": "List of days.", "items": { "description": "Day of the week.", "required": false, "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "required": true, "id": "RuleScheduleDays", "type": "array" }, "time_start": { "description": "Start time.", "required": true, "type": "number" }, "time_end": { "description": "End time.", "required": true, "type": "number" }, "time_zone_id": { "description": "Time zone id.", "required": false, "type": "number" } }, "id": "RuleSchedule", "type": "object" }, "deleted": { "description": "When true the policy is marked deleted. Deleted policies are kept for historical reasons and can be retrieved using the API.", "required": false, "type": "string" }, "revision_id": { "description": "When the policy is edited, this id is incremented.", "required": false, "type": "number" }, "filters": { "description": "Object that includes all traffic filters.", "required": true, "properties": { "server_hosts_count": { "description": "Statistics: flag to indicate how to count the server hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "ports": { "description": "Object that includes all traffic port/protocol/port group filters.", "required": false, "properties": { "ports": { "description": "List of port objects (Protocol/port).", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "negated": { "description": "Boolean flag indication whether the ports/protocols/port groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of port group objects.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "protocols": { "description": "List of protocol objects.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" } }, "id": "CPortsInput", "type": "object" }, "client_hosts": { "description": "Object that includes all traffic client host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces_path": { "description": "Object that includes all traffic interface/device/interface group in network path filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "client_hosts_count": { "description": "Statistics: flag to indicate how to count the client hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "server_hosts": { "description": "Object that includes all traffic server host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces": { "description": "Object that includes all traffic interface/device/interface group filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "dscps": { "description": "Object that includes all traffic dscp filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the DSCPs should be included (false) or excluded (true).", "required": false, "type": "string" }, "dscps": { "description": "List of DSCP objects.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" } }, "id": "CDSCPsInput", "type": "object" }, "applications": { "description": "Object that includes all traffic application filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the applications should be included (false) or excluded (true).", "required": false, "type": "string" }, "applications": { "description": "List of application objects.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "CApplicationsInput", "type": "object" } }, "id": "RuleFilters", "type": "object" }, "description": { "description": "Policy description.", "required": true, "type": "string" }, "name": { "description": "Policy name. Must be unique in the system.", "required": true, "type": "string" }, "type": { "description": "Policy type.", "required": true, "type": "string", "enum": [ "HOST", "INTERFACE", "RESPONSE_TIME" ] }, "threshold": { "description": "Object that includes threshold information (what metric to be tracked and how).", "required": true, "properties": { "metric": { "description": "Metric to be tracked.", "required": true, "type": "string", "enum": [ "BYTES", "PACKETS", "CONNS_NEW", "UTILIZATION", "SRV_DELAY", "RESP_RTT", "NET_RTT", "RETRANS_BYTES", "RETRANS_PACKETS", "RETRANS_BYTES_PCT", "RETRANS_PACKETS_PCT", "RESETS", "CONNS_ACTIVE", "CONNS_DURATION", "APP_THRUPUT_PERSECCONN", "MOS", "RFACTOR", "JITTER", "LOSS", "LOSS_PCT" ] }, "severity": { "description": "Threshold severity - the bigger the number the more serious the events would be considered (min 0, max 100, default 100).", "required": false, "type": "number" }, "scope": { "description": "Threshold scope: INDIVIDUAL: the threshold violates if any individual host violates; AVERAGE: the threshold violates if the average for the group violates (applies for response type policies only, default INDIVIDUAL).", "required": false, "type": "string", "enum": [ "INDIVIDUAL", "AVERAGE" ] }, "type": { "description": "Set to Below when the policy needs to trigger when the metric value goes below the threshold otherwise the policy triggers when the metric value goes above the threshold.", "required": true, "type": "string", "enum": [ "ABOVE", "BELOW" ] }, "direction": { "description": "Tracked direction.", "required": false, "type": "string", "enum": [ "A2B", "B2A", "EITHER_A2B_OR_B2A", "A2B_PLUS_B2A", "IN", "OUT", "IN_OR_OUT" ] }, "value": { "description": "Threshold value.", "required": true, "type": "string" }, "duration": { "description": "Number of consecutive minutes that metric must violate before an event is triggered (min 1, default 1).", "required": false, "type": "number" }, "rate": { "description": "Threshold rate (seconds, minutes, milliseconds).", "required": false, "type": "string", "enum": [ "PERMS", "PERSEC", "PERMIN" ] } }, "id": "RuleThreshold", "type": "object" } }, "id": "RuleDetail", "type": "object", "example": { "name": "HostPolicy1", "schedule": { "time_zone_id": 160, "time_zone_name": "America/New_York", "time_start": 0, "time_end": 86399, "days": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "deleted": false, "description": "Description text", "enabled": true, "filters": { "server_hosts": { "negated": true, "role": "SERVER", "hosts": [ { "ipaddr": "10.0.0.1" } ] }, "dscps": { "dscps": [ { "code_point": 10, "name": "AF11" }, { "code_point": 14, "name": "AF13" } ], "negated": false }, "interfaces": { "negated": false, "interfaces": [ { "ifindex": 1, "direction": "INBOUND", "ipaddr": "10.99.11.252" } ], "devices": [ { "ipaddr": "10.38.8.71" } ], "groups": [ { "path": "/WAN", "group_id": 2 } ] }, "server_hosts_count": "PERHOST", "applications": { "negated": false, "applications": [ { "tunneled": false, "id": 617, "name": "Facebook" }, { "tunneled": false, "id": 603, "name": "WEB" } ] }, "interfaces_path": { "negated": true, "groups": [ { "path": "/WAN/Optimized", "group_id": 3 } ] }, "client_hosts_count": "AGGREGATE", "client_hosts": { "negated": false, "role": "CLIENT", "hosts": [ { "ipaddr": "100.0.0.2" }, { "ipaddr": "100.0.0.1" } ], "cidrs": [ "10.0.0.0/8" ], "host_groups": [ { "group_type_id": 102, "group_id": 5, "group_type_name": "ByLocation", "group_name": "Boston" }, { "group_type_id": 102, "group_id": 4, "group_type_name": "ByLocation", "group_name": "Dallas" } ] }, "ports": { "negated": false, "protocols": [ { "id": 6, "name": "tcp" } ], "ports": [ { "protocol": 17, "name": "udp/80", "port": 80 } ], "groups": [ { "group_id": 2, "name": "Email" } ] } }, "threshold": { "direction": "EITHER_A2B_OR_B2A", "severity": 100, "metric": "BYTES", "value": 1, "rate": "PERSEC", "duration": 1, "type": "ABOVE" }, "revision_id": 12023, "type": "HOST", "id": 12024, "alert_notification": { "low_alert_recipient": "Default", "high_alert_recipient": "Mark", "high_alert_recipient_id": 65, "medium_alert_recipient": "* Owner", "medium_alert_recipient_id": 2, "low_alert_recipient_id": 1 } } }, "authorization": "required" }, "Create policy": { "description": "Create a new user defined policy.", "formats": [ "xml", "json" ], "request": { "description": "Object representing a User defined policy, includes traffic filters.", "properties": { "enabled": { "description": "When true the policy is enabled and it will be monitored by the system.", "required": true, "type": "string" }, "alert_notification": { "description": "Object that includes an alert notification information.", "required": true, "properties": { "low_alert_recipient": { "description": "Low recipient name.", "required": false, "type": "string" }, "medium_alert_recipient_id": { "description": "Medium recipient id.", "required": false, "type": "number" }, "high_alert_recipient_id": { "description": "High recipient id.", "required": false, "type": "number" }, "low_alert_recipient_id": { "description": "Low recipient id.", "required": false, "type": "number" }, "high_alert_recipient": { "description": "High recipient name.", "required": false, "type": "string" }, "medium_alert_recipient": { "description": "Medium recipient name.", "required": false, "type": "string" } }, "id": "RuleAlertNotification", "type": "object" }, "id": { "description": "Policy identifier.", "required": false, "type": "number" }, "schedule": { "description": "Object that includes policy schedule information (when to track and fire events).", "required": true, "properties": { "time_zone_name": { "description": "Time zone name.", "required": false, "type": "string" }, "days": { "description": "List of days.", "items": { "description": "Day of the week.", "required": false, "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "required": true, "id": "RuleScheduleDays", "type": "array" }, "time_start": { "description": "Start time.", "required": true, "type": "number" }, "time_end": { "description": "End time.", "required": true, "type": "number" }, "time_zone_id": { "description": "Time zone id.", "required": false, "type": "number" } }, "id": "RuleSchedule", "type": "object" }, "deleted": { "description": "When true the policy is marked deleted. Deleted policies are kept for historical reasons and can be retrieved using the API.", "required": false, "type": "string" }, "revision_id": { "description": "When the policy is edited, this id is incremented.", "required": false, "type": "number" }, "filters": { "description": "Object that includes all traffic filters.", "required": true, "properties": { "server_hosts_count": { "description": "Statistics: flag to indicate how to count the server hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "ports": { "description": "Object that includes all traffic port/protocol/port group filters.", "required": false, "properties": { "ports": { "description": "List of port objects (Protocol/port).", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "negated": { "description": "Boolean flag indication whether the ports/protocols/port groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of port group objects.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "protocols": { "description": "List of protocol objects.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" } }, "id": "CPortsInput", "type": "object" }, "client_hosts": { "description": "Object that includes all traffic client host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces_path": { "description": "Object that includes all traffic interface/device/interface group in network path filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "client_hosts_count": { "description": "Statistics: flag to indicate how to count the client hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "server_hosts": { "description": "Object that includes all traffic server host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces": { "description": "Object that includes all traffic interface/device/interface group filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "dscps": { "description": "Object that includes all traffic dscp filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the DSCPs should be included (false) or excluded (true).", "required": false, "type": "string" }, "dscps": { "description": "List of DSCP objects.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" } }, "id": "CDSCPsInput", "type": "object" }, "applications": { "description": "Object that includes all traffic application filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the applications should be included (false) or excluded (true).", "required": false, "type": "string" }, "applications": { "description": "List of application objects.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "CApplicationsInput", "type": "object" } }, "id": "RuleFilters", "type": "object" }, "description": { "description": "Policy description.", "required": true, "type": "string" }, "name": { "description": "Policy name. Must be unique in the system.", "required": true, "type": "string" }, "type": { "description": "Policy type.", "required": true, "type": "string", "enum": [ "HOST", "INTERFACE", "RESPONSE_TIME" ] }, "threshold": { "description": "Object that includes threshold information (what metric to be tracked and how).", "required": true, "properties": { "metric": { "description": "Metric to be tracked.", "required": true, "type": "string", "enum": [ "BYTES", "PACKETS", "CONNS_NEW", "UTILIZATION", "SRV_DELAY", "RESP_RTT", "NET_RTT", "RETRANS_BYTES", "RETRANS_PACKETS", "RETRANS_BYTES_PCT", "RETRANS_PACKETS_PCT", "RESETS", "CONNS_ACTIVE", "CONNS_DURATION", "APP_THRUPUT_PERSECCONN", "MOS", "RFACTOR", "JITTER", "LOSS", "LOSS_PCT" ] }, "severity": { "description": "Threshold severity - the bigger the number the more serious the events would be considered (min 0, max 100, default 100).", "required": false, "type": "number" }, "scope": { "description": "Threshold scope: INDIVIDUAL: the threshold violates if any individual host violates; AVERAGE: the threshold violates if the average for the group violates (applies for response type policies only, default INDIVIDUAL).", "required": false, "type": "string", "enum": [ "INDIVIDUAL", "AVERAGE" ] }, "type": { "description": "Set to Below when the policy needs to trigger when the metric value goes below the threshold otherwise the policy triggers when the metric value goes above the threshold.", "required": true, "type": "string", "enum": [ "ABOVE", "BELOW" ] }, "direction": { "description": "Tracked direction.", "required": false, "type": "string", "enum": [ "A2B", "B2A", "EITHER_A2B_OR_B2A", "A2B_PLUS_B2A", "IN", "OUT", "IN_OR_OUT" ] }, "value": { "description": "Threshold value.", "required": true, "type": "string" }, "duration": { "description": "Number of consecutive minutes that metric must violate before an event is triggered (min 1, default 1).", "required": false, "type": "number" }, "rate": { "description": "Threshold rate (seconds, minutes, milliseconds).", "required": false, "type": "string", "enum": [ "PERMS", "PERSEC", "PERMIN" ] } }, "id": "RuleThreshold", "type": "object" } }, "id": "RuleDetail", "type": "object", "example": { "name": "HostPolicy1", "schedule": { "time_zone_id": 160, "time_zone_name": "America/New_York", "time_start": 0, "time_end": 86399, "days": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "deleted": false, "description": "Description text", "enabled": true, "filters": { "server_hosts": { "negated": true, "role": "SERVER", "hosts": [ { "ipaddr": "10.0.0.1" } ] }, "dscps": { "dscps": [ { "code_point": 10, "name": "AF11" }, { "code_point": 14, "name": "AF13" } ], "negated": false }, "interfaces": { "negated": false, "interfaces": [ { "ifindex": 1, "direction": "INBOUND", "ipaddr": "10.99.11.252" } ], "devices": [ { "ipaddr": "10.38.8.71" } ], "groups": [ { "path": "/WAN", "group_id": 2 } ] }, "server_hosts_count": "PERHOST", "applications": { "negated": false, "applications": [ { "tunneled": false, "id": 617, "name": "Facebook" }, { "tunneled": false, "id": 603, "name": "WEB" } ] }, "interfaces_path": { "negated": true, "groups": [ { "path": "/WAN/Optimized", "group_id": 3 } ] }, "client_hosts_count": "AGGREGATE", "client_hosts": { "negated": false, "role": "CLIENT", "hosts": [ { "ipaddr": "100.0.0.2" }, { "ipaddr": "100.0.0.1" } ], "cidrs": [ "10.0.0.0/8" ], "host_groups": [ { "group_type_id": 102, "group_id": 5, "group_type_name": "ByLocation", "group_name": "Boston" }, { "group_type_id": 102, "group_id": 4, "group_type_name": "ByLocation", "group_name": "Dallas" } ] }, "ports": { "negated": false, "protocols": [ { "id": 6, "name": "tcp" } ], "ports": [ { "protocol": 17, "name": "udp/80", "port": 80 } ], "groups": [ { "group_id": 2, "name": "Email" } ] } }, "threshold": { "direction": "EITHER_A2B_OR_B2A", "severity": 100, "metric": "BYTES", "value": 1, "rate": "PERSEC", "duration": 1, "type": "ABOVE" }, "revision_id": 12023, "type": "HOST", "id": 12024, "alert_notification": { "low_alert_recipient": "Default", "high_alert_recipient": "Mark", "high_alert_recipient_id": 65, "medium_alert_recipient": "* Owner", "medium_alert_recipient_id": 2, "low_alert_recipient_id": 1 } } }, "httpmethod": "POST", "path": "user_defined_policies", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a User defined policy, includes traffic filters.", "properties": { "enabled": { "description": "When true the policy is enabled and it will be monitored by the system.", "required": true, "type": "string" }, "alert_notification": { "description": "Object that includes an alert notification information.", "required": true, "properties": { "low_alert_recipient": { "description": "Low recipient name.", "required": false, "type": "string" }, "medium_alert_recipient_id": { "description": "Medium recipient id.", "required": false, "type": "number" }, "high_alert_recipient_id": { "description": "High recipient id.", "required": false, "type": "number" }, "low_alert_recipient_id": { "description": "Low recipient id.", "required": false, "type": "number" }, "high_alert_recipient": { "description": "High recipient name.", "required": false, "type": "string" }, "medium_alert_recipient": { "description": "Medium recipient name.", "required": false, "type": "string" } }, "id": "RuleAlertNotification", "type": "object" }, "id": { "description": "Policy identifier.", "required": false, "type": "number" }, "schedule": { "description": "Object that includes policy schedule information (when to track and fire events).", "required": true, "properties": { "time_zone_name": { "description": "Time zone name.", "required": false, "type": "string" }, "days": { "description": "List of days.", "items": { "description": "Day of the week.", "required": false, "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "required": true, "id": "RuleScheduleDays", "type": "array" }, "time_start": { "description": "Start time.", "required": true, "type": "number" }, "time_end": { "description": "End time.", "required": true, "type": "number" }, "time_zone_id": { "description": "Time zone id.", "required": false, "type": "number" } }, "id": "RuleSchedule", "type": "object" }, "deleted": { "description": "When true the policy is marked deleted. Deleted policies are kept for historical reasons and can be retrieved using the API.", "required": false, "type": "string" }, "revision_id": { "description": "When the policy is edited, this id is incremented.", "required": false, "type": "number" }, "filters": { "description": "Object that includes all traffic filters.", "required": true, "properties": { "server_hosts_count": { "description": "Statistics: flag to indicate how to count the server hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "ports": { "description": "Object that includes all traffic port/protocol/port group filters.", "required": false, "properties": { "ports": { "description": "List of port objects (Protocol/port).", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "negated": { "description": "Boolean flag indication whether the ports/protocols/port groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of port group objects.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "protocols": { "description": "List of protocol objects.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" } }, "id": "CPortsInput", "type": "object" }, "client_hosts": { "description": "Object that includes all traffic client host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces_path": { "description": "Object that includes all traffic interface/device/interface group in network path filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "client_hosts_count": { "description": "Statistics: flag to indicate how to count the client hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "server_hosts": { "description": "Object that includes all traffic server host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces": { "description": "Object that includes all traffic interface/device/interface group filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "dscps": { "description": "Object that includes all traffic dscp filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the DSCPs should be included (false) or excluded (true).", "required": false, "type": "string" }, "dscps": { "description": "List of DSCP objects.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" } }, "id": "CDSCPsInput", "type": "object" }, "applications": { "description": "Object that includes all traffic application filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the applications should be included (false) or excluded (true).", "required": false, "type": "string" }, "applications": { "description": "List of application objects.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "CApplicationsInput", "type": "object" } }, "id": "RuleFilters", "type": "object" }, "description": { "description": "Policy description.", "required": true, "type": "string" }, "name": { "description": "Policy name. Must be unique in the system.", "required": true, "type": "string" }, "type": { "description": "Policy type.", "required": true, "type": "string", "enum": [ "HOST", "INTERFACE", "RESPONSE_TIME" ] }, "threshold": { "description": "Object that includes threshold information (what metric to be tracked and how).", "required": true, "properties": { "metric": { "description": "Metric to be tracked.", "required": true, "type": "string", "enum": [ "BYTES", "PACKETS", "CONNS_NEW", "UTILIZATION", "SRV_DELAY", "RESP_RTT", "NET_RTT", "RETRANS_BYTES", "RETRANS_PACKETS", "RETRANS_BYTES_PCT", "RETRANS_PACKETS_PCT", "RESETS", "CONNS_ACTIVE", "CONNS_DURATION", "APP_THRUPUT_PERSECCONN", "MOS", "RFACTOR", "JITTER", "LOSS", "LOSS_PCT" ] }, "severity": { "description": "Threshold severity - the bigger the number the more serious the events would be considered (min 0, max 100, default 100).", "required": false, "type": "number" }, "scope": { "description": "Threshold scope: INDIVIDUAL: the threshold violates if any individual host violates; AVERAGE: the threshold violates if the average for the group violates (applies for response type policies only, default INDIVIDUAL).", "required": false, "type": "string", "enum": [ "INDIVIDUAL", "AVERAGE" ] }, "type": { "description": "Set to Below when the policy needs to trigger when the metric value goes below the threshold otherwise the policy triggers when the metric value goes above the threshold.", "required": true, "type": "string", "enum": [ "ABOVE", "BELOW" ] }, "direction": { "description": "Tracked direction.", "required": false, "type": "string", "enum": [ "A2B", "B2A", "EITHER_A2B_OR_B2A", "A2B_PLUS_B2A", "IN", "OUT", "IN_OR_OUT" ] }, "value": { "description": "Threshold value.", "required": true, "type": "string" }, "duration": { "description": "Number of consecutive minutes that metric must violate before an event is triggered (min 1, default 1).", "required": false, "type": "number" }, "rate": { "description": "Threshold rate (seconds, minutes, milliseconds).", "required": false, "type": "string", "enum": [ "PERMS", "PERSEC", "PERMIN" ] } }, "id": "RuleThreshold", "type": "object" } }, "id": "RuleDetail", "type": "object", "example": { "name": "HostPolicy1", "schedule": { "time_zone_id": 160, "time_zone_name": "America/New_York", "time_start": 0, "time_end": 86399, "days": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "deleted": false, "description": "Description text", "enabled": true, "filters": { "server_hosts": { "negated": true, "role": "SERVER", "hosts": [ { "ipaddr": "10.0.0.1" } ] }, "dscps": { "dscps": [ { "code_point": 10, "name": "AF11" }, { "code_point": 14, "name": "AF13" } ], "negated": false }, "interfaces": { "negated": false, "interfaces": [ { "ifindex": 1, "direction": "INBOUND", "ipaddr": "10.99.11.252" } ], "devices": [ { "ipaddr": "10.38.8.71" } ], "groups": [ { "path": "/WAN", "group_id": 2 } ] }, "server_hosts_count": "PERHOST", "applications": { "negated": false, "applications": [ { "tunneled": false, "id": 617, "name": "Facebook" }, { "tunneled": false, "id": 603, "name": "WEB" } ] }, "interfaces_path": { "negated": true, "groups": [ { "path": "/WAN/Optimized", "group_id": 3 } ] }, "client_hosts_count": "AGGREGATE", "client_hosts": { "negated": false, "role": "CLIENT", "hosts": [ { "ipaddr": "100.0.0.2" }, { "ipaddr": "100.0.0.1" } ], "cidrs": [ "10.0.0.0/8" ], "host_groups": [ { "group_type_id": 102, "group_id": 5, "group_type_name": "ByLocation", "group_name": "Boston" }, { "group_type_id": 102, "group_id": 4, "group_type_name": "ByLocation", "group_name": "Dallas" } ] }, "ports": { "negated": false, "protocols": [ { "id": 6, "name": "tcp" } ], "ports": [ { "protocol": 17, "name": "udp/80", "port": 80 } ], "groups": [ { "group_id": 2, "name": "Email" } ] } }, "threshold": { "direction": "EITHER_A2B_OR_B2A", "severity": 100, "metric": "BYTES", "value": 1, "rate": "PERSEC", "duration": 1, "type": "ABOVE" }, "revision_id": 12023, "type": "HOST", "id": 12024, "alert_notification": { "low_alert_recipient": "Default", "high_alert_recipient": "Mark", "high_alert_recipient_id": 65, "medium_alert_recipient": "* Owner", "medium_alert_recipient_id": 2, "low_alert_recipient_id": 1 } } }, "authorization": "required" }, "Create policies": { "description": "Create multiple user defined policies in one operation.", "request": { "description": "List/Export of User defined policy objects.", "items": { "description": "User defined policy object, includes traffic filters.", "required": false, "properties": { "enabled": { "description": "When true the policy is enabled and it will be monitored by the system.", "required": true, "type": "string" }, "alert_notification": { "description": "Object that includes an alert notification information.", "required": true, "properties": { "low_alert_recipient": { "description": "Low recipient name.", "required": false, "type": "string" }, "medium_alert_recipient_id": { "description": "Medium recipient id.", "required": false, "type": "number" }, "high_alert_recipient_id": { "description": "High recipient id.", "required": false, "type": "number" }, "low_alert_recipient_id": { "description": "Low recipient id.", "required": false, "type": "number" }, "high_alert_recipient": { "description": "High recipient name.", "required": false, "type": "string" }, "medium_alert_recipient": { "description": "Medium recipient name.", "required": false, "type": "string" } }, "id": "RuleAlertNotification", "type": "object" }, "id": { "description": "Policy identifier.", "required": false, "type": "number" }, "schedule": { "description": "Object that includes policy schedule information (when to track and fire events).", "required": true, "properties": { "time_zone_name": { "description": "Time zone name.", "required": false, "type": "string" }, "days": { "description": "List of days.", "items": { "description": "Day of the week.", "required": false, "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "required": true, "id": "RuleScheduleDays", "type": "array" }, "time_start": { "description": "Start time.", "required": true, "type": "number" }, "time_end": { "description": "End time.", "required": true, "type": "number" }, "time_zone_id": { "description": "Time zone id.", "required": false, "type": "number" } }, "id": "RuleSchedule", "type": "object" }, "deleted": { "description": "When true the policy is marked deleted. Deleted policies are kept for historical reasons and can be retrieved using the API.", "required": false, "type": "string" }, "revision_id": { "description": "When the policy is edited, this id is incremented.", "required": false, "type": "number" }, "filters": { "description": "Object that includes all traffic filters.", "required": true, "properties": { "server_hosts_count": { "description": "Statistics: flag to indicate how to count the server hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "ports": { "description": "Object that includes all traffic port/protocol/port group filters.", "required": false, "properties": { "ports": { "description": "List of port objects (Protocol/port).", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "negated": { "description": "Boolean flag indication whether the ports/protocols/port groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of port group objects.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "protocols": { "description": "List of protocol objects.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" } }, "id": "CPortsInput", "type": "object" }, "client_hosts": { "description": "Object that includes all traffic client host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces_path": { "description": "Object that includes all traffic interface/device/interface group in network path filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "client_hosts_count": { "description": "Statistics: flag to indicate how to count the client hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "server_hosts": { "description": "Object that includes all traffic server host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces": { "description": "Object that includes all traffic interface/device/interface group filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "dscps": { "description": "Object that includes all traffic dscp filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the DSCPs should be included (false) or excluded (true).", "required": false, "type": "string" }, "dscps": { "description": "List of DSCP objects.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" } }, "id": "CDSCPsInput", "type": "object" }, "applications": { "description": "Object that includes all traffic application filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the applications should be included (false) or excluded (true).", "required": false, "type": "string" }, "applications": { "description": "List of application objects.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "CApplicationsInput", "type": "object" } }, "id": "RuleFilters", "type": "object" }, "description": { "description": "Policy description.", "required": true, "type": "string" }, "name": { "description": "Policy name. Must be unique in the system.", "required": true, "type": "string" }, "type": { "description": "Policy type.", "required": true, "type": "string", "enum": [ "HOST", "INTERFACE", "RESPONSE_TIME" ] }, "threshold": { "description": "Object that includes threshold information (what metric to be tracked and how).", "required": true, "properties": { "metric": { "description": "Metric to be tracked.", "required": true, "type": "string", "enum": [ "BYTES", "PACKETS", "CONNS_NEW", "UTILIZATION", "SRV_DELAY", "RESP_RTT", "NET_RTT", "RETRANS_BYTES", "RETRANS_PACKETS", "RETRANS_BYTES_PCT", "RETRANS_PACKETS_PCT", "RESETS", "CONNS_ACTIVE", "CONNS_DURATION", "APP_THRUPUT_PERSECCONN", "MOS", "RFACTOR", "JITTER", "LOSS", "LOSS_PCT" ] }, "severity": { "description": "Threshold severity - the bigger the number the more serious the events would be considered (min 0, max 100, default 100).", "required": false, "type": "number" }, "scope": { "description": "Threshold scope: INDIVIDUAL: the threshold violates if any individual host violates; AVERAGE: the threshold violates if the average for the group violates (applies for response type policies only, default INDIVIDUAL).", "required": false, "type": "string", "enum": [ "INDIVIDUAL", "AVERAGE" ] }, "type": { "description": "Set to Below when the policy needs to trigger when the metric value goes below the threshold otherwise the policy triggers when the metric value goes above the threshold.", "required": true, "type": "string", "enum": [ "ABOVE", "BELOW" ] }, "direction": { "description": "Tracked direction.", "required": false, "type": "string", "enum": [ "A2B", "B2A", "EITHER_A2B_OR_B2A", "A2B_PLUS_B2A", "IN", "OUT", "IN_OR_OUT" ] }, "value": { "description": "Threshold value.", "required": true, "type": "string" }, "duration": { "description": "Number of consecutive minutes that metric must violate before an event is triggered (min 1, default 1).", "required": false, "type": "number" }, "rate": { "description": "Threshold rate (seconds, minutes, milliseconds).", "required": false, "type": "string", "enum": [ "PERMS", "PERSEC", "PERMIN" ] } }, "id": "RuleThreshold", "type": "object" } }, "id": "RuleDetail", "type": "object" }, "id": "RuleDetailList", "type": "array", "example": [ { "name": "HostPolicy1", "schedule": { "time_zone_id": 160, "time_zone_name": "America/New_York", "time_start": 0, "time_end": 86399, "days": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "deleted": false, "description": "Description text", "enabled": true, "filters": { "server_hosts": { "negated": true, "role": "SERVER", "hosts": [ { "ipaddr": "10.0.0.1" } ] }, "dscps": { "dscps": [ { "code_point": 10, "name": "AF11" }, { "code_point": 14, "name": "AF13" } ], "negated": false }, "interfaces": { "negated": false, "interfaces": [ { "ifindex": 1, "direction": "INBOUND", "ipaddr": "10.99.11.252" } ], "devices": [ { "ipaddr": "10.38.8.71" } ], "groups": [ { "path": "/WAN", "group_id": 2 } ] }, "server_hosts_count": "PERHOST", "applications": { "negated": false, "applications": [ { "tunneled": false, "id": 617, "name": "Facebook" }, { "tunneled": false, "id": 603, "name": "WEB" } ] }, "interfaces_path": { "negated": true, "groups": [ { "path": "/WAN/Optimized", "group_id": 3 } ] }, "client_hosts_count": "AGGREGATE", "client_hosts": { "negated": false, "role": "CLIENT", "hosts": [ { "ipaddr": "100.0.0.2" }, { "ipaddr": "100.0.0.1" } ], "cidrs": [ "10.0.0.0/8" ], "host_groups": [ { "group_type_id": 102, "group_id": 5, "group_type_name": "ByLocation", "group_name": "Boston" }, { "group_type_id": 102, "group_id": 4, "group_type_name": "ByLocation", "group_name": "Dallas" } ] }, "ports": { "negated": false, "protocols": [ { "id": 6, "name": "tcp" } ], "ports": [ { "protocol": 17, "name": "udp/80", "port": 80 } ], "groups": [ { "group_id": 2, "name": "Email" } ] } }, "threshold": { "direction": "EITHER_A2B_OR_B2A", "severity": 100, "metric": "BYTES", "value": 1, "rate": "PERSEC", "duration": 1, "type": "ABOVE" }, "revision_id": 12023, "type": "HOST", "id": 12024, "alert_notification": { "low_alert_recipient": "Default", "high_alert_recipient": "Mark", "high_alert_recipient_id": 65, "medium_alert_recipient": "* Owner", "medium_alert_recipient_id": 2, "low_alert_recipient_id": 1 } } ] }, "httpmethod": "POST", "path": "user_defined_policies/import", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List of policies": { "description": "Get a list of user defined policies.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting row number." }, "sortby": { "required": false, "type": "string", "description": "Sort by one of the following options: name (default), enabled, severity, type." }, "sort": { "required": false, "type": "string", "description": "Sort order: asc (default) or desc." }, "name": { "required": false, "type": "string", "description": "Filter to list to one policy with this name." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "user_defined_policies", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of User defined policy objects.", "items": { "description": "User defined policy object.", "required": false, "properties": { "enabled": { "description": "When true the policy is enabled and it will be monitored by the system.", "required": true, "type": "string" }, "alert_notification": { "description": "Object that includes an alert notification information.", "required": true, "properties": { "low_alert_recipient": { "description": "Low recipient name.", "required": false, "type": "string" }, "medium_alert_recipient_id": { "description": "Medium recipient id.", "required": false, "type": "number" }, "high_alert_recipient_id": { "description": "High recipient id.", "required": false, "type": "number" }, "low_alert_recipient_id": { "description": "Low recipient id.", "required": false, "type": "number" }, "high_alert_recipient": { "description": "High recipient name.", "required": false, "type": "string" }, "medium_alert_recipient": { "description": "Medium recipient name.", "required": false, "type": "string" } }, "id": "RuleAlertNotification", "type": "object" }, "id": { "description": "Policy identifier.", "required": false, "type": "number" }, "schedule": { "description": "Object that includes policy schedule information (when to track and fire events).", "required": true, "properties": { "time_zone_name": { "description": "Time zone name.", "required": false, "type": "string" }, "days": { "description": "List of days.", "items": { "description": "Day of the week.", "required": false, "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "required": true, "id": "RuleScheduleDays", "type": "array" }, "time_start": { "description": "Start time.", "required": true, "type": "number" }, "time_end": { "description": "End time.", "required": true, "type": "number" }, "time_zone_id": { "description": "Time zone id.", "required": false, "type": "number" } }, "id": "RuleSchedule", "type": "object" }, "deleted": { "description": "When true the policy is marked deleted. Deleted policies are kept for historical reasons and can be retrieved using the API.", "required": false, "type": "string" }, "revision_id": { "description": "When the policy is edited, this id is incremented.", "required": false, "type": "number" }, "description": { "description": "Policy description.", "required": true, "type": "string" }, "name": { "description": "Policy name. Must be unique in the system.", "required": true, "type": "string" }, "type": { "description": "Policy type.", "required": true, "type": "string", "enum": [ "HOST", "INTERFACE", "RESPONSE_TIME" ] }, "threshold": { "description": "Object that includes threshold information (what metric to be tracked and how).", "required": true, "properties": { "metric": { "description": "Metric to be tracked.", "required": true, "type": "string", "enum": [ "BYTES", "PACKETS", "CONNS_NEW", "UTILIZATION", "SRV_DELAY", "RESP_RTT", "NET_RTT", "RETRANS_BYTES", "RETRANS_PACKETS", "RETRANS_BYTES_PCT", "RETRANS_PACKETS_PCT", "RESETS", "CONNS_ACTIVE", "CONNS_DURATION", "APP_THRUPUT_PERSECCONN", "MOS", "RFACTOR", "JITTER", "LOSS", "LOSS_PCT" ] }, "severity": { "description": "Threshold severity - the bigger the number the more serious the events would be considered (min 0, max 100, default 100).", "required": false, "type": "number" }, "scope": { "description": "Threshold scope: INDIVIDUAL: the threshold violates if any individual host violates; AVERAGE: the threshold violates if the average for the group violates (applies for response type policies only, default INDIVIDUAL).", "required": false, "type": "string", "enum": [ "INDIVIDUAL", "AVERAGE" ] }, "type": { "description": "Set to Below when the policy needs to trigger when the metric value goes below the threshold otherwise the policy triggers when the metric value goes above the threshold.", "required": true, "type": "string", "enum": [ "ABOVE", "BELOW" ] }, "direction": { "description": "Tracked direction.", "required": false, "type": "string", "enum": [ "A2B", "B2A", "EITHER_A2B_OR_B2A", "A2B_PLUS_B2A", "IN", "OUT", "IN_OR_OUT" ] }, "value": { "description": "Threshold value.", "required": true, "type": "string" }, "duration": { "description": "Number of consecutive minutes that metric must violate before an event is triggered (min 1, default 1).", "required": false, "type": "number" }, "rate": { "description": "Threshold rate (seconds, minutes, milliseconds).", "required": false, "type": "string", "enum": [ "PERMS", "PERSEC", "PERMIN" ] } }, "id": "RuleThreshold", "type": "object" } }, "id": "Rule", "type": "object" }, "id": "RuleList", "type": "array", "example": [ { "name": "HostPolicy1", "schedule": { "time_zone_id": 160, "time_zone_name": "America/New_York", "time_start": 0, "time_end": 86399, "days": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "deleted": false, "enabled": true, "alert_notification": { "low_alert_recipient": "Default", "high_alert_recipient": "Mark", "high_alert_recipient_id": 65, "medium_alert_recipient": "* Owner", "medium_alert_recipient_id": 2, "low_alert_recipient_id": 1 }, "threshold": { "direction": "EITHER_A2B_OR_B2A", "severity": 100, "metric": "BYTES", "value": 1, "rate": "PERSEC", "duration": 1, "type": "ABOVE" }, "revision_id": 12023, "type": "HOST", "id": 12024, "description": "Description text" } ] }, "authorization": "required" }, "Delete all policies": { "description": "Delete all user defined policies.", "httpmethod": "POST", "path": "user_defined_policies/clear", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Delete policy": { "description": "Delete a user defined policy. Note: policies are marked as deleted. A GET after delete will not return 404, it will return the policy with deleted flag se to true.", "httpmethod": "DELETE", "path": "user_defined_policies/{id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Update policy": { "description": "Update a user defined policy. Note: after update the policy id changes. The historty_id property will point to the old id.", "formats": [ "xml", "json" ], "request": { "description": "Object representing a User defined policy, includes traffic filters.", "properties": { "enabled": { "description": "When true the policy is enabled and it will be monitored by the system.", "required": true, "type": "string" }, "alert_notification": { "description": "Object that includes an alert notification information.", "required": true, "properties": { "low_alert_recipient": { "description": "Low recipient name.", "required": false, "type": "string" }, "medium_alert_recipient_id": { "description": "Medium recipient id.", "required": false, "type": "number" }, "high_alert_recipient_id": { "description": "High recipient id.", "required": false, "type": "number" }, "low_alert_recipient_id": { "description": "Low recipient id.", "required": false, "type": "number" }, "high_alert_recipient": { "description": "High recipient name.", "required": false, "type": "string" }, "medium_alert_recipient": { "description": "Medium recipient name.", "required": false, "type": "string" } }, "id": "RuleAlertNotification", "type": "object" }, "id": { "description": "Policy identifier.", "required": false, "type": "number" }, "schedule": { "description": "Object that includes policy schedule information (when to track and fire events).", "required": true, "properties": { "time_zone_name": { "description": "Time zone name.", "required": false, "type": "string" }, "days": { "description": "List of days.", "items": { "description": "Day of the week.", "required": false, "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "required": true, "id": "RuleScheduleDays", "type": "array" }, "time_start": { "description": "Start time.", "required": true, "type": "number" }, "time_end": { "description": "End time.", "required": true, "type": "number" }, "time_zone_id": { "description": "Time zone id.", "required": false, "type": "number" } }, "id": "RuleSchedule", "type": "object" }, "deleted": { "description": "When true the policy is marked deleted. Deleted policies are kept for historical reasons and can be retrieved using the API.", "required": false, "type": "string" }, "revision_id": { "description": "When the policy is edited, this id is incremented.", "required": false, "type": "number" }, "filters": { "description": "Object that includes all traffic filters.", "required": true, "properties": { "server_hosts_count": { "description": "Statistics: flag to indicate how to count the server hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "ports": { "description": "Object that includes all traffic port/protocol/port group filters.", "required": false, "properties": { "ports": { "description": "List of port objects (Protocol/port).", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "negated": { "description": "Boolean flag indication whether the ports/protocols/port groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of port group objects.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "protocols": { "description": "List of protocol objects.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" } }, "id": "CPortsInput", "type": "object" }, "client_hosts": { "description": "Object that includes all traffic client host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces_path": { "description": "Object that includes all traffic interface/device/interface group in network path filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "client_hosts_count": { "description": "Statistics: flag to indicate how to count the client hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "server_hosts": { "description": "Object that includes all traffic server host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces": { "description": "Object that includes all traffic interface/device/interface group filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "dscps": { "description": "Object that includes all traffic dscp filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the DSCPs should be included (false) or excluded (true).", "required": false, "type": "string" }, "dscps": { "description": "List of DSCP objects.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" } }, "id": "CDSCPsInput", "type": "object" }, "applications": { "description": "Object that includes all traffic application filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the applications should be included (false) or excluded (true).", "required": false, "type": "string" }, "applications": { "description": "List of application objects.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "CApplicationsInput", "type": "object" } }, "id": "RuleFilters", "type": "object" }, "description": { "description": "Policy description.", "required": true, "type": "string" }, "name": { "description": "Policy name. Must be unique in the system.", "required": true, "type": "string" }, "type": { "description": "Policy type.", "required": true, "type": "string", "enum": [ "HOST", "INTERFACE", "RESPONSE_TIME" ] }, "threshold": { "description": "Object that includes threshold information (what metric to be tracked and how).", "required": true, "properties": { "metric": { "description": "Metric to be tracked.", "required": true, "type": "string", "enum": [ "BYTES", "PACKETS", "CONNS_NEW", "UTILIZATION", "SRV_DELAY", "RESP_RTT", "NET_RTT", "RETRANS_BYTES", "RETRANS_PACKETS", "RETRANS_BYTES_PCT", "RETRANS_PACKETS_PCT", "RESETS", "CONNS_ACTIVE", "CONNS_DURATION", "APP_THRUPUT_PERSECCONN", "MOS", "RFACTOR", "JITTER", "LOSS", "LOSS_PCT" ] }, "severity": { "description": "Threshold severity - the bigger the number the more serious the events would be considered (min 0, max 100, default 100).", "required": false, "type": "number" }, "scope": { "description": "Threshold scope: INDIVIDUAL: the threshold violates if any individual host violates; AVERAGE: the threshold violates if the average for the group violates (applies for response type policies only, default INDIVIDUAL).", "required": false, "type": "string", "enum": [ "INDIVIDUAL", "AVERAGE" ] }, "type": { "description": "Set to Below when the policy needs to trigger when the metric value goes below the threshold otherwise the policy triggers when the metric value goes above the threshold.", "required": true, "type": "string", "enum": [ "ABOVE", "BELOW" ] }, "direction": { "description": "Tracked direction.", "required": false, "type": "string", "enum": [ "A2B", "B2A", "EITHER_A2B_OR_B2A", "A2B_PLUS_B2A", "IN", "OUT", "IN_OR_OUT" ] }, "value": { "description": "Threshold value.", "required": true, "type": "string" }, "duration": { "description": "Number of consecutive minutes that metric must violate before an event is triggered (min 1, default 1).", "required": false, "type": "number" }, "rate": { "description": "Threshold rate (seconds, minutes, milliseconds).", "required": false, "type": "string", "enum": [ "PERMS", "PERSEC", "PERMIN" ] } }, "id": "RuleThreshold", "type": "object" } }, "id": "RuleDetail", "type": "object", "example": { "name": "HostPolicy1", "schedule": { "time_zone_id": 160, "time_zone_name": "America/New_York", "time_start": 0, "time_end": 86399, "days": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "deleted": false, "description": "Description text", "enabled": true, "filters": { "server_hosts": { "negated": true, "role": "SERVER", "hosts": [ { "ipaddr": "10.0.0.1" } ] }, "dscps": { "dscps": [ { "code_point": 10, "name": "AF11" }, { "code_point": 14, "name": "AF13" } ], "negated": false }, "interfaces": { "negated": false, "interfaces": [ { "ifindex": 1, "direction": "INBOUND", "ipaddr": "10.99.11.252" } ], "devices": [ { "ipaddr": "10.38.8.71" } ], "groups": [ { "path": "/WAN", "group_id": 2 } ] }, "server_hosts_count": "PERHOST", "applications": { "negated": false, "applications": [ { "tunneled": false, "id": 617, "name": "Facebook" }, { "tunneled": false, "id": 603, "name": "WEB" } ] }, "interfaces_path": { "negated": true, "groups": [ { "path": "/WAN/Optimized", "group_id": 3 } ] }, "client_hosts_count": "AGGREGATE", "client_hosts": { "negated": false, "role": "CLIENT", "hosts": [ { "ipaddr": "100.0.0.2" }, { "ipaddr": "100.0.0.1" } ], "cidrs": [ "10.0.0.0/8" ], "host_groups": [ { "group_type_id": 102, "group_id": 5, "group_type_name": "ByLocation", "group_name": "Boston" }, { "group_type_id": 102, "group_id": 4, "group_type_name": "ByLocation", "group_name": "Dallas" } ] }, "ports": { "negated": false, "protocols": [ { "id": 6, "name": "tcp" } ], "ports": [ { "protocol": 17, "name": "udp/80", "port": 80 } ], "groups": [ { "group_id": 2, "name": "Email" } ] } }, "threshold": { "direction": "EITHER_A2B_OR_B2A", "severity": 100, "metric": "BYTES", "value": 1, "rate": "PERSEC", "duration": 1, "type": "ABOVE" }, "revision_id": 12023, "type": "HOST", "id": 12024, "alert_notification": { "low_alert_recipient": "Default", "high_alert_recipient": "Mark", "high_alert_recipient_id": 65, "medium_alert_recipient": "* Owner", "medium_alert_recipient_id": 2, "low_alert_recipient_id": 1 } } }, "httpmethod": "PUT", "path": "user_defined_policies/{id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a User defined policy, includes traffic filters.", "properties": { "enabled": { "description": "When true the policy is enabled and it will be monitored by the system.", "required": true, "type": "string" }, "alert_notification": { "description": "Object that includes an alert notification information.", "required": true, "properties": { "low_alert_recipient": { "description": "Low recipient name.", "required": false, "type": "string" }, "medium_alert_recipient_id": { "description": "Medium recipient id.", "required": false, "type": "number" }, "high_alert_recipient_id": { "description": "High recipient id.", "required": false, "type": "number" }, "low_alert_recipient_id": { "description": "Low recipient id.", "required": false, "type": "number" }, "high_alert_recipient": { "description": "High recipient name.", "required": false, "type": "string" }, "medium_alert_recipient": { "description": "Medium recipient name.", "required": false, "type": "string" } }, "id": "RuleAlertNotification", "type": "object" }, "id": { "description": "Policy identifier.", "required": false, "type": "number" }, "schedule": { "description": "Object that includes policy schedule information (when to track and fire events).", "required": true, "properties": { "time_zone_name": { "description": "Time zone name.", "required": false, "type": "string" }, "days": { "description": "List of days.", "items": { "description": "Day of the week.", "required": false, "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "required": true, "id": "RuleScheduleDays", "type": "array" }, "time_start": { "description": "Start time.", "required": true, "type": "number" }, "time_end": { "description": "End time.", "required": true, "type": "number" }, "time_zone_id": { "description": "Time zone id.", "required": false, "type": "number" } }, "id": "RuleSchedule", "type": "object" }, "deleted": { "description": "When true the policy is marked deleted. Deleted policies are kept for historical reasons and can be retrieved using the API.", "required": false, "type": "string" }, "revision_id": { "description": "When the policy is edited, this id is incremented.", "required": false, "type": "number" }, "filters": { "description": "Object that includes all traffic filters.", "required": true, "properties": { "server_hosts_count": { "description": "Statistics: flag to indicate how to count the server hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "ports": { "description": "Object that includes all traffic port/protocol/port group filters.", "required": false, "properties": { "ports": { "description": "List of port objects (Protocol/port).", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "negated": { "description": "Boolean flag indication whether the ports/protocols/port groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of port group objects.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "protocols": { "description": "List of protocol objects.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" } }, "id": "CPortsInput", "type": "object" }, "client_hosts": { "description": "Object that includes all traffic client host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces_path": { "description": "Object that includes all traffic interface/device/interface group in network path filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "client_hosts_count": { "description": "Statistics: flag to indicate how to count the client hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "server_hosts": { "description": "Object that includes all traffic server host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces": { "description": "Object that includes all traffic interface/device/interface group filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "dscps": { "description": "Object that includes all traffic dscp filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the DSCPs should be included (false) or excluded (true).", "required": false, "type": "string" }, "dscps": { "description": "List of DSCP objects.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" } }, "id": "CDSCPsInput", "type": "object" }, "applications": { "description": "Object that includes all traffic application filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the applications should be included (false) or excluded (true).", "required": false, "type": "string" }, "applications": { "description": "List of application objects.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "CApplicationsInput", "type": "object" } }, "id": "RuleFilters", "type": "object" }, "description": { "description": "Policy description.", "required": true, "type": "string" }, "name": { "description": "Policy name. Must be unique in the system.", "required": true, "type": "string" }, "type": { "description": "Policy type.", "required": true, "type": "string", "enum": [ "HOST", "INTERFACE", "RESPONSE_TIME" ] }, "threshold": { "description": "Object that includes threshold information (what metric to be tracked and how).", "required": true, "properties": { "metric": { "description": "Metric to be tracked.", "required": true, "type": "string", "enum": [ "BYTES", "PACKETS", "CONNS_NEW", "UTILIZATION", "SRV_DELAY", "RESP_RTT", "NET_RTT", "RETRANS_BYTES", "RETRANS_PACKETS", "RETRANS_BYTES_PCT", "RETRANS_PACKETS_PCT", "RESETS", "CONNS_ACTIVE", "CONNS_DURATION", "APP_THRUPUT_PERSECCONN", "MOS", "RFACTOR", "JITTER", "LOSS", "LOSS_PCT" ] }, "severity": { "description": "Threshold severity - the bigger the number the more serious the events would be considered (min 0, max 100, default 100).", "required": false, "type": "number" }, "scope": { "description": "Threshold scope: INDIVIDUAL: the threshold violates if any individual host violates; AVERAGE: the threshold violates if the average for the group violates (applies for response type policies only, default INDIVIDUAL).", "required": false, "type": "string", "enum": [ "INDIVIDUAL", "AVERAGE" ] }, "type": { "description": "Set to Below when the policy needs to trigger when the metric value goes below the threshold otherwise the policy triggers when the metric value goes above the threshold.", "required": true, "type": "string", "enum": [ "ABOVE", "BELOW" ] }, "direction": { "description": "Tracked direction.", "required": false, "type": "string", "enum": [ "A2B", "B2A", "EITHER_A2B_OR_B2A", "A2B_PLUS_B2A", "IN", "OUT", "IN_OR_OUT" ] }, "value": { "description": "Threshold value.", "required": true, "type": "string" }, "duration": { "description": "Number of consecutive minutes that metric must violate before an event is triggered (min 1, default 1).", "required": false, "type": "number" }, "rate": { "description": "Threshold rate (seconds, minutes, milliseconds).", "required": false, "type": "string", "enum": [ "PERMS", "PERSEC", "PERMIN" ] } }, "id": "RuleThreshold", "type": "object" } }, "id": "RuleDetail", "type": "object", "example": { "name": "HostPolicy1", "schedule": { "time_zone_id": 160, "time_zone_name": "America/New_York", "time_start": 0, "time_end": 86399, "days": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "deleted": false, "description": "Description text", "enabled": true, "filters": { "server_hosts": { "negated": true, "role": "SERVER", "hosts": [ { "ipaddr": "10.0.0.1" } ] }, "dscps": { "dscps": [ { "code_point": 10, "name": "AF11" }, { "code_point": 14, "name": "AF13" } ], "negated": false }, "interfaces": { "negated": false, "interfaces": [ { "ifindex": 1, "direction": "INBOUND", "ipaddr": "10.99.11.252" } ], "devices": [ { "ipaddr": "10.38.8.71" } ], "groups": [ { "path": "/WAN", "group_id": 2 } ] }, "server_hosts_count": "PERHOST", "applications": { "negated": false, "applications": [ { "tunneled": false, "id": 617, "name": "Facebook" }, { "tunneled": false, "id": 603, "name": "WEB" } ] }, "interfaces_path": { "negated": true, "groups": [ { "path": "/WAN/Optimized", "group_id": 3 } ] }, "client_hosts_count": "AGGREGATE", "client_hosts": { "negated": false, "role": "CLIENT", "hosts": [ { "ipaddr": "100.0.0.2" }, { "ipaddr": "100.0.0.1" } ], "cidrs": [ "10.0.0.0/8" ], "host_groups": [ { "group_type_id": 102, "group_id": 5, "group_type_name": "ByLocation", "group_name": "Boston" }, { "group_type_id": 102, "group_id": 4, "group_type_name": "ByLocation", "group_name": "Dallas" } ] }, "ports": { "negated": false, "protocols": [ { "id": 6, "name": "tcp" } ], "ports": [ { "protocol": 17, "name": "udp/80", "port": 80 } ], "groups": [ { "group_id": 2, "name": "Email" } ] } }, "threshold": { "direction": "EITHER_A2B_OR_B2A", "severity": 100, "metric": "BYTES", "value": 1, "rate": "PERSEC", "duration": 1, "type": "ABOVE" }, "revision_id": 12023, "type": "HOST", "id": 12024, "alert_notification": { "low_alert_recipient": "Default", "high_alert_recipient": "Mark", "high_alert_recipient_id": 65, "medium_alert_recipient": "* Owner", "medium_alert_recipient_id": 2, "low_alert_recipient_id": 1 } } }, "authorization": "required" }, "List of policy revisions": { "description": "Get a list of user defined policy revisions. When a policies is modified or deleted it stays in the system for historical reasons. This resources allows getting older policy revisions.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting row number." }, "id": { "required": false, "type": "string", "description": "Filter to revision from this policy." }, "sortby": { "required": false, "type": "string", "description": "Sort by one of the following options: name (default), enabled, severity, type." }, "sort": { "required": false, "type": "string", "description": "Sort order: asc (default) or desc." }, "name": { "required": false, "type": "string", "description": "Filter to list to one policy with this name." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "user_defined_policies/revisions", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of User defined policy objects.", "items": { "description": "User defined policy object.", "required": false, "properties": { "enabled": { "description": "When true the policy is enabled and it will be monitored by the system.", "required": true, "type": "string" }, "alert_notification": { "description": "Object that includes an alert notification information.", "required": true, "properties": { "low_alert_recipient": { "description": "Low recipient name.", "required": false, "type": "string" }, "medium_alert_recipient_id": { "description": "Medium recipient id.", "required": false, "type": "number" }, "high_alert_recipient_id": { "description": "High recipient id.", "required": false, "type": "number" }, "low_alert_recipient_id": { "description": "Low recipient id.", "required": false, "type": "number" }, "high_alert_recipient": { "description": "High recipient name.", "required": false, "type": "string" }, "medium_alert_recipient": { "description": "Medium recipient name.", "required": false, "type": "string" } }, "id": "RuleAlertNotification", "type": "object" }, "id": { "description": "Policy identifier.", "required": false, "type": "number" }, "schedule": { "description": "Object that includes policy schedule information (when to track and fire events).", "required": true, "properties": { "time_zone_name": { "description": "Time zone name.", "required": false, "type": "string" }, "days": { "description": "List of days.", "items": { "description": "Day of the week.", "required": false, "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "required": true, "id": "RuleScheduleDays", "type": "array" }, "time_start": { "description": "Start time.", "required": true, "type": "number" }, "time_end": { "description": "End time.", "required": true, "type": "number" }, "time_zone_id": { "description": "Time zone id.", "required": false, "type": "number" } }, "id": "RuleSchedule", "type": "object" }, "deleted": { "description": "When true the policy is marked deleted. Deleted policies are kept for historical reasons and can be retrieved using the API.", "required": false, "type": "string" }, "revision_id": { "description": "When the policy is edited, this id is incremented.", "required": false, "type": "number" }, "description": { "description": "Policy description.", "required": true, "type": "string" }, "name": { "description": "Policy name. Must be unique in the system.", "required": true, "type": "string" }, "type": { "description": "Policy type.", "required": true, "type": "string", "enum": [ "HOST", "INTERFACE", "RESPONSE_TIME" ] }, "threshold": { "description": "Object that includes threshold information (what metric to be tracked and how).", "required": true, "properties": { "metric": { "description": "Metric to be tracked.", "required": true, "type": "string", "enum": [ "BYTES", "PACKETS", "CONNS_NEW", "UTILIZATION", "SRV_DELAY", "RESP_RTT", "NET_RTT", "RETRANS_BYTES", "RETRANS_PACKETS", "RETRANS_BYTES_PCT", "RETRANS_PACKETS_PCT", "RESETS", "CONNS_ACTIVE", "CONNS_DURATION", "APP_THRUPUT_PERSECCONN", "MOS", "RFACTOR", "JITTER", "LOSS", "LOSS_PCT" ] }, "severity": { "description": "Threshold severity - the bigger the number the more serious the events would be considered (min 0, max 100, default 100).", "required": false, "type": "number" }, "scope": { "description": "Threshold scope: INDIVIDUAL: the threshold violates if any individual host violates; AVERAGE: the threshold violates if the average for the group violates (applies for response type policies only, default INDIVIDUAL).", "required": false, "type": "string", "enum": [ "INDIVIDUAL", "AVERAGE" ] }, "type": { "description": "Set to Below when the policy needs to trigger when the metric value goes below the threshold otherwise the policy triggers when the metric value goes above the threshold.", "required": true, "type": "string", "enum": [ "ABOVE", "BELOW" ] }, "direction": { "description": "Tracked direction.", "required": false, "type": "string", "enum": [ "A2B", "B2A", "EITHER_A2B_OR_B2A", "A2B_PLUS_B2A", "IN", "OUT", "IN_OR_OUT" ] }, "value": { "description": "Threshold value.", "required": true, "type": "string" }, "duration": { "description": "Number of consecutive minutes that metric must violate before an event is triggered (min 1, default 1).", "required": false, "type": "number" }, "rate": { "description": "Threshold rate (seconds, minutes, milliseconds).", "required": false, "type": "string", "enum": [ "PERMS", "PERSEC", "PERMIN" ] } }, "id": "RuleThreshold", "type": "object" } }, "id": "Rule", "type": "object" }, "id": "RuleList", "type": "array", "example": [ { "name": "HostPolicy1", "schedule": { "time_zone_id": 160, "time_zone_name": "America/New_York", "time_start": 0, "time_end": 86399, "days": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "deleted": false, "enabled": true, "alert_notification": { "low_alert_recipient": "Default", "high_alert_recipient": "Mark", "high_alert_recipient_id": 65, "medium_alert_recipient": "* Owner", "medium_alert_recipient_id": 2, "low_alert_recipient_id": 1 }, "threshold": { "direction": "EITHER_A2B_OR_B2A", "severity": 100, "metric": "BYTES", "value": 1, "rate": "PERSEC", "duration": 1, "type": "ABOVE" }, "revision_id": 12023, "type": "HOST", "id": 12024, "description": "Description text" } ] }, "authorization": "required" }, "Get policy revision": { "description": "Get a user defined policy revision.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "user_defined_policies/revisions/{revision_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a User defined policy, includes traffic filters.", "properties": { "enabled": { "description": "When true the policy is enabled and it will be monitored by the system.", "required": true, "type": "string" }, "alert_notification": { "description": "Object that includes an alert notification information.", "required": true, "properties": { "low_alert_recipient": { "description": "Low recipient name.", "required": false, "type": "string" }, "medium_alert_recipient_id": { "description": "Medium recipient id.", "required": false, "type": "number" }, "high_alert_recipient_id": { "description": "High recipient id.", "required": false, "type": "number" }, "low_alert_recipient_id": { "description": "Low recipient id.", "required": false, "type": "number" }, "high_alert_recipient": { "description": "High recipient name.", "required": false, "type": "string" }, "medium_alert_recipient": { "description": "Medium recipient name.", "required": false, "type": "string" } }, "id": "RuleAlertNotification", "type": "object" }, "id": { "description": "Policy identifier.", "required": false, "type": "number" }, "schedule": { "description": "Object that includes policy schedule information (when to track and fire events).", "required": true, "properties": { "time_zone_name": { "description": "Time zone name.", "required": false, "type": "string" }, "days": { "description": "List of days.", "items": { "description": "Day of the week.", "required": false, "type": "string", "enum": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "required": true, "id": "RuleScheduleDays", "type": "array" }, "time_start": { "description": "Start time.", "required": true, "type": "number" }, "time_end": { "description": "End time.", "required": true, "type": "number" }, "time_zone_id": { "description": "Time zone id.", "required": false, "type": "number" } }, "id": "RuleSchedule", "type": "object" }, "deleted": { "description": "When true the policy is marked deleted. Deleted policies are kept for historical reasons and can be retrieved using the API.", "required": false, "type": "string" }, "revision_id": { "description": "When the policy is edited, this id is incremented.", "required": false, "type": "number" }, "filters": { "description": "Object that includes all traffic filters.", "required": true, "properties": { "server_hosts_count": { "description": "Statistics: flag to indicate how to count the server hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "ports": { "description": "Object that includes all traffic port/protocol/port group filters.", "required": false, "properties": { "ports": { "description": "List of port objects (Protocol/port).", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "negated": { "description": "Boolean flag indication whether the ports/protocols/port groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of port group objects.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "protocols": { "description": "List of protocol objects.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" } }, "id": "CPortsInput", "type": "object" }, "client_hosts": { "description": "Object that includes all traffic client host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces_path": { "description": "Object that includes all traffic interface/device/interface group in network path filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "client_hosts_count": { "description": "Statistics: flag to indicate how to count the client hosts ('per host' or 'in aggregate').", "required": false, "type": "string", "enum": [ "AGGREGATE", "PERHOST" ] }, "server_hosts": { "description": "Object that includes all traffic server host/cidr/host group filters.", "required": false, "properties": { "role": { "description": "flag indicating if the hosts/cidrs/groups should be treated as client or server or both.", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "negated": { "description": "Boolean flag indication whether the hosts/cidrs/groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "hosts": { "description": "List of Hosts objects.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "cidrs": { "description": "List of CIDR objects.", "items": { "description": "CIDR object.", "required": false, "type": "string" }, "required": false, "id": "CCIDRs", "type": "array" }, "host_groups": { "description": "List of Host Groups objects.", "items": { "description": "Object representing host group type and host group.", "required": false, "properties": { "group_type_id": { "description": "Host Group type id.", "required": false, "type": "number" }, "group_name": { "description": "Host Group name.", "required": false, "type": "string" }, "group_id": { "description": "Host Group id.", "required": false, "type": "number" }, "group_type_name": { "description": "Host Group type name.", "required": false, "type": "string" } }, "id": "CFullHostGroup", "type": "object" }, "required": false, "id": "CFullHostGroups", "type": "array" } }, "id": "CHostsInput", "type": "object" }, "interfaces": { "description": "Object that includes all traffic interface/device/interface group filters.", "required": false, "properties": { "devices": { "description": "List of Device objects.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "negated": { "description": "flag indicating if the interfaces/devices/interface groups should be included (false) or excluded (true).", "required": false, "type": "string" }, "groups": { "description": "List of interface groups objects.", "items": { "description": "Interface group object.", "required": false, "properties": { "path": { "description": "Full interface group path, e.g. /MyViews/Boston/Cambridge/subgroup1.", "required": false, "type": "string" }, "group_id": { "description": "Interface group id.", "required": false, "type": "number" } }, "id": "CInterfaceGroup", "type": "object" }, "required": false, "id": "CInterfaceGroups", "type": "array" }, "interfaces": { "description": "List of interface objects.", "items": { "description": "Interface object.", "required": false, "properties": { "ipaddr": { "description": "IP Address of the interface.", "required": false, "type": "string" }, "name": { "description": "Name of the interface, DNS and interface label can be used, e.g. myinterface:port1.", "required": false, "type": "string" }, "direction": { "description": "Direction of the interface.", "required": false, "type": "string", "enum": [ "INBOUND", "OUTBOUND", "BOTH" ] }, "ifindex": { "description": "Ifindex.", "required": false, "type": "number" } }, "id": "CInterfaceDirection", "type": "object" }, "required": false, "id": "CInterfacesDirection", "type": "array" } }, "id": "CInterfacesInput", "type": "object" }, "dscps": { "description": "Object that includes all traffic dscp filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the DSCPs should be included (false) or excluded (true).", "required": false, "type": "string" }, "dscps": { "description": "List of DSCP objects.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" } }, "id": "CDSCPsInput", "type": "object" }, "applications": { "description": "Object that includes all traffic application filters.", "required": false, "properties": { "negated": { "description": "Boolean flag indication whether the applications should be included (false) or excluded (true).", "required": false, "type": "string" }, "applications": { "description": "List of application objects.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "CApplicationsInput", "type": "object" } }, "id": "RuleFilters", "type": "object" }, "description": { "description": "Policy description.", "required": true, "type": "string" }, "name": { "description": "Policy name. Must be unique in the system.", "required": true, "type": "string" }, "type": { "description": "Policy type.", "required": true, "type": "string", "enum": [ "HOST", "INTERFACE", "RESPONSE_TIME" ] }, "threshold": { "description": "Object that includes threshold information (what metric to be tracked and how).", "required": true, "properties": { "metric": { "description": "Metric to be tracked.", "required": true, "type": "string", "enum": [ "BYTES", "PACKETS", "CONNS_NEW", "UTILIZATION", "SRV_DELAY", "RESP_RTT", "NET_RTT", "RETRANS_BYTES", "RETRANS_PACKETS", "RETRANS_BYTES_PCT", "RETRANS_PACKETS_PCT", "RESETS", "CONNS_ACTIVE", "CONNS_DURATION", "APP_THRUPUT_PERSECCONN", "MOS", "RFACTOR", "JITTER", "LOSS", "LOSS_PCT" ] }, "severity": { "description": "Threshold severity - the bigger the number the more serious the events would be considered (min 0, max 100, default 100).", "required": false, "type": "number" }, "scope": { "description": "Threshold scope: INDIVIDUAL: the threshold violates if any individual host violates; AVERAGE: the threshold violates if the average for the group violates (applies for response type policies only, default INDIVIDUAL).", "required": false, "type": "string", "enum": [ "INDIVIDUAL", "AVERAGE" ] }, "type": { "description": "Set to Below when the policy needs to trigger when the metric value goes below the threshold otherwise the policy triggers when the metric value goes above the threshold.", "required": true, "type": "string", "enum": [ "ABOVE", "BELOW" ] }, "direction": { "description": "Tracked direction.", "required": false, "type": "string", "enum": [ "A2B", "B2A", "EITHER_A2B_OR_B2A", "A2B_PLUS_B2A", "IN", "OUT", "IN_OR_OUT" ] }, "value": { "description": "Threshold value.", "required": true, "type": "string" }, "duration": { "description": "Number of consecutive minutes that metric must violate before an event is triggered (min 1, default 1).", "required": false, "type": "number" }, "rate": { "description": "Threshold rate (seconds, minutes, milliseconds).", "required": false, "type": "string", "enum": [ "PERMS", "PERSEC", "PERMIN" ] } }, "id": "RuleThreshold", "type": "object" } }, "id": "RuleDetail", "type": "object", "example": { "name": "HostPolicy1", "schedule": { "time_zone_id": 160, "time_zone_name": "America/New_York", "time_start": 0, "time_end": 86399, "days": [ "SUNDAY", "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY" ] }, "deleted": false, "description": "Description text", "enabled": true, "filters": { "server_hosts": { "negated": true, "role": "SERVER", "hosts": [ { "ipaddr": "10.0.0.1" } ] }, "dscps": { "dscps": [ { "code_point": 10, "name": "AF11" }, { "code_point": 14, "name": "AF13" } ], "negated": false }, "interfaces": { "negated": false, "interfaces": [ { "ifindex": 1, "direction": "INBOUND", "ipaddr": "10.99.11.252" } ], "devices": [ { "ipaddr": "10.38.8.71" } ], "groups": [ { "path": "/WAN", "group_id": 2 } ] }, "server_hosts_count": "PERHOST", "applications": { "negated": false, "applications": [ { "tunneled": false, "id": 617, "name": "Facebook" }, { "tunneled": false, "id": 603, "name": "WEB" } ] }, "interfaces_path": { "negated": true, "groups": [ { "path": "/WAN/Optimized", "group_id": 3 } ] }, "client_hosts_count": "AGGREGATE", "client_hosts": { "negated": false, "role": "CLIENT", "hosts": [ { "ipaddr": "100.0.0.2" }, { "ipaddr": "100.0.0.1" } ], "cidrs": [ "10.0.0.0/8" ], "host_groups": [ { "group_type_id": 102, "group_id": 5, "group_type_name": "ByLocation", "group_name": "Boston" }, { "group_type_id": 102, "group_id": 4, "group_type_name": "ByLocation", "group_name": "Dallas" } ] }, "ports": { "negated": false, "protocols": [ { "id": 6, "name": "tcp" } ], "ports": [ { "protocol": 17, "name": "udp/80", "port": 80 } ], "groups": [ { "group_id": 2, "name": "Email" } ] } }, "threshold": { "direction": "EITHER_A2B_OR_B2A", "severity": 100, "metric": "BYTES", "value": 1, "rate": "PERSEC", "duration": 1, "type": "ABOVE" }, "revision_id": 12023, "type": "HOST", "id": 12024, "alert_notification": { "low_alert_recipient": "Default", "high_alert_recipient": "Mark", "high_alert_recipient_id": 65, "medium_alert_recipient": "* Owner", "medium_alert_recipient_id": 2, "low_alert_recipient_id": 1 } } }, "authorization": "required" }, "Disable policy": { "description": "Disable a user defined policy.", "httpmethod": "POST", "path": "user_defined_policies/{id}/disable", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" } } }, "Reporting": { "methods": { "List reports": { "description": "Get a list of reports with their respective status.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/reports", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of report objects.", "items": { "description": "Object representing report information.", "required": false, "properties": { "run_time": { "description": "Time when the report was run (Unix time).", "required": true, "type": "number" }, "error_text": { "description": "A report can be completed with an error. Error message may provide more detailed info.", "required": false, "type": "string" }, "remaining_seconds": { "description": "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.", "required": true, "type": "number" }, "saved": { "description": "Boolean flag indicating if the report was saved.", "required": true, "type": "string" }, "id": { "description": "ID of the report. To be used in the API.", "required": true, "type": "number" }, "status": { "description": "Status of the report.", "required": true, "type": "string", "enum": [ "completed", "running", "waiting" ] }, "percent": { "description": "Progress of the report represented by percentage of report completion.", "required": true, "type": "number" }, "user_id": { "description": "ID of the user who owns the report.", "required": true, "type": "number" }, "size": { "description": "Size of the report in kilobytes.", "required": true, "type": "number" }, "name": { "description": "Name of the report. Could be given by a user or automatically generated by the system.", "required": false, "type": "string" }, "template_id": { "description": "ID of the template that the report is based on.", "required": true, "type": "number" } }, "id": "ReportInfo", "type": "object" }, "id": "ReportInfoList", "type": "array", "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 } ] }, "authorization": "required" }, "Get widget": { "description": "Get one widget from the template section.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/{template_id}/sections/{section_id}/widgets/{widget_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Widget specification.", "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object", "example": { "title": "VoIP-RTP: Applications", "timestamp": "1383141976.674383", "criteria": { "sort_column": 33, "traffic_expression": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 } }, "authorization": "required" }, "Get factory widget": { "description": "Get configuration of a stock widget.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/widgets/{widget_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Widget specification.", "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object", "example": { "title": "VoIP-RTP: Applications", "timestamp": "1383141976.674383", "criteria": { "sort_column": 33, "traffic_expression": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 } }, "authorization": "required" }, "List directions": { "description": "Get a list of directions that this version of the API supports.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/directions", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of directions.", "items": { "description": "Object representing a direction.", "required": false, "properties": { "id": { "description": "ID of a direction. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a direction.", "required": true, "type": "string" } }, "id": "Direction", "type": "object" }, "id": "Directions", "type": "array", "example": [ { "id": "inn", "name": "in" }, { "id": "out", "name": "out" }, { "id": "c2s", "name": "client to server" }, { "id": "s2c", "name": "server to client" } ] }, "authorization": "required" }, "Update template": { "description": "Update reporting template.", "formats": [ "xml", "json" ], "request": { "description": "Reporting template specification object.", "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within the template.", "required": false, "type": "string" }, "id": { "description": "ID of the report template.", "required": false, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "auto_disabled_on": { "description": "Timestamp when the template was auto-disabled due to idle usage.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "layout": { "description": "Layout information.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" }, "description": { "description": "Human-readable description of the template.", "required": false, "type": "string" }, "user_id": { "description": "User ID of the template owner.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "last_added_section_id": { "description": "ID of the last layout section added to the template.", "required": false, "type": "number" }, "wizard": { "description": "Template wizard properties.", "required": false, "properties": { "interface": { "description": "Watched interface for type WATCHED_IFACE type dashboards.", "required": false, "type": "string" }, "type": { "description": "Dashboard template type.", "required": true, "type": "string", "enum": [ "WATCHED_IFACE", "APP_PERFORMANCE", "SSO", "NET_OPERATIONS", "SERVICE", "OVERALL_WAN", "VOIP_CALL", "DEFAULT" ] } }, "id": "DashboardTemplateWizard", "type": "object" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "last_added_widget_id": { "description": "ID of the last widget added to the template.", "required": false, "type": "number" }, "version": { "description": "Version of the specification.", "required": false, "type": "string" }, "disabled": { "description": "Flag indicating that the template is disabled.", "required": false, "type": "string" }, "timestamp": { "description": "Report time stamp (unix time).", "required": false, "type": "string" }, "sections": { "description": "List of layout sections.", "items": { "description": "One TMSection object.", "required": false, "properties": { "widgets": { "description": "List of widgets that belong to the section.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "required": false, "id": "TMWidgets", "type": "array" }, "section_id": { "description": "Section ID.", "required": true, "type": "number" }, "layout": { "description": "Internal section layout.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" } }, "id": "TMSection", "type": "object" }, "required": false, "id": "TMSections", "type": "array" }, "img": { "description": "Images associaled with the template.", "required": false, "properties": { "thumbnail": { "description": "A thumbnail-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" }, "full": { "description": "A full-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" } }, "id": "ReportTemplateImg", "type": "object" } }, "id": "ReportTemplateSpec", "type": "object", "example": { "live": true, "layout": [ { "flow_items": [ { "id": 1 } ] } ], "name": "VOIP - Call Quality and Usage", "user_id": 1, "timestamp": "1383141976.674345", "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": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 }, { "title": "VoIP-RTP: Traffic Quality", "timestamp": "1383141976.674428", "criteria": { "traffic_expression": "", "columns": [ 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "line_scale": "LINEAR", "format_bytes": "UI_PREF", "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": "", "columns": [ 781 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 766 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 33 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_day", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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", "limit": 100, "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "height": 400, "edge_thickness": true, "pan_zoomable": true, "n_items": 10, "layout": "HORIZONTAL_TREE", "moveable_nodes": true, "show_images": true, "format_bytes": "UI_PREF" }, "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": "" } }, "httpmethod": "PUT", "path": "reporting/templates/{template_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Reporting template specification object.", "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within the template.", "required": false, "type": "string" }, "id": { "description": "ID of the report template.", "required": false, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "auto_disabled_on": { "description": "Timestamp when the template was auto-disabled due to idle usage.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "layout": { "description": "Layout information.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" }, "description": { "description": "Human-readable description of the template.", "required": false, "type": "string" }, "user_id": { "description": "User ID of the template owner.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "last_added_section_id": { "description": "ID of the last layout section added to the template.", "required": false, "type": "number" }, "wizard": { "description": "Template wizard properties.", "required": false, "properties": { "interface": { "description": "Watched interface for type WATCHED_IFACE type dashboards.", "required": false, "type": "string" }, "type": { "description": "Dashboard template type.", "required": true, "type": "string", "enum": [ "WATCHED_IFACE", "APP_PERFORMANCE", "SSO", "NET_OPERATIONS", "SERVICE", "OVERALL_WAN", "VOIP_CALL", "DEFAULT" ] } }, "id": "DashboardTemplateWizard", "type": "object" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "last_added_widget_id": { "description": "ID of the last widget added to the template.", "required": false, "type": "number" }, "version": { "description": "Version of the specification.", "required": false, "type": "string" }, "disabled": { "description": "Flag indicating that the template is disabled.", "required": false, "type": "string" }, "timestamp": { "description": "Report time stamp (unix time).", "required": false, "type": "string" }, "sections": { "description": "List of layout sections.", "items": { "description": "One TMSection object.", "required": false, "properties": { "widgets": { "description": "List of widgets that belong to the section.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "required": false, "id": "TMWidgets", "type": "array" }, "section_id": { "description": "Section ID.", "required": true, "type": "number" }, "layout": { "description": "Internal section layout.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" } }, "id": "TMSection", "type": "object" }, "required": false, "id": "TMSections", "type": "array" }, "img": { "description": "Images associaled with the template.", "required": false, "properties": { "thumbnail": { "description": "A thumbnail-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" }, "full": { "description": "A full-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" } }, "id": "ReportTemplateImg", "type": "object" } }, "id": "ReportTemplateSpec", "type": "object", "example": { "live": true, "layout": [ { "flow_items": [ { "id": 1 } ] } ], "name": "VOIP - Call Quality and Usage", "user_id": 1, "timestamp": "1383141976.674345", "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": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 }, { "title": "VoIP-RTP: Traffic Quality", "timestamp": "1383141976.674428", "criteria": { "traffic_expression": "", "columns": [ 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "line_scale": "LINEAR", "format_bytes": "UI_PREF", "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": "", "columns": [ 781 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 766 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 33 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_day", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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", "limit": 100, "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "height": 400, "edge_thickness": true, "pan_zoomable": true, "n_items": 10, "layout": "HORIZONTAL_TREE", "moveable_nodes": true, "show_images": true, "format_bytes": "UI_PREF" }, "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": "" } }, "authorization": "required" }, "List categories": { "description": "Get a list of categories that this version of the API supports.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/categories", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of categories.", "items": { "description": "Object representing a category.", "required": false, "properties": { "id": { "description": "ID of a category. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a category.", "required": true, "type": "string" } }, "id": "Category", "type": "object" }, "id": "Categories", "type": "array", "example": [ { "id": "idx", "name": "index" }, { "id": "key", "name": "key" } ] }, "authorization": "required" }, "Create a report containing current dashboard data": { "description": "Create a report containing current dashboard data.", "httpmethod": "POST", "path": "reporting/templates/{template_id}/livedata", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get user attributes": { "description": "Get user-specific template attributes.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/{template_id}/sections/{section_id}/widgets/{widget_id}/user_attributes", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Set of widget attributes.", "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object", "example": [] }, "authorization": "required" }, "List statictics": { "description": "Get a list of statistics that this version of the API supports.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/statistics", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of statistics.", "items": { "description": "Object representing a statistic.", "required": false, "properties": { "id": { "description": "ID of a statistic. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a statistic.", "required": true, "type": "string" } }, "id": "Statistic", "type": "object" }, "id": "Statistics", "type": "array", "example": [ { "id": "tot", "name": "total" }, { "id": "avg", "name": "average" }, { "id": "pek", "name": "peak" }, { "id": "min", "name": "min" } ] }, "authorization": "required" }, "Create report synchronously": { "description": "Generate a new report and get data in one operation.", "formats": [ "xml", "json" ], "request": { "description": "ReportInputs object.", "properties": { "criteria": { "description": "Criteria neeed to run the report.", "required": false, "properties": { "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "time_frame": { "description": "Time frame object.", "required": false, "properties": { "time_interval": { "description": "Time interval pipe-separated string (example: 'last|1|hour').", "required": false, "type": "string" }, "resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month. If not specified a resolution will automatically be selected based on time frame of the report.", "required": false, "type": "string" }, "end": { "description": "Report end time (unix time).", "required": false, "type": "number" }, "expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "start": { "description": "Report start time (unix time).", "required": false, "type": "number" }, "time_zone": { "description": "Time zone name.", "required": false, "type": "string" } }, "id": "ReportTimeFrame", "type": "object" }, "query": { "description": "Query object.", "required": false, "properties": { "ports": { "description": "Query ports. Can be one of GET /reporting/ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Query dscp_app_ports. Can be one of GET /reporting/dscp_app_ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "port_groups": { "description": "Query port_groups. Can be one of GET /reporting/port_groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "cbqos_classes": { "description": "Query CBQoS classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Query autonomous system scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Query host_group_pairs. Can be one of GET /reporting/host_group_pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "Query WAN group. Can be any Interface Group under /WAN.", "required": false, "type": "string" }, "traffic_expression": { "description": "Query-specific traffic expression.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Query include non-optimized. Include non-optimized sites in a WAN query.", "required": false, "type": "string" }, "columns": { "description": "Query columns. Can be many of GET /reporting/columns.", "items": { "description": "Query column.", "required": false, "type": "number" }, "required": false, "id": "ReportQueryFilterColumns", "type": "array" }, "sort_direction": { "description": "Query sort direction. Can be one of ASC, DESC. ASC will return bottom talkers. DESC will return top talkers (default).", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] }, "bgpas_pairs": { "description": "Query autonomous system pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Query application_servers. Can be one of GET /reporting/application_servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Query devices. Can be one of GET /reporting/devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Query application_ports. Can be one of GET /reporting/application_ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "bgpas_host_groups": { "description": "Query autonomous system and host group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Query host_pair_ports. Can be one of GET /reporting/host_pair_ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Query dscp_interfaces. Can be one of GET /reporting/dscp_interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Query autonomous system.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "role": { "description": "Query role. Can be one of /reporting/roles.", "required": false, "type": "string" }, "show_ttl": { "description": "Query show TTL. Only applicable to flow list report format.", "required": false, "type": "string" }, "group_by": { "description": "Query group_by. Can be one of GET /reporting/group_bys.", "required": false, "type": "string" }, "case_insensitive": { "description": "Query user case insensitivity. Whether to search for users in a case-insensitive fashion.", "required": false, "type": "string" }, "switch_name": { "description": "Query switch name. Can be an IP address or a name.", "required": false, "type": "string" }, "macs": { "description": "Query MAC addresses. Host MAC addresses, only apply to switch_port requests.", "required": false, "type": "string" }, "host_group_type": { "description": "Query host group type. Required for \"host group (gro)\" \"host group pairs (gpp)\" and \"host group pairs with ports (gpr)\" queries.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Query host_pair_app_ports. Can be one of GET /reporting/host_pair_app_ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "direction": { "description": "Query direction. Can be one of GET /reporting/directions.", "required": false, "type": "string" }, "users": { "description": "Query time host users. Can be one of GET /reporting/time host user.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "switch_ports": { "description": "Query switch ports. Switch port addresses.", "required": false, "type": "string" }, "sort_column": { "description": "Query sort column. Can be one of GET /reporting/columns.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Query host_group_pair_ports. Can be one of GET /reporting/host_group_pair_ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Query network_segments. Can be one of GET /reporting/network_segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "macless_ports": { "description": "Query macless ports. Include switch ports without a MAC address.", "required": false, "type": "string" }, "hosts": { "description": "Query hosts. Can be one of GET /reporting/hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "ignore_dhcp": { "description": "Query ignore DHCP. Use only switch port polling for ARP Bindings.", "required": false, "type": "string" }, "host_pairs": { "description": "Query host pairs. Can be one of GET /reporting/host_pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "area": { "description": "Query area. Can be one of GET /reporting/areas.", "required": false, "type": "string" }, "protocols": { "description": "Query protocols. Can be one of GET /reporting/protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Query centricity. Can be one of GET /reporting/centricities.", "required": false, "type": "string" }, "limit": { "description": "Query data limit. Maximum number of rows to be returned. Default value: 10000.", "required": false, "type": "number" }, "interfaces": { "description": "Query interfaces. Can be one of GET /reporting/interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Query host_groups. Can be one of GET /reporting/host_groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "realm": { "description": "Query realm. Can be one of GET /reporting/realms.", "required": true, "type": "string" }, "dscps": { "description": "Query dscps. Can be one of GET /reporting/dscps.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Query applications. Can be one of GET /reporting/applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "ReportQueryFilter", "type": "object" }, "queries": { "description": "Array of Query objects.", "items": { "description": "Report Query.", "required": false, "properties": { "ports": { "description": "Query ports. Can be one of GET /reporting/ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Query dscp_app_ports. Can be one of GET /reporting/dscp_app_ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "port_groups": { "description": "Query port_groups. Can be one of GET /reporting/port_groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "cbqos_classes": { "description": "Query CBQoS classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Query autonomous system scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Query host_group_pairs. Can be one of GET /reporting/host_group_pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "Query WAN group. Can be any Interface Group under /WAN.", "required": false, "type": "string" }, "traffic_expression": { "description": "Query-specific traffic expression.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Query include non-optimized. Include non-optimized sites in a WAN query.", "required": false, "type": "string" }, "columns": { "description": "Query columns. Can be many of GET /reporting/columns.", "items": { "description": "Query column.", "required": false, "type": "number" }, "required": false, "id": "ReportQueryFilterColumns", "type": "array" }, "sort_direction": { "description": "Query sort direction. Can be one of ASC, DESC. ASC will return bottom talkers. DESC will return top talkers (default).", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] }, "bgpas_pairs": { "description": "Query autonomous system pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Query application_servers. Can be one of GET /reporting/application_servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Query devices. Can be one of GET /reporting/devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Query application_ports. Can be one of GET /reporting/application_ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "bgpas_host_groups": { "description": "Query autonomous system and host group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Query host_pair_ports. Can be one of GET /reporting/host_pair_ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Query dscp_interfaces. Can be one of GET /reporting/dscp_interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Query autonomous system.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "role": { "description": "Query role. Can be one of /reporting/roles.", "required": false, "type": "string" }, "show_ttl": { "description": "Query show TTL. Only applicable to flow list report format.", "required": false, "type": "string" }, "group_by": { "description": "Query group_by. Can be one of GET /reporting/group_bys.", "required": false, "type": "string" }, "case_insensitive": { "description": "Query user case insensitivity. Whether to search for users in a case-insensitive fashion.", "required": false, "type": "string" }, "switch_name": { "description": "Query switch name. Can be an IP address or a name.", "required": false, "type": "string" }, "macs": { "description": "Query MAC addresses. Host MAC addresses, only apply to switch_port requests.", "required": false, "type": "string" }, "host_group_type": { "description": "Query host group type. Required for \"host group (gro)\" \"host group pairs (gpp)\" and \"host group pairs with ports (gpr)\" queries.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Query host_pair_app_ports. Can be one of GET /reporting/host_pair_app_ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "direction": { "description": "Query direction. Can be one of GET /reporting/directions.", "required": false, "type": "string" }, "users": { "description": "Query time host users. Can be one of GET /reporting/time host user.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "switch_ports": { "description": "Query switch ports. Switch port addresses.", "required": false, "type": "string" }, "sort_column": { "description": "Query sort column. Can be one of GET /reporting/columns.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Query host_group_pair_ports. Can be one of GET /reporting/host_group_pair_ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Query network_segments. Can be one of GET /reporting/network_segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "macless_ports": { "description": "Query macless ports. Include switch ports without a MAC address.", "required": false, "type": "string" }, "hosts": { "description": "Query hosts. Can be one of GET /reporting/hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "ignore_dhcp": { "description": "Query ignore DHCP. Use only switch port polling for ARP Bindings.", "required": false, "type": "string" }, "host_pairs": { "description": "Query host pairs. Can be one of GET /reporting/host_pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "area": { "description": "Query area. Can be one of GET /reporting/areas.", "required": false, "type": "string" }, "protocols": { "description": "Query protocols. Can be one of GET /reporting/protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Query centricity. Can be one of GET /reporting/centricities.", "required": false, "type": "string" }, "limit": { "description": "Query data limit. Maximum number of rows to be returned. Default value: 10000.", "required": false, "type": "number" }, "interfaces": { "description": "Query interfaces. Can be one of GET /reporting/interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Query host_groups. Can be one of GET /reporting/host_groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "realm": { "description": "Query realm. Can be one of GET /reporting/realms.", "required": true, "type": "string" }, "dscps": { "description": "Query dscps. Can be one of GET /reporting/dscps.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Query applications. Can be one of GET /reporting/applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "ReportQueryFilter", "type": "object" }, "required": false, "id": "ReportQueryFilters", "type": "array" }, "deprecated": { "description": "Map with legacy criteria attributes that will not be supported soon.", "required": false, "additionalProperties": { "description": "ReportDeprecatedFilters map value.", "required": false, "xmlKeyName": "key", "type": "string" }, "id": "ReportDeprecatedFilters", "type": "object" }, "fast_data_source": { "description": "Options to force using fast (pre-computed) interfaces data. FORCE: force using only fast data. ON: use fast data when possible, fallback to slower traffic query. OFF: never use fast data. By default it is ON.", "required": false, "type": "string", "enum": [ "FORCE", "ON", "OFF" ] } }, "id": "ReportCriteria", "type": "object" }, "timeout": { "description": "Used when doing POST to /reporting/reports/synchronous. Timeout (# of seconds) to wait for the repot to complete, it the report does not complete the operation will return and the client needs to wait for progress.", "required": false, "type": "number" }, "name": { "description": "Report name.", "required": false, "type": "string" }, "template_id": { "description": "Template ID. Can be one of GET /reporting/templates.", "required": true, "type": "number" } }, "id": "ReportInputs", "type": "object", "example": { "criteria": { "time_frame": { "end": 1404247682, "start": 1404246782, "resolution": "1min" }, "queries": [ { "sort_column": 33, "realm": "traffic_summary", "group_by": "hos", "limit": 1000, "columns": [ 5, 33 ] }, { "realm": "traffic_time_series", "columns": [ 33 ], "applications": [ { "name": "WEB" }, { "name": "SSL" } ] }, { "realm": "traffic_overall_time_series", "columns": [ 33 ] } ] }, "template_id": 184 } }, "httpmethod": "POST", "path": "reporting/reports/synchronous", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing report information.", "properties": { "queries": { "description": "Data for all queries.", "items": { "description": "Data for a query.", "required": false, "properties": { "actual_end_time": { "description": "Actual end time of the response data.", "required": false, "type": "number" }, "data": { "description": "Two-dimensional data array.", "items": { "description": "One row in the list of rows.", "items": { "description": "One value datum.", "required": false, "type": "string" }, "required": false, "id": "Row", "type": "array" }, "required": true, "id": "Rows", "type": "array" }, "data_size": { "description": "Number of rows in the data array.", "required": false, "type": "number" }, "totals": { "description": "Object representing a row of total values (totals).", "items": { "description": "One total datum.", "required": false, "type": "string" }, "required": false, "id": "Totals", "type": "array" }, "actual_start_time": { "description": "Actual start time of the response data.", "required": false, "type": "number" } }, "id": "DataResults", "type": "object" }, "required": false, "id": "MultiDataResults", "type": "array" }, "info": { "description": "Object representing report information.", "required": true, "properties": { "run_time": { "description": "Time when the report was run (Unix time).", "required": true, "type": "number" }, "error_text": { "description": "A report can be completed with an error. Error message may provide more detailed info.", "required": false, "type": "string" }, "remaining_seconds": { "description": "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.", "required": true, "type": "number" }, "saved": { "description": "Boolean flag indicating if the report was saved.", "required": true, "type": "string" }, "id": { "description": "ID of the report. To be used in the API.", "required": true, "type": "number" }, "status": { "description": "Status of the report.", "required": true, "type": "string", "enum": [ "completed", "running", "waiting" ] }, "percent": { "description": "Progress of the report represented by percentage of report completion.", "required": true, "type": "number" }, "user_id": { "description": "ID of the user who owns the report.", "required": true, "type": "number" }, "size": { "description": "Size of the report in kilobytes.", "required": true, "type": "number" }, "name": { "description": "Name of the report. Could be given by a user or automatically generated by the system.", "required": false, "type": "string" }, "template_id": { "description": "ID of the template that the report is based on.", "required": true, "type": "number" } }, "id": "ReportInfo", "type": "object" } }, "id": "SynchronousReportInfo", "type": "object", "example": { "info": { "status": "completed", "user_id": 1, "name": "", "percent": 100, "id": 4776, "remaining_seconds": 0, "run_time": 1404248112, "saved": false, "template_id": 184, "error_text": "", "size": 68 }, "queries": [ { "data": [ [ "10.100.6.12", "1772226.76458" ], [ "10.100.5.12", "837179.645833" ] ], "data_size": 2, "totals": [ "", "13468043.5906" ] }, { "data": [ [ "1404246900", "761145.883333", "295159.5" ], [ "1404246960", "781774.483333", "338582.75" ], [ "1404247020", "936568.983333", "240805" ], [ "1404247080", "848997.183333", "239956.016667" ], [ "1404247140", "966685.133333", "289431.1" ], [ "1404247200", "782460.6", "263017.35" ], [ "1404247260", "763241", "283707.716667" ], [ "1404247320", "919111.183333", "316550.666667" ], [ "1404247380", "868125.816667", "328541.466667" ], [ "1404247440", "903302.883333", "254661.683333" ], [ "1404247500", "997295.483333", "287660.733333" ], [ "1404247560", "870767.5", "310042.95" ], [ "1404247620", "855725", "219515" ], [ "1404247680", "897158.466667", "284758.483333" ], [ "1404247740", "738258.833333", "274042.85" ], [ "1404247800", "871363.666667", "318390.283333" ] ], "data_size": 16, "totals": [ "", "860123.88125", "284051.471875" ] }, { "data": [ [ "1404246900", "6504597.66667" ], [ "1404246960", "6608432.01667" ], [ "1404247020", "6743953.4" ], [ "1404247080", "6511449.36667" ], [ "1404247140", "7097525.13333" ], [ "1404247200", "6914061.36667" ], [ "1404247260", "6655675.9" ], [ "1404247320", "6891936.41667" ], [ "1404247380", "6774957.88333" ], [ "1404247440", "6849686.76667" ], [ "1404247500", "6860683.15" ], [ "1404247560", "6628106.46667" ], [ "1404247620", "6644355.31667" ], [ "1404247680", "6704957.16667" ], [ "1404247740", "6543321.96667" ], [ "1404247800", "6811653.9" ] ], "data_size": 16, "totals": [ "", "6734084.61771" ] } ] } }, "authorization": "required" }, "Set section layout": { "description": "Set the layout of widgets in a grid in the template section.", "request": { "description": "Object representing visual layout of widgets in a secion.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "id": "TMFlowLines", "type": "array", "example": [] }, "httpmethod": "PUT", "path": "reporting/templates/{template_id}/sections/{section_id}/layout", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List widgets": { "description": "Get the widgets located in the template section.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/{template_id}/sections/{section_id}/widgets", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of TMWidget objects.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "id": "TMWidgets", "type": "array", "example": [ { "title": "VoIP-RTP: Applications", "timestamp": "1383141976.674383", "criteria": { "sort_column": 33, "traffic_expression": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 } ] }, "authorization": "required" }, "Delete report": { "description": "Delete a report.", "httpmethod": "DELETE", "path": "reporting/reports/{report_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List realms": { "description": "Get a list of realms.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/realms", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of type of report queries (realms) that could be requested and run.", "items": { "description": "Object representing a realm.", "required": false, "properties": { "id": { "description": "ID of a realm. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a realm.", "required": true, "type": "string" } }, "id": "Realm", "type": "object" }, "id": "Realms", "type": "array", "example": [ { "id": "traffic_summary", "name": "traffic summary" }, { "id": "traffic_flow_list", "name": "traffic flow list" }, { "id": "traffic_overall_time_series", "name": "traffic overall time series" } ] }, "authorization": "required" }, "Delete widget": { "description": "Delete one widget from the template section.", "httpmethod": "DELETE", "path": "reporting/templates/{template_id}/sections/{section_id}/widgets/{widget_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Update widget": { "description": "Update one widget in the template section.", "request": { "description": "Widget specification.", "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object", "example": { "title": "VoIP-RTP: Applications", "timestamp": "1383141976.674383", "criteria": { "sort_column": 33, "traffic_expression": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 } }, "httpmethod": "PUT", "path": "reporting/templates/{template_id}/sections/{section_id}/widgets/{widget_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List centricities": { "description": "Get a list of centricities that this version of the API supports.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/centricities", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of centricities.", "items": { "description": "Object representing a centricity.", "required": false, "properties": { "id": { "description": "ID of a centricity. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a centricity.", "required": true, "type": "string" } }, "id": "Centricity", "type": "object" }, "id": "Centricities", "type": "array", "example": [ { "id": "hos", "name": "host" }, { "id": "int", "name": "interface" } ] }, "authorization": "required" }, "Import templates": { "description": "Import reporting templates.", "request": { "description": "List of ReportTemplateSpec objects.", "items": { "description": "One ReportTemplateSpes object.", "required": false, "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within the template.", "required": false, "type": "string" }, "id": { "description": "ID of the report template.", "required": false, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "auto_disabled_on": { "description": "Timestamp when the template was auto-disabled due to idle usage.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "layout": { "description": "Layout information.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" }, "description": { "description": "Human-readable description of the template.", "required": false, "type": "string" }, "user_id": { "description": "User ID of the template owner.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "last_added_section_id": { "description": "ID of the last layout section added to the template.", "required": false, "type": "number" }, "wizard": { "description": "Template wizard properties.", "required": false, "properties": { "interface": { "description": "Watched interface for type WATCHED_IFACE type dashboards.", "required": false, "type": "string" }, "type": { "description": "Dashboard template type.", "required": true, "type": "string", "enum": [ "WATCHED_IFACE", "APP_PERFORMANCE", "SSO", "NET_OPERATIONS", "SERVICE", "OVERALL_WAN", "VOIP_CALL", "DEFAULT" ] } }, "id": "DashboardTemplateWizard", "type": "object" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "last_added_widget_id": { "description": "ID of the last widget added to the template.", "required": false, "type": "number" }, "version": { "description": "Version of the specification.", "required": false, "type": "string" }, "disabled": { "description": "Flag indicating that the template is disabled.", "required": false, "type": "string" }, "timestamp": { "description": "Report time stamp (unix time).", "required": false, "type": "string" }, "sections": { "description": "List of layout sections.", "items": { "description": "One TMSection object.", "required": false, "properties": { "widgets": { "description": "List of widgets that belong to the section.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "required": false, "id": "TMWidgets", "type": "array" }, "section_id": { "description": "Section ID.", "required": true, "type": "number" }, "layout": { "description": "Internal section layout.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" } }, "id": "TMSection", "type": "object" }, "required": false, "id": "TMSections", "type": "array" }, "img": { "description": "Images associaled with the template.", "required": false, "properties": { "thumbnail": { "description": "A thumbnail-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" }, "full": { "description": "A full-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" } }, "id": "ReportTemplateImg", "type": "object" } }, "id": "ReportTemplateSpec", "type": "object" }, "id": "ReportTemplateSpecs", "type": "array", "example": [ { "live": true, "layout": [ { "flow_items": [ { "id": 1 } ] } ], "name": "VOIP - Call Quality and Usage", "user_id": 1, "timestamp": "1383141976.674345", "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": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 }, { "title": "VoIP-RTP: Traffic Quality", "timestamp": "1383141976.674428", "criteria": { "traffic_expression": "", "columns": [ 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "line_scale": "LINEAR", "format_bytes": "UI_PREF", "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": "", "columns": [ 781 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 766 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 33 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_day", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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", "limit": 100, "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "height": 400, "edge_thickness": true, "pan_zoomable": true, "n_items": 10, "layout": "HORIZONTAL_TREE", "moveable_nodes": true, "show_images": true, "format_bytes": "UI_PREF" }, "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": "" } ] }, "httpmethod": "POST", "path": "reporting/templates/import", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List units": { "description": "Get a list of units that this version of the API supports.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/units", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of units.", "items": { "description": "Object representing a unit.", "required": false, "properties": { "id": { "description": "ID of a unit. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a unit.", "required": true, "type": "string" } }, "id": "Unit", "type": "object" }, "id": "Units", "type": "array", "example": [ { "id": "byt", "name": "bytes" }, { "id": "pkt", "name": "packet" }, { "id": "con", "name": "conntions" } ] }, "authorization": "required" }, "Create template": { "description": "Create a new reporting template.", "formats": [ "xml", "json" ], "request": { "description": "Reporting template specification object.", "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within the template.", "required": false, "type": "string" }, "id": { "description": "ID of the report template.", "required": false, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "auto_disabled_on": { "description": "Timestamp when the template was auto-disabled due to idle usage.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "layout": { "description": "Layout information.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" }, "description": { "description": "Human-readable description of the template.", "required": false, "type": "string" }, "user_id": { "description": "User ID of the template owner.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "last_added_section_id": { "description": "ID of the last layout section added to the template.", "required": false, "type": "number" }, "wizard": { "description": "Template wizard properties.", "required": false, "properties": { "interface": { "description": "Watched interface for type WATCHED_IFACE type dashboards.", "required": false, "type": "string" }, "type": { "description": "Dashboard template type.", "required": true, "type": "string", "enum": [ "WATCHED_IFACE", "APP_PERFORMANCE", "SSO", "NET_OPERATIONS", "SERVICE", "OVERALL_WAN", "VOIP_CALL", "DEFAULT" ] } }, "id": "DashboardTemplateWizard", "type": "object" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "last_added_widget_id": { "description": "ID of the last widget added to the template.", "required": false, "type": "number" }, "version": { "description": "Version of the specification.", "required": false, "type": "string" }, "disabled": { "description": "Flag indicating that the template is disabled.", "required": false, "type": "string" }, "timestamp": { "description": "Report time stamp (unix time).", "required": false, "type": "string" }, "sections": { "description": "List of layout sections.", "items": { "description": "One TMSection object.", "required": false, "properties": { "widgets": { "description": "List of widgets that belong to the section.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "required": false, "id": "TMWidgets", "type": "array" }, "section_id": { "description": "Section ID.", "required": true, "type": "number" }, "layout": { "description": "Internal section layout.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" } }, "id": "TMSection", "type": "object" }, "required": false, "id": "TMSections", "type": "array" }, "img": { "description": "Images associaled with the template.", "required": false, "properties": { "thumbnail": { "description": "A thumbnail-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" }, "full": { "description": "A full-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" } }, "id": "ReportTemplateImg", "type": "object" } }, "id": "ReportTemplateSpec", "type": "object", "example": { "live": true, "layout": [ { "flow_items": [ { "id": 1 } ] } ], "name": "VOIP - Call Quality and Usage", "user_id": 1, "timestamp": "1383141976.674345", "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": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 }, { "title": "VoIP-RTP: Traffic Quality", "timestamp": "1383141976.674428", "criteria": { "traffic_expression": "", "columns": [ 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "line_scale": "LINEAR", "format_bytes": "UI_PREF", "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": "", "columns": [ 781 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 766 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 33 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_day", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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", "limit": 100, "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "height": 400, "edge_thickness": true, "pan_zoomable": true, "n_items": 10, "layout": "HORIZONTAL_TREE", "moveable_nodes": true, "show_images": true, "format_bytes": "UI_PREF" }, "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": "" } }, "httpmethod": "POST", "path": "reporting/templates", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "A template for running reports.", "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within this template.", "required": false, "type": "string" }, "schedule_type": { "description": "Type of template scheduling.", "required": false, "type": "string", "enum": [ "Once", "Hourly", "Daily", "Weekly", "Monthly", "Quarterly" ] }, "id": { "description": "ID of the template.", "required": true, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "description": { "description": "Description of the template.", "required": false, "type": "string" }, "user_id": { "description": "ID of the user who owns the template.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "disabled": { "description": "Flag indicating that data collection for the template is disabled.", "required": false, "type": "string" }, "next_run": { "description": "Next run time for the template if the template is scheduled to run.", "required": false, "type": "number" } }, "id": "ReportTemplate", "type": "object", "example": { "user_id": 1, "live": true, "id": 1000, "name": "My Template" } }, "authorization": "required" }, "Get reporting end times": { "description": "List end times for each data source.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/timestamps", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Collection of ReportTimestamp objects.", "items": { "description": "Object representing report timing information.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. (can be: flow, 1min, 5min, 15min, hour, 6hour, day, week, month).", "required": true, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "end_time": { "description": "Report end time (unix time).", "required": true, "type": "number" }, "datasource": { "description": "Report data source type (can be: TRAFFIC, SERVICE, EVENTS, ACTIVE_DIRECTORY, FDS_TRAFFIC).", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "start_time": { "description": "Report start time (unix time).", "required": true, "type": "number" } }, "id": "ReportTimestamp", "type": "object" }, "id": "ReportTimestamps", "type": "array", "example": [ { "data_resolution": "day", "start_time": 0, "end_time": 1383105600, "datasource": "TRAFFIC" }, { "data_resolution": "15mins", "start_time": 0, "end_time": 1383160500, "datasource": "SERVICE" }, { "data_resolution": "min", "start_time": 0, "end_time": 1383161280, "datasource": "TRAFFIC" }, { "data_resolution": "6hours", "start_time": 0, "end_time": 1383148800, "datasource": "TRAFFIC" }, { "data_resolution": "hour", "start_time": 0, "end_time": 1383159600, "datasource": "TRAFFIC" }, { "data_resolution": "15mins", "start_time": 0, "end_time": 1383160500, "datasource": "TRAFFIC" }, { "data_resolution": "15mins", "start_time": 1383150500, "end_time": 1383160500, "datasource": "FDS_TRAFFIC" } ] }, "authorization": "required" }, "List severities": { "description": "Get a list of severities that this version of the API supports.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/severities", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of severities.", "items": { "description": "Object representing a severity.", "required": false, "properties": { "id": { "description": "ID of a severity. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a severity.", "required": true, "type": "string" } }, "id": "Severity", "type": "object" }, "id": "Severities", "type": "array", "example": [ { "id": "nav", "name": "not available" }, { "id": "nml", "name": "normal" }, { "id": "low", "name": "low" }, { "id": "med", "name": "medium" }, { "id": "hgh", "name": "high" }, { "id": "all", "name": "all" } ] }, "authorization": "required" }, "Get query data": { "description": "Get data for one or many columns from this query.", "parameters": { "columns": { "required": false, "type": "string", "description": "Comma-separated list of column ids." }, "offset": { "required": false, "type": "number", "description": "Start row." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/reports/{report_id}/queries/{query_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a 2-dimensional array of query data and totals.", "properties": { "actual_end_time": { "description": "Actual end time of the response data.", "required": false, "type": "number" }, "data": { "description": "Two-dimensional data array.", "items": { "description": "One row in the list of rows.", "items": { "description": "One value datum.", "required": false, "type": "string" }, "required": false, "id": "Row", "type": "array" }, "required": true, "id": "Rows", "type": "array" }, "data_size": { "description": "Number of rows in the data array.", "required": false, "type": "number" }, "totals": { "description": "Object representing a row of total values (totals).", "items": { "description": "One total datum.", "required": false, "type": "string" }, "required": false, "id": "Totals", "type": "array" }, "actual_start_time": { "description": "Actual start time of the response data.", "required": false, "type": "number" } }, "id": "DataResults", "type": "object", "example": { "data": [ [ "10.38.8.202|", "6878717.15556", "7041.06111111" ], [ "10.38.9.152|", "1996165.24167", "2049.01388889" ] ], "data_size": 3744, "totals": [ "", "20293913.8417", "23577.3055556" ] } }, "authorization": "required" }, "List group bys": { "description": "Get a list of reporting summarizations (group bys).", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/group_bys", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of reporting summarizations (group-bys).", "items": { "description": "Object representing a group by.", "required": false, "properties": { "id": { "description": "ID of a group by. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a group by.", "required": true, "type": "string" } }, "id": "GroupBy", "type": "object" }, "id": "GroupBys", "type": "array", "example": [ { "id": "hos", "name": "host" }, { "id": "hop", "name": "host pair" }, { "id": "gro", "name": "host group" }, { "id": "gpp", "name": "host group pair" } ] }, "authorization": "required" }, "Create widget": { "description": "Create a new widget in the template section.", "formats": [ "xml", "json" ], "request": { "description": "Widget specification.", "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object", "example": { "title": "VoIP-RTP: Applications", "timestamp": "1383141976.674383", "criteria": { "sort_column": 33, "traffic_expression": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 } }, "httpmethod": "POST", "path": "reporting/templates/{template_id}/sections/{section_id}/widgets", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Widget specification.", "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object", "example": { "title": "VoIP-RTP: Applications", "timestamp": "1383141976.674383", "criteria": { "sort_column": 33, "traffic_expression": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 } }, "authorization": "required" }, "List columns": { "description": "Get a list of columns.", "parameters": { "metric": { "required": false, "type": "string", "description": "Filter the list of columns by metric." }, "statistic": { "required": false, "type": "string", "description": "Filter the list of columns by statistic." }, "severity": { "required": false, "type": "string", "description": "Filter the list of columns by severity." }, "role": { "required": false, "type": "string", "description": "Filter the list of columns by role." }, "category": { "required": false, "type": "string", "description": "Filter the list of columns by category." }, "group_by": { "required": false, "type": "string", "description": "Filter the list of columns by group by." }, "direction": { "required": false, "type": "string", "description": "Filter the list of columns by direction." }, "area": { "required": false, "type": "string", "description": "Filter the list of columns by area." }, "centricity": { "required": false, "type": "string", "description": "Filter the list of columns by centricity." }, "unit": { "required": false, "type": "string", "description": "Filter the list of columns by unit." }, "rate": { "required": false, "type": "string", "description": "Filter the list of columns by rate." }, "realm": { "required": false, "type": "string", "description": "Filter the list of columns by realm." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/columns", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of reporting query columns.", "items": { "description": "A column for reporting query.", "required": false, "properties": { "metric": { "description": "Column 'metric'. See 'reporting/metrics'.", "required": true, "type": "string" }, "cli_srv": { "description": "Text flag indicating if the column is for the clients or servers.", "required": true, "type": "string" }, "comparison_parameter": { "description": "Parameter for column comparison.", "required": true, "type": "string" }, "internal": { "description": "Boolean flag indicating if the column is internal to the system.", "required": true, "type": "string" }, "id": { "description": "System ID for the column. Used in the API.", "required": true, "type": "number" }, "strid": { "description": "String ID for the column. Not used by the API, but easier for the human user to see.", "required": true, "type": "string" }, "statistic": { "description": "Column 'statistic'. See 'reporting/statistics'.", "required": true, "type": "string" }, "severity": { "description": "Column 'severity'. See 'reporting/severities.", "required": true, "type": "string" }, "role": { "description": "Column 'role'. See 'reporting/roles'.", "required": true, "type": "string" }, "category": { "description": "Column 'category'. See 'reporting/categories'.", "required": true, "type": "string" }, "name": { "description": "Column name. Format used for column names is similar to the format used for column data.", "required": true, "type": "string" }, "comparison": { "description": "Column 'comparison'. See 'reporting/comparisons'.", "required": true, "type": "string" }, "sortable": { "description": "Boolean flag indicating if this data can be sorted on this column when running the template.", "required": true, "type": "string" }, "type": { "description": "Type of the column data. See 'reporting/types'.", "required": true, "type": "string" }, "direction": { "description": "Column 'direction'. See 'reporting/directions'.", "required": true, "type": "string" }, "available": { "description": "Boolean flag indicating that the data for the column is available without the need to re-run the template.", "required": true, "type": "string" }, "context": { "description": "Internal flag used for formatting certain kinds of data.", "required": true, "type": "string" }, "area": { "description": "Column 'area'. See 'reporting/area'.", "required": true, "type": "string" }, "has_others": { "description": "Boolean flag indicating if the column's 'other' row can be computed.", "required": true, "type": "string" }, "unit": { "description": "Column 'unit'. See 'reporting/units'.", "required": true, "type": "string" }, "name_type": { "description": "Type of the column name. See 'reporting/types'.", "required": true, "type": "string" }, "rate": { "description": "Column 'rate'. See 'reporting/rates'.", "required": true, "type": "string" } }, "id": "Column", "type": "object" }, "id": "Columns", "type": "array", "example": [ { "strid": "ID_TOTAL_BYTES", "metric": "net_bw", "rate": "count", "statistic": "total", "id": 30, "unit": "bytes", "category": "data", "severity": "none", "area": "none", "internal": false, "role": "none", "cli_srv": "none", "type": "int", "available": false, "direction": "none", "comparison": "none", "sortable": true, "name": "Total Bytes", "comparison_parameter": "", "has_others": false, "context": false, "name_type": "colname_parts" }, { "strid": "ID_TOTAL_PKTS", "metric": "net_bw", "rate": "count", "statistic": "total", "id": 31, "unit": "pkts", "category": "data", "severity": "none", "area": "none", "internal": false, "role": "none", "cli_srv": "none", "type": "int", "available": false, "direction": "none", "comparison": "none", "sortable": true, "name": "Total Packets", "comparison_parameter": "", "has_others": false, "context": false, "name_type": "colname_parts" } ] }, "authorization": "required" }, "Get section layout": { "description": "Get the layout of the template section.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/{template_id}/sections/{section_id}/layout", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing visual layout of widgets in a secion.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "id": "TMFlowLines", "type": "array", "example": [] }, "authorization": "required" }, "Get report": { "description": "Get information for report. Includes progress information for running reports.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/reports/{report_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing report information.", "properties": { "run_time": { "description": "Time when the report was run (Unix time).", "required": true, "type": "number" }, "error_text": { "description": "A report can be completed with an error. Error message may provide more detailed info.", "required": false, "type": "string" }, "remaining_seconds": { "description": "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.", "required": true, "type": "number" }, "saved": { "description": "Boolean flag indicating if the report was saved.", "required": true, "type": "string" }, "id": { "description": "ID of the report. To be used in the API.", "required": true, "type": "number" }, "status": { "description": "Status of the report.", "required": true, "type": "string", "enum": [ "completed", "running", "waiting" ] }, "percent": { "description": "Progress of the report represented by percentage of report completion.", "required": true, "type": "number" }, "user_id": { "description": "ID of the user who owns the report.", "required": true, "type": "number" }, "size": { "description": "Size of the report in kilobytes.", "required": true, "type": "number" }, "name": { "description": "Name of the report. Could be given by a user or automatically generated by the system.", "required": false, "type": "string" }, "template_id": { "description": "ID of the template that the report is based on.", "required": true, "type": "number" } }, "id": "ReportInfo", "type": "object", "example": { "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 } }, "authorization": "required" }, "Get template configuration": { "description": "Get template configuration data.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/{template_id}/config", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Reporting template specification object.", "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within the template.", "required": false, "type": "string" }, "id": { "description": "ID of the report template.", "required": false, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "auto_disabled_on": { "description": "Timestamp when the template was auto-disabled due to idle usage.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "layout": { "description": "Layout information.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" }, "description": { "description": "Human-readable description of the template.", "required": false, "type": "string" }, "user_id": { "description": "User ID of the template owner.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "last_added_section_id": { "description": "ID of the last layout section added to the template.", "required": false, "type": "number" }, "wizard": { "description": "Template wizard properties.", "required": false, "properties": { "interface": { "description": "Watched interface for type WATCHED_IFACE type dashboards.", "required": false, "type": "string" }, "type": { "description": "Dashboard template type.", "required": true, "type": "string", "enum": [ "WATCHED_IFACE", "APP_PERFORMANCE", "SSO", "NET_OPERATIONS", "SERVICE", "OVERALL_WAN", "VOIP_CALL", "DEFAULT" ] } }, "id": "DashboardTemplateWizard", "type": "object" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "last_added_widget_id": { "description": "ID of the last widget added to the template.", "required": false, "type": "number" }, "version": { "description": "Version of the specification.", "required": false, "type": "string" }, "disabled": { "description": "Flag indicating that the template is disabled.", "required": false, "type": "string" }, "timestamp": { "description": "Report time stamp (unix time).", "required": false, "type": "string" }, "sections": { "description": "List of layout sections.", "items": { "description": "One TMSection object.", "required": false, "properties": { "widgets": { "description": "List of widgets that belong to the section.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "required": false, "id": "TMWidgets", "type": "array" }, "section_id": { "description": "Section ID.", "required": true, "type": "number" }, "layout": { "description": "Internal section layout.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" } }, "id": "TMSection", "type": "object" }, "required": false, "id": "TMSections", "type": "array" }, "img": { "description": "Images associaled with the template.", "required": false, "properties": { "thumbnail": { "description": "A thumbnail-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" }, "full": { "description": "A full-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" } }, "id": "ReportTemplateImg", "type": "object" } }, "id": "ReportTemplateSpec", "type": "object", "example": { "live": true, "layout": [ { "flow_items": [ { "id": 1 } ] } ], "name": "VOIP - Call Quality and Usage", "user_id": 1, "timestamp": "1383141976.674345", "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": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 }, { "title": "VoIP-RTP: Traffic Quality", "timestamp": "1383141976.674428", "criteria": { "traffic_expression": "", "columns": [ 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "line_scale": "LINEAR", "format_bytes": "UI_PREF", "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": "", "columns": [ 781 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 766 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 33 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_day", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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", "limit": 100, "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "height": 400, "edge_thickness": true, "pan_zoomable": true, "n_items": 10, "layout": "HORIZONTAL_TREE", "moveable_nodes": true, "show_images": true, "format_bytes": "UI_PREF" }, "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": "" } }, "authorization": "required" }, "Clone template": { "description": "Clone the specified reporting template.", "parameters": { "template": { "required": true, "type": "number", "description": "ID of the template being cloned." }, "name": { "required": false, "type": "string", "description": "A new unique name for the copy." } }, "formats": [ "xml", "json" ], "httpmethod": "POST", "path": "reporting/templates/copy", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "A template for running reports.", "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within this template.", "required": false, "type": "string" }, "schedule_type": { "description": "Type of template scheduling.", "required": false, "type": "string", "enum": [ "Once", "Hourly", "Daily", "Weekly", "Monthly", "Quarterly" ] }, "id": { "description": "ID of the template.", "required": true, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "description": { "description": "Description of the template.", "required": false, "type": "string" }, "user_id": { "description": "ID of the user who owns the template.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "disabled": { "description": "Flag indicating that data collection for the template is disabled.", "required": false, "type": "string" }, "next_run": { "description": "Next run time for the template if the template is scheduled to run.", "required": false, "type": "number" } }, "id": "ReportTemplate", "type": "object", "example": { "user_id": 1, "live": true, "id": 1000, "name": "My Template" } }, "authorization": "required" }, "Delete template": { "description": "Delete reporting template.", "formats": [ "xml", "json" ], "httpmethod": "DELETE", "path": "reporting/templates/{template_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "A template for running reports.", "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within this template.", "required": false, "type": "string" }, "schedule_type": { "description": "Type of template scheduling.", "required": false, "type": "string", "enum": [ "Once", "Hourly", "Daily", "Weekly", "Monthly", "Quarterly" ] }, "id": { "description": "ID of the template.", "required": true, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "description": { "description": "Description of the template.", "required": false, "type": "string" }, "user_id": { "description": "ID of the user who owns the template.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "disabled": { "description": "Flag indicating that data collection for the template is disabled.", "required": false, "type": "string" }, "next_run": { "description": "Next run time for the template if the template is scheduled to run.", "required": false, "type": "number" } }, "id": "ReportTemplate", "type": "object", "example": { "user_id": 1, "live": true, "id": 1000, "name": "My Template" } }, "authorization": "required" }, "List templates": { "description": "Get a list of templates.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting element number." }, "access": { "required": false, "type": "string", "description": "Get only template with the specified access level: 'public' or 'private'." }, "filter": { "required": false, "type": "string", "description": "Apply a named filter: 'owned' to get only templates owned by the current user." }, "live": { "required": false, "type": "string", "description": "Filter only live (dashboard) templates." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of templates available on the system.", "items": { "description": "One template in the list of templates.", "required": false, "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within this template.", "required": false, "type": "string" }, "schedule_type": { "description": "Type of template scheduling.", "required": false, "type": "string", "enum": [ "Once", "Hourly", "Daily", "Weekly", "Monthly", "Quarterly" ] }, "id": { "description": "ID of the template.", "required": true, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "description": { "description": "Description of the template.", "required": false, "type": "string" }, "user_id": { "description": "ID of the user who owns the template.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "disabled": { "description": "Flag indicating that data collection for the template is disabled.", "required": false, "type": "string" }, "next_run": { "description": "Next run time for the template if the template is scheduled to run.", "required": false, "type": "number" } }, "id": "ReportTemplate", "type": "object" }, "id": "ReportTemplates", "type": "array", "example": [ { "scheduled": false, "live": false, "id": 184, "name": "Default template for class QUERY" }, { "scheduled": true, "next_run": 1352328480, "user_id": 1, "live": true, "schedule_type": "Hourly", "id": 1000, "name": "My Template" } ] }, "authorization": "required" }, "Get factory widgets": { "description": "Get a list of all available stock widget configurations.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/widgets", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of TMWidget objects.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "id": "TMWidgets", "type": "array", "example": [ { "title": "VoIP-RTP: Applications", "timestamp": "1383141976.674383", "criteria": { "sort_column": 33, "traffic_expression": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 } ] }, "authorization": "required" }, "Export templates": { "description": "Export all reporting templates.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/export", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of ReportTemplateSpec objects.", "items": { "description": "One ReportTemplateSpes object.", "required": false, "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within the template.", "required": false, "type": "string" }, "id": { "description": "ID of the report template.", "required": false, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "auto_disabled_on": { "description": "Timestamp when the template was auto-disabled due to idle usage.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "layout": { "description": "Layout information.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" }, "description": { "description": "Human-readable description of the template.", "required": false, "type": "string" }, "user_id": { "description": "User ID of the template owner.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "last_added_section_id": { "description": "ID of the last layout section added to the template.", "required": false, "type": "number" }, "wizard": { "description": "Template wizard properties.", "required": false, "properties": { "interface": { "description": "Watched interface for type WATCHED_IFACE type dashboards.", "required": false, "type": "string" }, "type": { "description": "Dashboard template type.", "required": true, "type": "string", "enum": [ "WATCHED_IFACE", "APP_PERFORMANCE", "SSO", "NET_OPERATIONS", "SERVICE", "OVERALL_WAN", "VOIP_CALL", "DEFAULT" ] } }, "id": "DashboardTemplateWizard", "type": "object" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "last_added_widget_id": { "description": "ID of the last widget added to the template.", "required": false, "type": "number" }, "version": { "description": "Version of the specification.", "required": false, "type": "string" }, "disabled": { "description": "Flag indicating that the template is disabled.", "required": false, "type": "string" }, "timestamp": { "description": "Report time stamp (unix time).", "required": false, "type": "string" }, "sections": { "description": "List of layout sections.", "items": { "description": "One TMSection object.", "required": false, "properties": { "widgets": { "description": "List of widgets that belong to the section.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "required": false, "id": "TMWidgets", "type": "array" }, "section_id": { "description": "Section ID.", "required": true, "type": "number" }, "layout": { "description": "Internal section layout.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" } }, "id": "TMSection", "type": "object" }, "required": false, "id": "TMSections", "type": "array" }, "img": { "description": "Images associaled with the template.", "required": false, "properties": { "thumbnail": { "description": "A thumbnail-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" }, "full": { "description": "A full-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" } }, "id": "ReportTemplateImg", "type": "object" } }, "id": "ReportTemplateSpec", "type": "object" }, "id": "ReportTemplateSpecs", "type": "array", "example": [ { "live": true, "layout": [ { "flow_items": [ { "id": 1 } ] } ], "name": "VOIP - Call Quality and Usage", "user_id": 1, "timestamp": "1383141976.674345", "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": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 }, { "title": "VoIP-RTP: Traffic Quality", "timestamp": "1383141976.674428", "criteria": { "traffic_expression": "", "columns": [ 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "line_scale": "LINEAR", "format_bytes": "UI_PREF", "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": "", "columns": [ 781 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 766 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 33 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_day", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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", "limit": 100, "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "height": 400, "edge_thickness": true, "pan_zoomable": true, "n_items": 10, "layout": "HORIZONTAL_TREE", "moveable_nodes": true, "show_images": true, "format_bytes": "UI_PREF" }, "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": "" } ] }, "authorization": "required" }, "Get Dashboard templates": { "description": "Get build in templates (Dashboard templates).", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/builtin", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of ReportTemplateSpec objects.", "items": { "description": "One ReportTemplateSpes object.", "required": false, "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within the template.", "required": false, "type": "string" }, "id": { "description": "ID of the report template.", "required": false, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "auto_disabled_on": { "description": "Timestamp when the template was auto-disabled due to idle usage.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "layout": { "description": "Layout information.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" }, "description": { "description": "Human-readable description of the template.", "required": false, "type": "string" }, "user_id": { "description": "User ID of the template owner.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "last_added_section_id": { "description": "ID of the last layout section added to the template.", "required": false, "type": "number" }, "wizard": { "description": "Template wizard properties.", "required": false, "properties": { "interface": { "description": "Watched interface for type WATCHED_IFACE type dashboards.", "required": false, "type": "string" }, "type": { "description": "Dashboard template type.", "required": true, "type": "string", "enum": [ "WATCHED_IFACE", "APP_PERFORMANCE", "SSO", "NET_OPERATIONS", "SERVICE", "OVERALL_WAN", "VOIP_CALL", "DEFAULT" ] } }, "id": "DashboardTemplateWizard", "type": "object" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "last_added_widget_id": { "description": "ID of the last widget added to the template.", "required": false, "type": "number" }, "version": { "description": "Version of the specification.", "required": false, "type": "string" }, "disabled": { "description": "Flag indicating that the template is disabled.", "required": false, "type": "string" }, "timestamp": { "description": "Report time stamp (unix time).", "required": false, "type": "string" }, "sections": { "description": "List of layout sections.", "items": { "description": "One TMSection object.", "required": false, "properties": { "widgets": { "description": "List of widgets that belong to the section.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "required": false, "id": "TMWidgets", "type": "array" }, "section_id": { "description": "Section ID.", "required": true, "type": "number" }, "layout": { "description": "Internal section layout.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" } }, "id": "TMSection", "type": "object" }, "required": false, "id": "TMSections", "type": "array" }, "img": { "description": "Images associaled with the template.", "required": false, "properties": { "thumbnail": { "description": "A thumbnail-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" }, "full": { "description": "A full-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" } }, "id": "ReportTemplateImg", "type": "object" } }, "id": "ReportTemplateSpec", "type": "object" }, "id": "ReportTemplateSpecs", "type": "array", "example": [ { "live": true, "layout": [ { "flow_items": [ { "id": 1 } ] } ], "name": "VOIP - Call Quality and Usage", "user_id": 1, "timestamp": "1383141976.674345", "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": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 }, { "title": "VoIP-RTP: Traffic Quality", "timestamp": "1383141976.674428", "criteria": { "traffic_expression": "", "columns": [ 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "line_scale": "LINEAR", "format_bytes": "UI_PREF", "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": "", "columns": [ 781 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 766 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 33 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_day", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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", "limit": 100, "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "height": 400, "edge_thickness": true, "pan_zoomable": true, "n_items": 10, "layout": "HORIZONTAL_TREE", "moveable_nodes": true, "show_images": true, "format_bytes": "UI_PREF" }, "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": "" } ] }, "authorization": "required" }, "Get report config": { "description": "Get configuration information for one report. Includes criteria, layout and GUI attributes.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/reports/{report_id}/config", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing report configuration.", "properties": { "criteria": { "description": "Report criteria.", "required": true, "properties": { "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "time_frame": { "description": "Time frame object.", "required": false, "properties": { "time_interval": { "description": "Time interval pipe-separated string (example: 'last|1|hour').", "required": false, "type": "string" }, "resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month. If not specified a resolution will automatically be selected based on time frame of the report.", "required": false, "type": "string" }, "end": { "description": "Report end time (unix time).", "required": false, "type": "number" }, "expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "start": { "description": "Report start time (unix time).", "required": false, "type": "number" }, "time_zone": { "description": "Time zone name.", "required": false, "type": "string" } }, "id": "ReportTimeFrame", "type": "object" }, "query": { "description": "Query object.", "required": false, "properties": { "ports": { "description": "Query ports. Can be one of GET /reporting/ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Query dscp_app_ports. Can be one of GET /reporting/dscp_app_ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "port_groups": { "description": "Query port_groups. Can be one of GET /reporting/port_groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "cbqos_classes": { "description": "Query CBQoS classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Query autonomous system scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Query host_group_pairs. Can be one of GET /reporting/host_group_pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "Query WAN group. Can be any Interface Group under /WAN.", "required": false, "type": "string" }, "traffic_expression": { "description": "Query-specific traffic expression.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Query include non-optimized. Include non-optimized sites in a WAN query.", "required": false, "type": "string" }, "columns": { "description": "Query columns. Can be many of GET /reporting/columns.", "items": { "description": "Query column.", "required": false, "type": "number" }, "required": false, "id": "ReportQueryFilterColumns", "type": "array" }, "sort_direction": { "description": "Query sort direction. Can be one of ASC, DESC. ASC will return bottom talkers. DESC will return top talkers (default).", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] }, "bgpas_pairs": { "description": "Query autonomous system pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Query application_servers. Can be one of GET /reporting/application_servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Query devices. Can be one of GET /reporting/devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Query application_ports. Can be one of GET /reporting/application_ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "bgpas_host_groups": { "description": "Query autonomous system and host group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Query host_pair_ports. Can be one of GET /reporting/host_pair_ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Query dscp_interfaces. Can be one of GET /reporting/dscp_interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Query autonomous system.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "role": { "description": "Query role. Can be one of /reporting/roles.", "required": false, "type": "string" }, "show_ttl": { "description": "Query show TTL. Only applicable to flow list report format.", "required": false, "type": "string" }, "group_by": { "description": "Query group_by. Can be one of GET /reporting/group_bys.", "required": false, "type": "string" }, "case_insensitive": { "description": "Query user case insensitivity. Whether to search for users in a case-insensitive fashion.", "required": false, "type": "string" }, "switch_name": { "description": "Query switch name. Can be an IP address or a name.", "required": false, "type": "string" }, "macs": { "description": "Query MAC addresses. Host MAC addresses, only apply to switch_port requests.", "required": false, "type": "string" }, "host_group_type": { "description": "Query host group type. Required for \"host group (gro)\" \"host group pairs (gpp)\" and \"host group pairs with ports (gpr)\" queries.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Query host_pair_app_ports. Can be one of GET /reporting/host_pair_app_ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "direction": { "description": "Query direction. Can be one of GET /reporting/directions.", "required": false, "type": "string" }, "users": { "description": "Query time host users. Can be one of GET /reporting/time host user.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "switch_ports": { "description": "Query switch ports. Switch port addresses.", "required": false, "type": "string" }, "sort_column": { "description": "Query sort column. Can be one of GET /reporting/columns.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Query host_group_pair_ports. Can be one of GET /reporting/host_group_pair_ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Query network_segments. Can be one of GET /reporting/network_segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "macless_ports": { "description": "Query macless ports. Include switch ports without a MAC address.", "required": false, "type": "string" }, "hosts": { "description": "Query hosts. Can be one of GET /reporting/hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "ignore_dhcp": { "description": "Query ignore DHCP. Use only switch port polling for ARP Bindings.", "required": false, "type": "string" }, "host_pairs": { "description": "Query host pairs. Can be one of GET /reporting/host_pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "area": { "description": "Query area. Can be one of GET /reporting/areas.", "required": false, "type": "string" }, "protocols": { "description": "Query protocols. Can be one of GET /reporting/protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Query centricity. Can be one of GET /reporting/centricities.", "required": false, "type": "string" }, "limit": { "description": "Query data limit. Maximum number of rows to be returned. Default value: 10000.", "required": false, "type": "number" }, "interfaces": { "description": "Query interfaces. Can be one of GET /reporting/interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Query host_groups. Can be one of GET /reporting/host_groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "realm": { "description": "Query realm. Can be one of GET /reporting/realms.", "required": true, "type": "string" }, "dscps": { "description": "Query dscps. Can be one of GET /reporting/dscps.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Query applications. Can be one of GET /reporting/applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "ReportQueryFilter", "type": "object" }, "queries": { "description": "Array of Query objects.", "items": { "description": "Report Query.", "required": false, "properties": { "ports": { "description": "Query ports. Can be one of GET /reporting/ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Query dscp_app_ports. Can be one of GET /reporting/dscp_app_ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "port_groups": { "description": "Query port_groups. Can be one of GET /reporting/port_groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "cbqos_classes": { "description": "Query CBQoS classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Query autonomous system scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Query host_group_pairs. Can be one of GET /reporting/host_group_pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "Query WAN group. Can be any Interface Group under /WAN.", "required": false, "type": "string" }, "traffic_expression": { "description": "Query-specific traffic expression.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Query include non-optimized. Include non-optimized sites in a WAN query.", "required": false, "type": "string" }, "columns": { "description": "Query columns. Can be many of GET /reporting/columns.", "items": { "description": "Query column.", "required": false, "type": "number" }, "required": false, "id": "ReportQueryFilterColumns", "type": "array" }, "sort_direction": { "description": "Query sort direction. Can be one of ASC, DESC. ASC will return bottom talkers. DESC will return top talkers (default).", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] }, "bgpas_pairs": { "description": "Query autonomous system pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Query application_servers. Can be one of GET /reporting/application_servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Query devices. Can be one of GET /reporting/devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Query application_ports. Can be one of GET /reporting/application_ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "bgpas_host_groups": { "description": "Query autonomous system and host group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Query host_pair_ports. Can be one of GET /reporting/host_pair_ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Query dscp_interfaces. Can be one of GET /reporting/dscp_interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Query autonomous system.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "role": { "description": "Query role. Can be one of /reporting/roles.", "required": false, "type": "string" }, "show_ttl": { "description": "Query show TTL. Only applicable to flow list report format.", "required": false, "type": "string" }, "group_by": { "description": "Query group_by. Can be one of GET /reporting/group_bys.", "required": false, "type": "string" }, "case_insensitive": { "description": "Query user case insensitivity. Whether to search for users in a case-insensitive fashion.", "required": false, "type": "string" }, "switch_name": { "description": "Query switch name. Can be an IP address or a name.", "required": false, "type": "string" }, "macs": { "description": "Query MAC addresses. Host MAC addresses, only apply to switch_port requests.", "required": false, "type": "string" }, "host_group_type": { "description": "Query host group type. Required for \"host group (gro)\" \"host group pairs (gpp)\" and \"host group pairs with ports (gpr)\" queries.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Query host_pair_app_ports. Can be one of GET /reporting/host_pair_app_ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "direction": { "description": "Query direction. Can be one of GET /reporting/directions.", "required": false, "type": "string" }, "users": { "description": "Query time host users. Can be one of GET /reporting/time host user.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "switch_ports": { "description": "Query switch ports. Switch port addresses.", "required": false, "type": "string" }, "sort_column": { "description": "Query sort column. Can be one of GET /reporting/columns.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Query host_group_pair_ports. Can be one of GET /reporting/host_group_pair_ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Query network_segments. Can be one of GET /reporting/network_segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "macless_ports": { "description": "Query macless ports. Include switch ports without a MAC address.", "required": false, "type": "string" }, "hosts": { "description": "Query hosts. Can be one of GET /reporting/hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "ignore_dhcp": { "description": "Query ignore DHCP. Use only switch port polling for ARP Bindings.", "required": false, "type": "string" }, "host_pairs": { "description": "Query host pairs. Can be one of GET /reporting/host_pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "area": { "description": "Query area. Can be one of GET /reporting/areas.", "required": false, "type": "string" }, "protocols": { "description": "Query protocols. Can be one of GET /reporting/protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Query centricity. Can be one of GET /reporting/centricities.", "required": false, "type": "string" }, "limit": { "description": "Query data limit. Maximum number of rows to be returned. Default value: 10000.", "required": false, "type": "number" }, "interfaces": { "description": "Query interfaces. Can be one of GET /reporting/interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Query host_groups. Can be one of GET /reporting/host_groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "realm": { "description": "Query realm. Can be one of GET /reporting/realms.", "required": true, "type": "string" }, "dscps": { "description": "Query dscps. Can be one of GET /reporting/dscps.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Query applications. Can be one of GET /reporting/applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "ReportQueryFilter", "type": "object" }, "required": false, "id": "ReportQueryFilters", "type": "array" }, "deprecated": { "description": "Map with legacy criteria attributes that will not be supported soon.", "required": false, "additionalProperties": { "description": "ReportDeprecatedFilters map value.", "required": false, "xmlKeyName": "key", "type": "string" }, "id": "ReportDeprecatedFilters", "type": "object" }, "fast_data_source": { "description": "Options to force using fast (pre-computed) interfaces data. FORCE: force using only fast data. ON: use fast data when possible, fallback to slower traffic query. OFF: never use fast data. By default it is ON.", "required": false, "type": "string", "enum": [ "FORCE", "ON", "OFF" ] } }, "id": "ReportCriteria", "type": "object" }, "attributes": { "description": "Report attributes.", "required": true, "additionalProperties": { "description": "Report attributes value.", "required": false, "xmlKeyName": "key", "type": "string" }, "id": "ReportConfigAttrs", "type": "object" }, "sections": { "description": "Report sections.", "items": { "description": "One section of a report.", "required": false, "properties": { "widgets": { "description": "List of section widgets.", "items": { "description": "One widget from a list of widgets.", "required": false, "properties": { "query_id": { "description": "Query ID for the query that the widget is based on.", "required": true, "type": "string" }, "id": { "description": "Widget ID used to reference a widget from the API.", "required": true, "type": "string" }, "type": { "description": "Visual type of the widget.", "required": true, "type": "string" }, "attributes": { "description": "Widget attributes.", "required": true, "additionalProperties": { "description": "Attribute value in the map.", "required": false, "xmlKeyName": "key", "type": "string" }, "id": "ReportWidgetAttrs", "type": "object" } }, "id": "ReportWidget", "type": "object" }, "required": true, "id": "ReportWidgets", "type": "array" }, "layout": { "description": "Section widget layout.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "items": { "description": "List of items (widgets) on the line.", "items": { "description": "One item in the list of layout items.", "required": false, "properties": { "id": { "description": "ID of the layout item.", "required": false, "type": "string" } }, "id": "ReportLayoutItem", "type": "object" }, "required": true, "id": "ReportLayoutItems", "type": "array" }, "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" }, "line_spacing": { "description": "Line spacing.", "required": false, "type": "string" } }, "id": "ReportLayoutLine", "type": "object" }, "required": false, "id": "ReportSectionLayout", "type": "array" }, "attributes": { "description": "Section attributes.", "required": true, "additionalProperties": { "description": "Attribute value in the map.", "required": false, "xmlKeyName": "key", "type": "string" }, "id": "ReportSectionAttrs", "type": "object" } }, "id": "ReportSection", "type": "object" }, "required": true, "id": "ReportSections", "type": "array" } }, "id": "ReportConfig", "type": "object", "example": { "attributes": { "title": "Report name" }, "sections": [ { "widgets": [ { "type": "table", "query_id": "0:sum_hos_non_non_non_non_non_non_non_33_d_0", "id": "sum_hos_non_non_non_non_non_non_non_tbl_0_0", "attributes": { "page_size": "20", "sort_col": "33", "col_order": "6,33,34" } } ], "attributes": { "sort_desc": "1" }, "layout": [ { "items": [ { "id": "sum_hos_non_non_non_non_non_non_non_tbl_0_0" } ] } ] } ], "criteria": { "time_frame": { "end": 1352320191, "start": 1352319891 }, "query": { "sort_column": 33, "realm": "traffic_summary", "group_by": "hos", "columns": [ 6, 33, 34 ], "centricity": "hos" } } } }, "authorization": "required" }, "List areas": { "description": "Get a list of areas that this version of the API supports.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/areas", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of areas.", "items": { "description": "Object representing an area.", "required": false, "properties": { "id": { "description": "ID of an area. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a area.", "required": true, "type": "string" } }, "id": "Area", "type": "object" }, "id": "Areas", "type": "array", "example": [ { "id": "wan", "name": "wan" }, { "id": "lan", "name": "lan" } ] }, "authorization": "required" }, "Update user attributes": { "description": "Merge user-specific template attributes with the new attribute values.", "request": { "description": "Set of widget attributes.", "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object", "example": [] }, "httpmethod": "PUT", "path": "reporting/templates/{template_id}/sections/{section_id}/widgets/{widget_id}/user_attributes", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List metrics": { "description": "Get a list of metrics that this version of the API supports.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/metrics", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of metrics.", "items": { "description": "Object representing a metric.", "required": false, "properties": { "id": { "description": "ID of a metric. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a metric.", "required": true, "type": "string" } }, "id": "Metric", "type": "object" }, "id": "Metrics", "type": "array", "example": [ { "id": "nbw", "name": "net bandwidth" }, { "id": "nrt", "name": "net rtt" }, { "id": "rtm", "name": "response time" } ] }, "authorization": "required" }, "List rates": { "description": "Get a list of rates that this version of the API supports.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/rates", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of rates.", "items": { "description": "Object representing a rate.", "required": false, "properties": { "id": { "description": "ID of a rate. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a rate.", "required": true, "type": "string" } }, "id": "Rate", "type": "object" }, "id": "Rates", "type": "array", "example": [ { "id": "cnt", "name": "count" }, { "id": "psc", "name": "per second" } ] }, "authorization": "required" }, "Get template section": { "description": "Get the specific section from the template.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/{template_id}/sections/{section_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "One section in the report layout.", "properties": { "widgets": { "description": "List of widgets that belong to the section.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "required": false, "id": "TMWidgets", "type": "array" }, "section_id": { "description": "Section ID.", "required": true, "type": "number" }, "layout": { "description": "Internal section layout.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" } }, "id": "TMSection", "type": "object" }, "authorization": "required" }, "Get template sections": { "description": "Get a list of sections in the template.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/{template_id}/sections", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of TMSection objects.", "items": { "description": "One TMSection object.", "required": false, "properties": { "widgets": { "description": "List of widgets that belong to the section.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "required": false, "id": "TMWidgets", "type": "array" }, "section_id": { "description": "Section ID.", "required": true, "type": "number" }, "layout": { "description": "Internal section layout.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" } }, "id": "TMSection", "type": "object" }, "id": "TMSections", "type": "array", "example": [] }, "authorization": "required" }, "Get template": { "description": "Get a template.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/templates/{template_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Reporting template specification object.", "properties": { "traffic_expression": { "description": "Traffic expression applied to all widgets within the template.", "required": false, "type": "string" }, "id": { "description": "ID of the report template.", "required": false, "type": "number" }, "scheduled": { "description": "Flag indicating that the template is scheduled.", "required": false, "type": "string" }, "auto_disabled_on": { "description": "Timestamp when the template was auto-disabled due to idle usage.", "required": false, "type": "string" }, "sharing": { "description": "List of the users the template is shared with (see ReportTemplateSharing).", "required": false, "properties": { "users": { "description": "List of the users a template is shared with.", "items": { "description": "User ID.", "required": false, "type": "number" }, "required": false, "id": "ReportTemplateSharingUsers", "type": "array" } }, "id": "ReportTemplateSharing", "type": "object" }, "layout": { "description": "Layout information.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" }, "description": { "description": "Human-readable description of the template.", "required": false, "type": "string" }, "user_id": { "description": "User ID of the template owner.", "required": false, "type": "number" }, "shared": { "description": "Flag indicating that the template is shared with other users.", "required": false, "type": "string", "enum": [ "Private", "Public", "Users" ] }, "live": { "description": "Flag indicating that the template is a dashboard.", "required": true, "type": "string" }, "last_added_section_id": { "description": "ID of the last layout section added to the template.", "required": false, "type": "number" }, "wizard": { "description": "Template wizard properties.", "required": false, "properties": { "interface": { "description": "Watched interface for type WATCHED_IFACE type dashboards.", "required": false, "type": "string" }, "type": { "description": "Dashboard template type.", "required": true, "type": "string", "enum": [ "WATCHED_IFACE", "APP_PERFORMANCE", "SSO", "NET_OPERATIONS", "SERVICE", "OVERALL_WAN", "VOIP_CALL", "DEFAULT" ] } }, "id": "DashboardTemplateWizard", "type": "object" }, "name": { "description": "Human-readable name of the template.", "required": true, "type": "string" }, "last_added_widget_id": { "description": "ID of the last widget added to the template.", "required": false, "type": "number" }, "version": { "description": "Version of the specification.", "required": false, "type": "string" }, "disabled": { "description": "Flag indicating that the template is disabled.", "required": false, "type": "string" }, "timestamp": { "description": "Report time stamp (unix time).", "required": false, "type": "string" }, "sections": { "description": "List of layout sections.", "items": { "description": "One TMSection object.", "required": false, "properties": { "widgets": { "description": "List of widgets that belong to the section.", "items": { "description": "One TMWidget object.", "required": false, "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object" }, "required": false, "id": "TMWidgets", "type": "array" }, "section_id": { "description": "Section ID.", "required": true, "type": "number" }, "layout": { "description": "Internal section layout.", "items": { "description": "One horizontal line of widgets.", "required": false, "properties": { "flow_items": { "description": "List of line items.", "items": { "description": "Object replesenting one layout item.", "required": false, "properties": { "id": { "description": "Widget ID.", "required": false, "type": "number" } }, "id": "TMFlowItem", "type": "object" }, "required": false, "id": "TMFlowItems", "type": "array" }, "attributes": { "description": "List of line attributes.", "required": false, "properties": { "wrappable": { "description": "Flag allowing wrapping.", "required": false, "type": "string" }, "full_width": { "description": "Flag representing width of the layout line.", "required": false, "type": "string" }, "item_spacing": { "description": "Item spacing between widgets.", "required": false, "type": "string" } }, "id": "TMFlowLineAttributes", "type": "object" } }, "id": "TMFlowLine", "type": "object" }, "required": false, "id": "TMFlowLines", "type": "array" } }, "id": "TMSection", "type": "object" }, "required": false, "id": "TMSections", "type": "array" }, "img": { "description": "Images associaled with the template.", "required": false, "properties": { "thumbnail": { "description": "A thumbnail-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" }, "full": { "description": "A full-size image for the report template.", "required": false, "properties": { "src": { "description": "Relative URL of an image.", "required": true, "type": "string" } }, "id": "ReportTemplateImgProperties", "type": "object" } }, "id": "ReportTemplateImg", "type": "object" } }, "id": "ReportTemplateSpec", "type": "object", "example": { "live": true, "layout": [ { "flow_items": [ { "id": 1 } ] } ], "name": "VOIP - Call Quality and Usage", "user_id": 1, "timestamp": "1383141976.674345", "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": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 }, { "title": "VoIP-RTP: Traffic Quality", "timestamp": "1383141976.674428", "criteria": { "traffic_expression": "", "columns": [ 803 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "line_scale": "LINEAR", "format_bytes": "UI_PREF", "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": "", "columns": [ 781 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 1, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 766 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "min", "type": "last_hour", "refresh_interval": "min" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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": "", "columns": [ 33 ], "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_day", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "extend_to_zero": false, "format_bytes": "UI_PREF", "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", "limit": 100, "sort_desc": true, "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "height": 400, "edge_thickness": true, "pan_zoomable": true, "n_items": 10, "layout": "HORIZONTAL_TREE", "moveable_nodes": true, "show_images": true, "format_bytes": "UI_PREF" }, "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": "" } }, "authorization": "required" }, "Get report view (PDF, CSV)": { "description": "Get GUI view of a report (PDF, CSV).", "formats": [ "pdf", "csv" ], "httpmethod": "GET", "path": "reporting/reports/{report_id}/view", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List roles": { "description": "Get a list of roles that this version of the API supports.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/roles", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of roles.", "items": { "description": "Object representing a roles.", "required": false, "properties": { "id": { "description": "ID of a role. To be used in the API.", "required": true, "type": "string" }, "name": { "description": "Human-readable name of a role.", "required": true, "type": "string" } }, "id": "Role", "type": "object" }, "id": "Roles", "type": "array", "example": [ { "id": "cli", "name": "client" }, { "id": "srv", "name": "server" } ] }, "authorization": "required" }, "Copy widget": { "description": "Copy a widget from one template to another.", "parameters": { "widget": { "required": true, "type": "number", "description": "ID of the widget being copied." }, "dest_template": { "required": true, "type": "number", "description": "Destination template ID." }, "src_template": { "required": true, "type": "number", "description": "Source template ID." } }, "formats": [ "xml", "json" ], "httpmethod": "POST", "path": "reporting/templates/widgets/copy", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Widget specification.", "properties": { "config": { "description": "Widget configuration: data source type, widget type, and visualization type.", "required": true, "properties": { "datasource": { "description": "Data source type.", "required": true, "type": "string", "enum": [ "TRAFFIC", "WAN", "SERVICE", "EVENTS", "ACTIVE_DIRECTORY", "FDS_TRAFFIC" ] }, "visualization": { "description": "Visualization type.", "required": true, "type": "string", "enum": [ "TABLE", "PIE", "BAR", "LINE", "CONN_GRAPH", "TREE_TABLE", "INVISIBLE" ] }, "widget_type": { "description": "Widget type.", "required": true, "type": "string", "enum": [ "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", "BGPAS", "PEER_BGPAS", "BGPAS_PAIRS", "BGPAS_HOST_GROUPS", "CURRENT_EVENTS", "UNACKED_EVENTS", "ACTIVE_DIRECTORY", "SERVICE_HEALTH", "LOCATION_HEALTH", "SERVICE_HEALTH_MAP", "LOCATION_HEALTH_MAP" ] } }, "id": "TMConfig", "type": "object" }, "widget_id": { "description": "Internal widget ID within a dashboard.", "required": false, "type": "number" }, "criteria": { "description": "Query criteria for the widget.", "required": true, "properties": { "compare_to": { "description": "Flag to enable comparison feature for Bar, Table and Line widgets.", "required": false, "type": "string", "enum": [ "LAST_DAY", "LAST_WEEK", "LAST_4WEEKS" ] }, "ports": { "description": "Watched ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Watched combinations of DSCPs, applications, and ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "services": { "description": "Watched services.", "items": { "description": "One CService object.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "required": false, "id": "CServices", "type": "array" }, "protoports_groups": { "description": "Watched combination of protocols, ports, groups.", "required": false, "type": "string" }, "port_groups": { "description": "Watched port groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "interfaces_groups_devices": { "description": "Watched combination of interfaces, groups, devices.", "required": false, "type": "string" }, "comparison_time_frame": { "description": "Not used any more.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "cbqos_classes": { "description": "CBQoS Classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Autonomous System Scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Watched group pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "WAN group used in WAN Optimization widgets. Can be one of '/WAN', '/WAN/Optimized', '/WAN/Non-optimized'.", "required": false, "type": "string" }, "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "split_direction": { "description": "Split inbound/outbound or received/transmitted data.", "required": false, "type": "string" }, "include_successes": { "description": "Include successful requests in active directory report.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Flag indicating whether to include WAN non optimized sites.", "required": false, "type": "string" }, "columns": { "description": "List of column ID.", "items": { "description": "Column ID.", "required": false, "type": "number" }, "required": false, "id": "TMColumns", "type": "array" }, "hosts_groups_cidrs": { "description": "Watched combination of hosts, host groups and cidrs.", "required": false, "type": "string" }, "bgpas_pairs": { "description": "Autonomous System Pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Watched combinations of applications and servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Watched devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Watched combinations of applications and ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "include_failures": { "description": "Include failed requests in active directory report.", "required": false, "type": "string" }, "bgpas_host_groups": { "description": "List of Autonomous System and Host Group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Watched combinations of host pairs and ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Watched combinations of DSCPs and interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Autonomous System.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "time_frame": { "description": "Widget time frame specification.", "required": false, "properties": { "data_resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month.", "required": false, "type": "string", "enum": [ "flow", "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "refresh_interval": { "description": "Report refresh interval. It can be one of: min, 5mins, 15mins, hour, 6hours, day, week, month.", "required": false, "type": "string", "enum": [ "min", "5mins", "15mins", "hour", "6hours", "day", "week", "month" ] }, "type": { "description": "Type of time frame. Can be one of: last_min, last_5mins, last_15mins, last_hour, last_6hours, last_12hours, last_day, last_week, last_month, previous_hour, previous_day, previous_week, previous_month.", "required": false, "type": "string", "enum": [ "last_min", "last_5mins", "last_15mins", "last_hour", "last_6hours", "last_12hours", "last_day", "last_week", "last_month", "previous_hour", "previous_day", "previous_week", "previous_month" ] } }, "id": "TMWidgetTimeFrame", "type": "object" }, "service": { "description": "Watched service.", "required": false, "properties": { "name": { "description": "Service name.", "required": true, "type": "string" }, "service_id": { "description": "Service ID.", "required": false, "type": "number" } }, "id": "CService", "type": "object" }, "severity": { "description": "Minimum severity filter for an event report.", "required": false, "type": "number" }, "role": { "description": "Which host roles to include in a report ('CLIENT_SERVER', 'CLIENT', 'SERVER').", "required": false, "type": "string", "enum": [ "CLIENT_SERVER", "CLIENT", "SERVER" ] }, "event_policies": { "description": "List of event policies to include in an event report.", "items": { "description": "Event policy ID.", "required": false, "type": "number" }, "required": false, "id": "EventPolicies", "type": "array" }, "service_locations": { "description": "Watched service locations.", "items": { "description": "One CServiceLocation object.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "required": false, "id": "CServiceLocations", "type": "array" }, "case_insensitive": { "description": "Case-insensitive usernames in an identity report.", "required": false, "type": "string" }, "service_location": { "description": "Watched service location.", "required": false, "properties": { "name": { "description": "Service location name.", "required": true, "type": "string" }, "location_id": { "description": "Service location ID.", "required": false, "type": "string" } }, "id": "CServiceLocation", "type": "object" }, "include_backend_segments": { "description": "Flag indicating whether to include back-end segments.", "required": false, "type": "string" }, "host_group_type": { "description": "Host group type used.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Watched combinations of host pairs, applications, and ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "users": { "description": "Watched users.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "sort_desc": { "description": "Sorting direction (true for descending, false for ascending).", "required": false, "type": "string" }, "sort_column": { "description": "Sorting column ID.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Watched combinations of host groups pairs and ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Watched network segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "hosts": { "description": "Watched hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "host_pairs": { "description": "Watched host pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "auto_update": { "description": "Flag to enable updating daily top-n Line widgets.", "required": false, "type": "string" }, "protocols": { "description": "Watched protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Centricity used to run the report.", "required": false, "type": "string" }, "limit": { "description": "Maximum number of data rows in the report for the widget.", "required": false, "type": "number" }, "interfaces": { "description": "Watched interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Watched host groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "dscps": { "description": "Watched DSCPs.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Watched applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "TMWidgetCriteria", "type": "object" }, "title": { "description": "Widget title.", "required": true, "type": "string" }, "attributes": { "description": "Widget common attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "user_attributes": { "description": "User-specific attributes.", "required": false, "properties": { "pan_zoomable": { "description": "Flag making the graph interactive.", "required": false, "type": "string" }, "line_scale": { "description": "Line scale for a line chart (can be: LINEAR, LOG).", "required": false, "type": "string", "enum": [ "LINEAR", "LOG" ] }, "format_bytes": { "description": "What unit to use for formating traffic values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "show_images": { "description": "Flag showing images in a connection graph.", "required": false, "type": "string" }, "open_nodes": { "description": "List of open node IDs for a tree widget.", "items": { "description": "ID of an expanded nodes in a tree widget.", "required": false, "type": "string" }, "required": false, "id": "TMWAOpenNodes", "type": "array" }, "line_style": { "description": "Line chart style (can be: LINE, STACKED).", "required": false, "type": "string", "enum": [ "LINE", "STACKED" ] }, "layout": { "description": "Connection graph layout type (can be: HORIZONTAL_CLISRV, VERTICAL_CLISRV, HORIZONTAL_TREE, VERTICAL_TREE, RADIAL_TREE, SYMMETRIC).", "required": false, "type": "string", "enum": [ "HORIZONTAL_CLISRV", "VERTICAL_CLISRV", "HORIZONTAL_TREE", "VERTICAL_TREE", "RADIAL_TREE", "SYMMETRIC" ] }, "width": { "description": "Widget width.", "required": false, "type": "number" }, "height": { "description": "Widget height.", "required": false, "type": "number" }, "percent_of_total": { "description": "Flag including the 'total' item in a pie chart.", "required": false, "type": "string" }, "edge_thickness": { "description": "Widget edge thickness.", "required": false, "type": "string" }, "display_host_group_type": { "description": "Default host grouping type for displaying grouped hosts.", "required": false, "type": "string" }, "extend_to_zero": { "description": "Flag: extending the Y-axis to zero.", "required": false, "type": "string" }, "collapsible": { "description": "Flag indicating if the widget is collapsible.", "required": false, "type": "string" }, "format_through_bytes": { "description": "What unit to use for formating throughput values (BITS, BYTES, KBITS, KBYTES, MBITS, MBYTES, GBITS, GBYTES, AUTOBITS, AUTOBYTES, UI_PREF).", "required": false, "type": "string", "enum": [ "BITS", "BYTES", "KBITS", "KBYTES", "MBITS", "MBYTES", "GBITS", "GBYTES", "AUTOBITS", "AUTOBYTES", "UI_PREF" ] }, "high_threshold": { "description": "High threshold on the chart (in bytes).", "required": false, "type": "string" }, "n_items": { "description": "Maximum number of items shown.", "required": false, "type": "number" }, "colspan": { "description": "How many columns the widget occupies in layout.", "required": false, "type": "number" }, "low_threshold": { "description": "Low threshold on the chart (in bytes).", "required": false, "type": "string" }, "moveable_nodes": { "description": "Flag allowing the user to reposition nodes in a connection graph.", "required": false, "type": "string" }, "orientation": { "description": "Bar chart orientation (can be: VERTICAL, HORIZONTAL).", "required": false, "type": "string", "enum": [ "VERTICAL", "HORIZONTAL" ] }, "modal_links": { "description": "Flag adding modal links on a widget.", "required": false, "type": "number" } }, "id": "TMWidgetAttributes", "type": "object" }, "timestamp": { "description": "Widget time stamp specification.", "required": false, "type": "string" } }, "id": "TMWidget", "type": "object", "example": { "title": "VoIP-RTP: Applications", "timestamp": "1383141976.674383", "criteria": { "sort_column": 33, "traffic_expression": "", "limit": 100, "columns": [ 17, 33, 34, 757, 766, 781, 803 ], "centricity": "host", "time_frame": { "data_resolution": "15mins", "type": "last_hour", "refresh_interval": "15mins" } }, "attributes": { "colspan": 2, "n_items": 20, "format_bytes": "UI_PREF" }, "config": { "widget_type": "APPS", "visualization": "TABLE", "datasource": "TRAFFIC" }, "widget_id": 1 } }, "authorization": "required" }, "Get report queries": { "description": "Get information for all queries run as part of this report. Each query has a list of columns.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "reporting/reports/{report_id}/queries", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of queries. Query is one tabular unit of report data.", "items": { "description": "A query.", "required": false, "properties": { "metric": { "description": "Query 'metric'. See 'reporting/metrics'.", "required": true, "type": "string" }, "actual_log": { "description": "Type of data log file that was used to get data for the query.", "required": true, "type": "string" }, "columns": { "description": "List of columns that consitute the query. See 'reporting/columns'.", "items": { "description": "A column for reporting query.", "required": false, "properties": { "metric": { "description": "Column 'metric'. See 'reporting/metrics'.", "required": true, "type": "string" }, "cli_srv": { "description": "Text flag indicating if the column is for the clients or servers.", "required": true, "type": "string" }, "comparison_parameter": { "description": "Parameter for column comparison.", "required": true, "type": "string" }, "internal": { "description": "Boolean flag indicating if the column is internal to the system.", "required": true, "type": "string" }, "id": { "description": "System ID for the column. Used in the API.", "required": true, "type": "number" }, "strid": { "description": "String ID for the column. Not used by the API, but easier for the human user to see.", "required": true, "type": "string" }, "statistic": { "description": "Column 'statistic'. See 'reporting/statistics'.", "required": true, "type": "string" }, "severity": { "description": "Column 'severity'. See 'reporting/severities.", "required": true, "type": "string" }, "role": { "description": "Column 'role'. See 'reporting/roles'.", "required": true, "type": "string" }, "category": { "description": "Column 'category'. See 'reporting/categories'.", "required": true, "type": "string" }, "name": { "description": "Column name. Format used for column names is similar to the format used for column data.", "required": true, "type": "string" }, "comparison": { "description": "Column 'comparison'. See 'reporting/comparisons'.", "required": true, "type": "string" }, "sortable": { "description": "Boolean flag indicating if this data can be sorted on this column when running the template.", "required": true, "type": "string" }, "type": { "description": "Type of the column data. See 'reporting/types'.", "required": true, "type": "string" }, "direction": { "description": "Column 'direction'. See 'reporting/directions'.", "required": true, "type": "string" }, "available": { "description": "Boolean flag indicating that the data for the column is available without the need to re-run the template.", "required": true, "type": "string" }, "context": { "description": "Internal flag used for formatting certain kinds of data.", "required": true, "type": "string" }, "area": { "description": "Column 'area'. See 'reporting/area'.", "required": true, "type": "string" }, "has_others": { "description": "Boolean flag indicating if the column's 'other' row can be computed.", "required": true, "type": "string" }, "unit": { "description": "Column 'unit'. See 'reporting/units'.", "required": true, "type": "string" }, "name_type": { "description": "Type of the column name. See 'reporting/types'.", "required": true, "type": "string" }, "rate": { "description": "Column 'rate'. See 'reporting/rates'.", "required": true, "type": "string" } }, "id": "Column", "type": "object" }, "required": true, "id": "Columns", "type": "array" }, "id": { "description": "ID for the query. Used in the API.", "required": true, "type": "string" }, "statistic": { "description": "Query 'statistic'. See 'reporting/statistics'.", "required": true, "type": "string" }, "role": { "description": "Query 'role'. See 'reporting/roles.'.", "required": true, "type": "string" }, "group_by": { "description": "Grouping of data in the query. See 'reporting/group_bys'.", "required": true, "type": "string" }, "actual_t0": { "description": "Actual start time for data in the query. This could be different from the requested start time because of time interval snapping and other similar features.", "required": true, "type": "number" }, "parent_id": { "description": "Query ID of the query that preceeded this query and influenced data selection for it. For example, if one runs a query that returns time-series data for top 10 protocols in the network, the first query that would need to run is the one to pick top 10 protocols. That query would be the parent one to the follow-up query to get time-series data for those selected 10 protocols.", "required": true, "type": "string" }, "actual_t1": { "description": "Actual end time for the data in the query. See 'actual_t0' for more detail.", "required": true, "type": "number" }, "type": { "description": "Internal value. Reserved.", "required": true, "type": "string" }, "sort_col": { "description": "ID of that column that was used to sort the query when it ran.", "required": true, "type": "number" }, "direction": { "description": "Query 'direction. See 'reporting/directions'.", "required": true, "type": "string" }, "sort_desc": { "description": "Boolean flag indicating if the sorting was in the descending order.", "required": true, "type": "string" }, "area": { "description": "Query 'area'. See 'reporting/areas'.", "required": true, "type": "string" }, "unit": { "description": "Query 'unit'. See 'reporting/units'.", "required": true, "type": "string" }, "rate": { "description": "Query 'rate'. See 'reporting/rates.", "required": true, "type": "string" } }, "id": "Query", "type": "object" }, "id": "Queries", "type": "array", "example": [ { "direction": "none", "actual_log": "flow", "actual_t0": 1352319840, "sort_desc": true, "area": "none", "metric": "none", "sort_col": 33, "parent_id": "", "rate": "none", "group_by": "hos", "role": "none", "columns": [ { "strid": "ID_AVG_BYTES", "metric": "net_bw", "rate": "persec", "statistic": "avg", "id": 33, "unit": "bytes", "category": "data", "severity": "none", "area": "none", "internal": false, "role": "none", "cli_srv": "none", "type": "float", "available": true, "direction": "none", "comparison": "none", "sortable": true, "name": "Avg Bytes/s", "comparison_parameter": "", "has_others": false, "context": false, "name_type": "colname_parts" }, { "strid": "ID_AVG_BYTES_RTX", "metric": "rtx", "rate": "persec", "statistic": "avg", "id": 391, "unit": "bytes", "category": "data", "severity": "none", "area": "none", "internal": false, "role": "none", "cli_srv": "none", "type": "float", "available": false, "direction": "none", "comparison": "none", "sortable": true, "name": "Avg Retrans Bytes/s", "comparison_parameter": "", "has_others": false, "context": false, "name_type": "colname_parts" } ], "statistic": "none", "type": "summary", "id": "0:sum_hos_non_non_non_non_non_non_non_33_d_0", "unit": "none", "actual_t1": 1352320200 } ] }, "authorization": "required" }, "Create active interfaces report": { "description": "Generate a new report with all interfaces active during the past duration.", "parameters": { "duration": { "required": false, "type": "number", "description": "Duration time in seconds." } }, "formats": [ "xml", "json" ], "httpmethod": "POST", "path": "reporting/reports/active_interfaces", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing report information.", "properties": { "run_time": { "description": "Time when the report was run (Unix time).", "required": true, "type": "number" }, "error_text": { "description": "A report can be completed with an error. Error message may provide more detailed info.", "required": false, "type": "string" }, "remaining_seconds": { "description": "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.", "required": true, "type": "number" }, "saved": { "description": "Boolean flag indicating if the report was saved.", "required": true, "type": "string" }, "id": { "description": "ID of the report. To be used in the API.", "required": true, "type": "number" }, "status": { "description": "Status of the report.", "required": true, "type": "string", "enum": [ "completed", "running", "waiting" ] }, "percent": { "description": "Progress of the report represented by percentage of report completion.", "required": true, "type": "number" }, "user_id": { "description": "ID of the user who owns the report.", "required": true, "type": "number" }, "size": { "description": "Size of the report in kilobytes.", "required": true, "type": "number" }, "name": { "description": "Name of the report. Could be given by a user or automatically generated by the system.", "required": false, "type": "string" }, "template_id": { "description": "ID of the template that the report is based on.", "required": true, "type": "number" } }, "id": "ReportInfo", "type": "object", "example": { "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 } }, "authorization": "required" }, "Create report": { "description": "Generate a new report.", "formats": [ "xml", "json" ], "request": { "description": "ReportInputs object.", "properties": { "criteria": { "description": "Criteria neeed to run the report.", "required": false, "properties": { "traffic_expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "time_frame": { "description": "Time frame object.", "required": false, "properties": { "time_interval": { "description": "Time interval pipe-separated string (example: 'last|1|hour').", "required": false, "type": "string" }, "resolution": { "description": "Report data resolution. It can be one of: flow, 1min, 5min, 15min, hour, 6hour, day, week, month. If not specified a resolution will automatically be selected based on time frame of the report.", "required": false, "type": "string" }, "end": { "description": "Report end time (unix time).", "required": false, "type": "number" }, "expression": { "description": "Traffic expression.", "required": false, "type": "string" }, "start": { "description": "Report start time (unix time).", "required": false, "type": "number" }, "time_zone": { "description": "Time zone name.", "required": false, "type": "string" } }, "id": "ReportTimeFrame", "type": "object" }, "query": { "description": "Query object.", "required": false, "properties": { "ports": { "description": "Query ports. Can be one of GET /reporting/ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Query dscp_app_ports. Can be one of GET /reporting/dscp_app_ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "port_groups": { "description": "Query port_groups. Can be one of GET /reporting/port_groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "cbqos_classes": { "description": "Query CBQoS classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Query autonomous system scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Query host_group_pairs. Can be one of GET /reporting/host_group_pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "Query WAN group. Can be any Interface Group under /WAN.", "required": false, "type": "string" }, "traffic_expression": { "description": "Query-specific traffic expression.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Query include non-optimized. Include non-optimized sites in a WAN query.", "required": false, "type": "string" }, "columns": { "description": "Query columns. Can be many of GET /reporting/columns.", "items": { "description": "Query column.", "required": false, "type": "number" }, "required": false, "id": "ReportQueryFilterColumns", "type": "array" }, "sort_direction": { "description": "Query sort direction. Can be one of ASC, DESC. ASC will return bottom talkers. DESC will return top talkers (default).", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] }, "bgpas_pairs": { "description": "Query autonomous system pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Query application_servers. Can be one of GET /reporting/application_servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Query devices. Can be one of GET /reporting/devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Query application_ports. Can be one of GET /reporting/application_ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "bgpas_host_groups": { "description": "Query autonomous system and host group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Query host_pair_ports. Can be one of GET /reporting/host_pair_ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Query dscp_interfaces. Can be one of GET /reporting/dscp_interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Query autonomous system.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "role": { "description": "Query role. Can be one of /reporting/roles.", "required": false, "type": "string" }, "show_ttl": { "description": "Query show TTL. Only applicable to flow list report format.", "required": false, "type": "string" }, "group_by": { "description": "Query group_by. Can be one of GET /reporting/group_bys.", "required": false, "type": "string" }, "case_insensitive": { "description": "Query user case insensitivity. Whether to search for users in a case-insensitive fashion.", "required": false, "type": "string" }, "switch_name": { "description": "Query switch name. Can be an IP address or a name.", "required": false, "type": "string" }, "macs": { "description": "Query MAC addresses. Host MAC addresses, only apply to switch_port requests.", "required": false, "type": "string" }, "host_group_type": { "description": "Query host group type. Required for \"host group (gro)\" \"host group pairs (gpp)\" and \"host group pairs with ports (gpr)\" queries.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Query host_pair_app_ports. Can be one of GET /reporting/host_pair_app_ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "direction": { "description": "Query direction. Can be one of GET /reporting/directions.", "required": false, "type": "string" }, "users": { "description": "Query time host users. Can be one of GET /reporting/time host user.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "switch_ports": { "description": "Query switch ports. Switch port addresses.", "required": false, "type": "string" }, "sort_column": { "description": "Query sort column. Can be one of GET /reporting/columns.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Query host_group_pair_ports. Can be one of GET /reporting/host_group_pair_ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Query network_segments. Can be one of GET /reporting/network_segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "macless_ports": { "description": "Query macless ports. Include switch ports without a MAC address.", "required": false, "type": "string" }, "hosts": { "description": "Query hosts. Can be one of GET /reporting/hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "ignore_dhcp": { "description": "Query ignore DHCP. Use only switch port polling for ARP Bindings.", "required": false, "type": "string" }, "host_pairs": { "description": "Query host pairs. Can be one of GET /reporting/host_pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "area": { "description": "Query area. Can be one of GET /reporting/areas.", "required": false, "type": "string" }, "protocols": { "description": "Query protocols. Can be one of GET /reporting/protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Query centricity. Can be one of GET /reporting/centricities.", "required": false, "type": "string" }, "limit": { "description": "Query data limit. Maximum number of rows to be returned. Default value: 10000.", "required": false, "type": "number" }, "interfaces": { "description": "Query interfaces. Can be one of GET /reporting/interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Query host_groups. Can be one of GET /reporting/host_groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "realm": { "description": "Query realm. Can be one of GET /reporting/realms.", "required": true, "type": "string" }, "dscps": { "description": "Query dscps. Can be one of GET /reporting/dscps.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Query applications. Can be one of GET /reporting/applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "ReportQueryFilter", "type": "object" }, "queries": { "description": "Array of Query objects.", "items": { "description": "Report Query.", "required": false, "properties": { "ports": { "description": "Query ports. Can be one of GET /reporting/ports.", "items": { "description": "One CProtoPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "required": false, "id": "CProtoPorts", "type": "array" }, "dscp_app_ports": { "description": "Query dscp_app_ports. Can be one of GET /reporting/dscp_app_ports.", "items": { "description": "One CDSCPAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPAppPort", "type": "object" }, "required": false, "id": "CDSCPAppPorts", "type": "array" }, "port_groups": { "description": "Query port_groups. Can be one of GET /reporting/port_groups.", "items": { "description": "One CPortGroup object.", "required": false, "properties": { "name": { "description": "Name of the port group.", "required": false, "type": "string" }, "group_id": { "description": "ID of the port group.", "required": false, "type": "number" } }, "id": "CPortGroup", "type": "object" }, "required": false, "id": "CPortGroups", "type": "array" }, "cbqos_classes": { "description": "Query CBQoS classes.", "items": { "description": "Object representing a CBQoS class.", "required": false, "properties": { "id": { "description": "CBQoS class id.", "required": false, "type": "string" } }, "id": "CCBQOSCLASS", "type": "object" }, "required": false, "id": "CCBQOSCLASSList", "type": "array" }, "bgpasscope": { "description": "Query autonomous system scope.", "required": false, "type": "string", "enum": [ "ALL", "PRIVATE", "PUBLIC" ] }, "host_group_pairs": { "description": "Query host_group_pairs. Can be one of GET /reporting/host_group_pairs.", "items": { "description": "One CHostGroupPair object.", "required": false, "properties": { "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPair", "type": "object" }, "required": false, "id": "CHostGroupPairs", "type": "array" }, "wan_group": { "description": "Query WAN group. Can be any Interface Group under /WAN.", "required": false, "type": "string" }, "traffic_expression": { "description": "Query-specific traffic expression.", "required": false, "type": "string" }, "include_non_optimized_sites": { "description": "Query include non-optimized. Include non-optimized sites in a WAN query.", "required": false, "type": "string" }, "columns": { "description": "Query columns. Can be many of GET /reporting/columns.", "items": { "description": "Query column.", "required": false, "type": "number" }, "required": false, "id": "ReportQueryFilterColumns", "type": "array" }, "sort_direction": { "description": "Query sort direction. Can be one of ASC, DESC. ASC will return bottom talkers. DESC will return top talkers (default).", "required": false, "type": "string", "enum": [ "ASC", "DESC" ] }, "bgpas_pairs": { "description": "Query autonomous system pairs.", "items": { "description": "Pair of Autonomous Systems.", "required": false, "properties": { "server": { "description": "Object representing a server Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "client": { "description": "Object representing a client Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASPair", "type": "object" }, "required": false, "id": "CBGPASPairs", "type": "array" }, "application_servers": { "description": "Query application_servers. Can be one of GET /reporting/application_servers.", "items": { "description": "One CApplicationServer object.", "required": false, "properties": { "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CApplicationServer", "type": "object" }, "required": false, "id": "CApplicationServers", "type": "array" }, "devices": { "description": "Query devices. Can be one of GET /reporting/devices.", "items": { "description": "One CDevice object.", "required": false, "properties": { "ipaddr": { "description": "Device IP address.", "required": false, "type": "string" }, "name": { "description": "Device name.", "required": false, "type": "string" } }, "id": "CDevice", "type": "object" }, "required": false, "id": "CDevices", "type": "array" }, "application_ports": { "description": "Query application_ports. Can be one of GET /reporting/application_ports.", "items": { "description": "One CApplicationPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" } }, "id": "CApplicationPort", "type": "object" }, "required": false, "id": "CApplicationPorts", "type": "array" }, "bgpas_host_groups": { "description": "Query autonomous system and host group.", "items": { "description": "Object representing Autonomous System and Host Group.", "required": false, "properties": { "host_group": { "description": "Object representing a Host Group.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "bgpas": { "description": "Object representing a Autonomous System.", "required": true, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" } }, "id": "CBGPASHostGroup", "type": "object" }, "required": false, "id": "CBGPASHostGroups", "type": "array" }, "host_pair_ports": { "description": "Query host_pair_ports. Can be one of GET /reporting/host_pair_ports.", "items": { "description": "One CHostPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairPort", "type": "object" }, "required": false, "id": "CHostPairPorts", "type": "array" }, "dscp_interfaces": { "description": "Query dscp_interfaces. Can be one of GET /reporting/dscp_interfaces.", "items": { "description": "One CDSCPInterface object.", "required": false, "properties": { "interface": { "description": "Interface specification.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dscp": { "description": "DSCP specification.", "required": true, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" } }, "id": "CDSCPInterface", "type": "object" }, "required": false, "id": "CDSCPInterfaces", "type": "array" }, "bgpas": { "description": "Query autonomous system.", "items": { "description": "Object representing a Autonomous System.", "required": false, "properties": { "id": { "description": "Autonomous System Number.", "required": false, "type": "number" }, "name": { "description": "Autonomous System Name.", "required": false, "type": "string" } }, "id": "CBGPAS", "type": "object" }, "required": false, "id": "CBGPASList", "type": "array" }, "role": { "description": "Query role. Can be one of /reporting/roles.", "required": false, "type": "string" }, "show_ttl": { "description": "Query show TTL. Only applicable to flow list report format.", "required": false, "type": "string" }, "group_by": { "description": "Query group_by. Can be one of GET /reporting/group_bys.", "required": false, "type": "string" }, "case_insensitive": { "description": "Query user case insensitivity. Whether to search for users in a case-insensitive fashion.", "required": false, "type": "string" }, "switch_name": { "description": "Query switch name. Can be an IP address or a name.", "required": false, "type": "string" }, "macs": { "description": "Query MAC addresses. Host MAC addresses, only apply to switch_port requests.", "required": false, "type": "string" }, "host_group_type": { "description": "Query host group type. Required for \"host group (gro)\" \"host group pairs (gpp)\" and \"host group pairs with ports (gpr)\" queries.", "required": false, "type": "string" }, "host_pair_app_ports": { "description": "Query host_pair_app_ports. Can be one of GET /reporting/host_pair_app_ports.", "items": { "description": "One CHostPairAppPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "app": { "description": "Application specification.", "required": true, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "server": { "description": "Server host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Client host specification.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPairAppPort", "type": "object" }, "required": false, "id": "CHostPairAppPorts", "type": "array" }, "direction": { "description": "Query direction. Can be one of GET /reporting/directions.", "required": false, "type": "string" }, "users": { "description": "Query time host users. Can be one of GET /reporting/time host user.", "items": { "description": "One CUser object.", "required": false, "properties": { "name": { "description": "Active Directory user name.", "required": true, "type": "string" } }, "id": "CUser", "type": "object" }, "required": false, "id": "CUsers", "type": "array" }, "switch_ports": { "description": "Query switch ports. Switch port addresses.", "required": false, "type": "string" }, "sort_column": { "description": "Query sort column. Can be one of GET /reporting/columns.", "required": false, "type": "number" }, "host_group_pair_ports": { "description": "Query host_group_pair_ports. Can be one of GET /reporting/host_group_pair_ports.", "items": { "description": "One CHostGroupPairPort object.", "required": false, "properties": { "port": { "description": "Port specification.", "required": true, "properties": { "port": { "description": "Port specification.", "required": false, "type": "number" }, "protocol": { "description": "Protocol specification.", "required": false, "type": "number" }, "name": { "description": "Protocol + port combination name.", "required": false, "type": "string" } }, "id": "CProtoPort", "type": "object" }, "server": { "description": "Server host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "client": { "description": "Client host group specification.", "required": true, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" } }, "id": "CHostGroupPairPort", "type": "object" }, "required": false, "id": "CHostGroupPairPorts", "type": "array" }, "network_segments": { "description": "Query network_segments. Can be one of GET /reporting/network_segments.", "items": { "description": "One CNetworkSegment object.", "required": false, "properties": { "src": { "description": "Segment source.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "dst": { "description": "Segment destination.", "required": true, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" } }, "id": "CNetworkSegment", "type": "object" }, "required": false, "id": "CNetworkSegments", "type": "array" }, "macless_ports": { "description": "Query macless ports. Include switch ports without a MAC address.", "required": false, "type": "string" }, "hosts": { "description": "Query hosts. Can be one of GET /reporting/hosts.", "items": { "description": "One CHost object.", "required": false, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "required": false, "id": "CHosts", "type": "array" }, "ignore_dhcp": { "description": "Query ignore DHCP. Use only switch port polling for ARP Bindings.", "required": false, "type": "string" }, "host_pairs": { "description": "Query host pairs. Can be one of GET /reporting/host_pairs.", "items": { "description": "One CHostPair object.", "required": false, "properties": { "server": { "description": "Specification of the server host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" }, "client": { "description": "Specification of the client host.", "required": true, "properties": { "mac": { "description": "Host MAC address.", "required": false, "type": "string" }, "ipaddr": { "description": "Host IP address.", "required": false, "type": "string" }, "name": { "description": "Host name.", "required": false, "type": "string" } }, "id": "CHost", "type": "object" } }, "id": "CHostPair", "type": "object" }, "required": false, "id": "CHostPairs", "type": "array" }, "area": { "description": "Query area. Can be one of GET /reporting/areas.", "required": false, "type": "string" }, "protocols": { "description": "Query protocols. Can be one of GET /reporting/protocols.", "items": { "description": "Object representing Protocol information.", "required": false, "properties": { "id": { "description": "ID of the Protocol.", "required": false, "type": "number" }, "name": { "description": "Name of the Protocol.", "required": false, "type": "string" } }, "id": "CProtocol", "type": "object" }, "required": false, "id": "CProtocols", "type": "array" }, "centricity": { "description": "Query centricity. Can be one of GET /reporting/centricities.", "required": false, "type": "string" }, "limit": { "description": "Query data limit. Maximum number of rows to be returned. Default value: 10000.", "required": false, "type": "number" }, "interfaces": { "description": "Query interfaces. Can be one of GET /reporting/interfaces.", "items": { "description": "One CInterface object.", "required": false, "properties": { "ipaddr": { "description": "Interface IP address.", "required": false, "type": "string" }, "name": { "description": "Interface name.", "required": false, "type": "string" }, "ifindex": { "description": "Interface index.", "required": false, "type": "number" } }, "id": "CInterface", "type": "object" }, "required": false, "id": "CInterfaces", "type": "array" }, "host_groups": { "description": "Query host_groups. Can be one of GET /reporting/host_groups.", "items": { "description": "One CHostGroup object.", "required": false, "properties": { "name": { "description": "Host group name.", "required": false, "type": "string" }, "group_id": { "description": "Host group ID.", "required": false, "type": "number" } }, "id": "CHostGroup", "type": "object" }, "required": false, "id": "CHostGroups", "type": "array" }, "realm": { "description": "Query realm. Can be one of GET /reporting/realms.", "required": true, "type": "string" }, "dscps": { "description": "Query dscps. Can be one of GET /reporting/dscps.", "items": { "description": "One CDSCP object.", "required": false, "properties": { "name": { "description": "DSCP name.", "required": false, "type": "string" }, "code_point": { "description": "DSCP code point.", "required": false, "type": "number" } }, "id": "CDSCP", "type": "object" }, "required": false, "id": "CDSCPs", "type": "array" }, "applications": { "description": "Query applications. Can be one of GET /reporting/applications.", "items": { "description": "One CApplication object.", "required": false, "properties": { "id": { "description": "Application id.", "required": false, "type": "number" }, "code": { "description": "Application code.", "required": false, "type": "string" }, "name": { "description": "Application name.", "required": false, "type": "string" }, "tunneled": { "description": "Flag: is the application tunneled.", "required": false, "type": "string" } }, "id": "CApplication", "type": "object" }, "required": false, "id": "CApplications", "type": "array" } }, "id": "ReportQueryFilter", "type": "object" }, "required": false, "id": "ReportQueryFilters", "type": "array" }, "deprecated": { "description": "Map with legacy criteria attributes that will not be supported soon.", "required": false, "additionalProperties": { "description": "ReportDeprecatedFilters map value.", "required": false, "xmlKeyName": "key", "type": "string" }, "id": "ReportDeprecatedFilters", "type": "object" }, "fast_data_source": { "description": "Options to force using fast (pre-computed) interfaces data. FORCE: force using only fast data. ON: use fast data when possible, fallback to slower traffic query. OFF: never use fast data. By default it is ON.", "required": false, "type": "string", "enum": [ "FORCE", "ON", "OFF" ] } }, "id": "ReportCriteria", "type": "object" }, "timeout": { "description": "Used when doing POST to /reporting/reports/synchronous. Timeout (# of seconds) to wait for the repot to complete, it the report does not complete the operation will return and the client needs to wait for progress.", "required": false, "type": "number" }, "name": { "description": "Report name.", "required": false, "type": "string" }, "template_id": { "description": "Template ID. Can be one of GET /reporting/templates.", "required": true, "type": "number" } }, "id": "ReportInputs", "type": "object", "example": { "criteria": { "time_frame": { "end": 1404247682, "start": 1404246782, "resolution": "1min" }, "queries": [ { "sort_column": 33, "realm": "traffic_summary", "group_by": "hos", "limit": 1000, "columns": [ 5, 33 ] }, { "realm": "traffic_time_series", "columns": [ 33 ], "applications": [ { "name": "WEB" }, { "name": "SSL" } ] }, { "realm": "traffic_overall_time_series", "columns": [ 33 ] } ] }, "template_id": 184 } }, "httpmethod": "POST", "path": "reporting/reports", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing report information.", "properties": { "run_time": { "description": "Time when the report was run (Unix time).", "required": true, "type": "number" }, "error_text": { "description": "A report can be completed with an error. Error message may provide more detailed info.", "required": false, "type": "string" }, "remaining_seconds": { "description": "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.", "required": true, "type": "number" }, "saved": { "description": "Boolean flag indicating if the report was saved.", "required": true, "type": "string" }, "id": { "description": "ID of the report. To be used in the API.", "required": true, "type": "number" }, "status": { "description": "Status of the report.", "required": true, "type": "string", "enum": [ "completed", "running", "waiting" ] }, "percent": { "description": "Progress of the report represented by percentage of report completion.", "required": true, "type": "number" }, "user_id": { "description": "ID of the user who owns the report.", "required": true, "type": "number" }, "size": { "description": "Size of the report in kilobytes.", "required": true, "type": "number" }, "name": { "description": "Name of the report. Could be given by a user or automatically generated by the system.", "required": false, "type": "string" }, "template_id": { "description": "ID of the template that the report is based on.", "required": true, "type": "number" } }, "id": "ReportInfo", "type": "object", "example": { "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 } }, "authorization": "required" } } }, "Host_Group_Types": { "methods": { "Get host group members": { "description": "Get a list of hosts in a specified host group.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting element number." }, "sort": { "required": false, "type": "string", "description": "Sorting direction: 'asc' or 'desc' (default: 'asc')." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "host_group_types/{host_group_type_id}/groups/{group_id}/members", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of host group members.", "items": { "description": "Object representing a host group memeber.", "required": false, "properties": { "idaddr": { "description": "Host group memeber's IP address.", "required": true, "type": "string" } }, "id": "HostGroupMember", "type": "object" }, "id": "HostGroupMembers", "type": "array", "example": [ { "idaddr": "10.99.16.41" }, { "idaddr": "10.99.16.43" } ] }, "authorization": "required" }, "Get host group type": { "description": "Get one host grouping type.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "host_group_types/{host_group_type_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a host group type.", "properties": { "favorite": { "description": "If the host group type is favorite.", "required": true, "type": "string" }, "id": { "description": "Host group type's ID.", "required": true, "type": "number" }, "description": { "description": "Host group type's description.", "required": true, "type": "string" }, "name": { "description": "Host group type's name.", "required": true, "type": "string" }, "type": { "description": "Host group type's type.", "required": true, "type": "string", "enum": [ "User-created", "System-created" ] } }, "id": "HostGroupType", "type": "object", "example": { "favorite": true, "description": "Groups based on the location of their member hosts, such as NY, Dallas, DataCenter1, etc.", "type": "User-created", "name": "ByLocation", "id": 102 } }, "authorization": "required" }, "Get host group": { "description": "Get one host group.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "host_group_types/{host_group_type_id}/groups/{group_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a host group.", "properties": { "id": { "description": "Host group's ID.", "required": true, "type": "number" }, "name": { "description": "Host group's name.", "required": true, "type": "string" } }, "id": "HostGroup", "type": "object", "example": { "name": "Columbus", "id": 6 } }, "authorization": "required" }, "Delete host group type": { "description": "Delete one host grouping type.", "httpmethod": "DELETE", "path": "host_group_types/{host_group_type_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List host group types": { "description": "Get a list of host grouping types.", "parameters": { "favorite": { "required": false, "type": "string", "description": "Show only host grouping types with specific state of the 'favorite' flag." }, "offset": { "required": false, "type": "number", "description": "Starting element number." }, "sortby": { "required": false, "type": "string", "description": "Sorting field name." }, "sort": { "required": false, "type": "string", "description": "Sorting direction: 'asc' or 'desc' (default: 'asc')." }, "type": { "required": false, "type": "string", "description": "Show only host grouping types of type: 'User-created' or 'System-created'." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "host_group_types", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of host group types.", "items": { "description": "Object representing a host group type.", "required": false, "properties": { "favorite": { "description": "If the host group type is favorite.", "required": true, "type": "string" }, "id": { "description": "Host group type's ID.", "required": true, "type": "number" }, "description": { "description": "Host group type's description.", "required": true, "type": "string" }, "name": { "description": "Host group type's name.", "required": true, "type": "string" }, "type": { "description": "Host group type's type.", "required": true, "type": "string", "enum": [ "User-created", "System-created" ] } }, "id": "HostGroupType", "type": "object" }, "id": "HostGroupTypes", "type": "array", "example": [ { "favorite": true, "description": "Groups based on the function of their member hosts, such as Email, Web, etc. ", "type": "User-created", "name": "ByFunction", "id": 100 }, { "favorite": true, "description": "Groups based on the location of their member hosts, such as NY, Dallas, DataCenter1, etc.", "type": "User-created", "name": "ByLocation", "id": 102 } ] }, "authorization": "required" }, "List host groups": { "description": "Get a list of host groups for a given host grouping type.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting element number." }, "sortby": { "required": false, "type": "string", "description": "Sorting field name (default: 'name')." }, "sort": { "required": false, "type": "string", "description": "Sorting direction: 'asc' or 'desc' (default: 'asc')." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "host_group_types/{host_group_type_id}/groups", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of host groups.", "items": { "description": "Object representing a host group.", "required": false, "properties": { "id": { "description": "Host group's ID.", "required": true, "type": "number" }, "name": { "description": "Host group's name.", "required": true, "type": "string" } }, "id": "HostGroup", "type": "object" }, "id": "HostGroups", "type": "array", "example": [ { "name": "Austin", "id": 13 }, { "name": "Columbus", "id": 6 } ] }, "authorization": "required" }, "Get host group type config": { "description": "Get host grouping type configuration.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "host_group_types/{host_group_type_id}/config", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of host group type definitions.", "items": { "description": "Object representing host group type's definition.", "required": false, "properties": { "name": { "description": "Host group type definition's name.", "required": true, "type": "string" }, "cidr": { "description": "Host group type defiintion's CIDRs.", "required": true, "type": "string" } }, "id": "HostGroupTypeDef", "type": "object" }, "id": "HostGroupTypeDefs", "type": "array", "example": [ { "cidr": "10.99.11.0/255.255.255.0", "name": "Seattle" }, { "cidr": "10.99.12.0/255.255.255.0", "name": "LosAngeles" } ] }, "authorization": "required" }, "Get favorite flag": { "description": "Get favorite flag.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "host_group_types/{host_group_type_id}/favorite", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a host group type favorite flag.", "properties": { "favorite": { "description": "Favorite flag.", "required": true, "type": "string" } }, "id": "HostGroupTypeFavorite", "type": "object", "example": { "favorite": true } }, "authorization": "required" }, "Create host group type": { "description": "Create a new host grouping type.", "formats": [ "xml", "json" ], "request": { "description": "Object representing a new host group type.", "properties": { "favorite": { "description": "If new host group type is favorite.", "required": true, "type": "string" }, "config": { "description": "Optional configuration of the grouptype.", "items": { "description": "Object representing host group type's definition.", "required": false, "properties": { "name": { "description": "Host group type definition's name.", "required": true, "type": "string" }, "cidr": { "description": "Host group type defiintion's CIDRs.", "required": true, "type": "string" } }, "id": "HostGroupTypeDef", "type": "object" }, "required": false, "id": "HostGroupTypeDefs", "type": "array" }, "description": { "description": "New host group type's description.", "required": true, "type": "string" }, "name": { "description": "New host group type's name.", "required": true, "type": "string" } }, "id": "HostGroupTypeUp", "type": "object", "example": { "favorite": true, "name": "ByLocation", "description": "Groups based on the location of their member hosts, such as NY, Dallas, DataCenter1, etc." } }, "httpmethod": "POST", "path": "host_group_types", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing a new host group type.", "properties": { "favorite": { "description": "If new host group type is favorite.", "required": true, "type": "string" }, "config": { "description": "Optional configuration of the grouptype.", "items": { "description": "Object representing host group type's definition.", "required": false, "properties": { "name": { "description": "Host group type definition's name.", "required": true, "type": "string" }, "cidr": { "description": "Host group type defiintion's CIDRs.", "required": true, "type": "string" } }, "id": "HostGroupTypeDef", "type": "object" }, "required": false, "id": "HostGroupTypeDefs", "type": "array" }, "description": { "description": "New host group type's description.", "required": true, "type": "string" }, "name": { "description": "New host group type's name.", "required": true, "type": "string" } }, "id": "HostGroupTypeUp", "type": "object", "example": { "favorite": true, "name": "ByLocation", "description": "Groups based on the location of their member hosts, such as NY, Dallas, DataCenter1, etc." } }, "authorization": "required" }, "Set host group type config": { "description": "Update host grouping type configuration.", "request": { "description": "List of host group type definitions.", "items": { "description": "Object representing host group type's definition.", "required": false, "properties": { "name": { "description": "Host group type definition's name.", "required": true, "type": "string" }, "cidr": { "description": "Host group type defiintion's CIDRs.", "required": true, "type": "string" } }, "id": "HostGroupTypeDef", "type": "object" }, "id": "HostGroupTypeDefs", "type": "array", "example": [ { "cidr": "10.99.11.0/255.255.255.0", "name": "Seattle" }, { "cidr": "10.99.12.0/255.255.255.0", "name": "LosAngeles" } ] }, "httpmethod": "PUT", "path": "host_group_types/{host_group_type_id}/config", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Update host group type": { "description": "Update one host grouping type.", "request": { "description": "Object representing a new host group type.", "properties": { "favorite": { "description": "If new host group type is favorite.", "required": true, "type": "string" }, "config": { "description": "Optional configuration of the grouptype.", "items": { "description": "Object representing host group type's definition.", "required": false, "properties": { "name": { "description": "Host group type definition's name.", "required": true, "type": "string" }, "cidr": { "description": "Host group type defiintion's CIDRs.", "required": true, "type": "string" } }, "id": "HostGroupTypeDef", "type": "object" }, "required": false, "id": "HostGroupTypeDefs", "type": "array" }, "description": { "description": "New host group type's description.", "required": true, "type": "string" }, "name": { "description": "New host group type's name.", "required": true, "type": "string" } }, "id": "HostGroupTypeUp", "type": "object", "example": { "favorite": true, "name": "ByLocation", "description": "Groups based on the location of their member hosts, such as NY, Dallas, DataCenter1, etc." } }, "httpmethod": "PUT", "path": "host_group_types/{host_group_type_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Update favorite flag": { "description": "Update favorite flag.", "request": { "description": "Object representing a host group type favorite flag.", "properties": { "favorite": { "description": "Favorite flag.", "required": true, "type": "string" } }, "id": "HostGroupTypeFavorite", "type": "object", "example": { "favorite": true } }, "httpmethod": "PUT", "path": "host_group_types/{host_group_type_id}/favorite", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" } } }, "Applications": { "methods": { "Get application": { "description": "Get configuration of a specific application.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "applications/{application_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "Object representing an application.", "properties": { "enabled": { "description": "if the application enabled.", "required": true, "type": "string" }, "id": { "description": "Application's ID.", "required": true, "type": "number" }, "name": { "description": "Application's name.", "required": true, "type": "string" }, "priority": { "description": "Application's priority.", "required": true, "type": "number" }, "sources": { "description": "Application's sources.", "items": { "description": "Object representing an application source ID.", "required": false, "properties": { "id": { "description": "ID of application source's ID.", "required": true, "type": "number" } }, "id": "ApplicationSourceId", "type": "object" }, "required": true, "id": "ApplicationSourceIds", "type": "array" } }, "id": "Application", "type": "object" }, "authorization": "required" }, "Get application sources": { "description": "List all application sources.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting element number." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "applications/sources", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of application sources.", "items": { "description": "Object representing an application sources.", "required": false, "properties": { "id": { "description": "Application source's ID.", "required": true, "type": "number" }, "name": { "description": "Application source's name.", "required": true, "type": "string" } }, "id": "ApplicationSource", "type": "object" }, "id": "ApplicationSources", "type": "array", "example": [ { "name": "Sensor", "id": 100 }, { "name": "Shark", "id": 3 }, { "name": "Steelhead", "id": 2 } ] }, "authorization": "required" }, "List applications": { "description": "Get a list of all supported applications.", "parameters": { "enabled": { "required": false, "type": "string", "description": "Show only enabled or disabled applications (use 'true' or 'false')." }, "offset": { "required": false, "type": "number", "description": "Starting element number." }, "sortby": { "required": false, "type": "string", "description": "Sorting field name (default: 'name')." }, "sort": { "required": false, "type": "string", "description": "Sorting direction: 'asc' or 'desc' (default: 'asc')." }, "sources": { "required": false, "type": "string", "description": "Filter the applications by source ID." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "applications", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of applications.", "items": { "description": "Object representing an application.", "required": false, "properties": { "enabled": { "description": "if the application enabled.", "required": true, "type": "string" }, "id": { "description": "Application's ID.", "required": true, "type": "number" }, "name": { "description": "Application's name.", "required": true, "type": "string" }, "priority": { "description": "Application's priority.", "required": true, "type": "number" }, "sources": { "description": "Application's sources.", "items": { "description": "Object representing an application source ID.", "required": false, "properties": { "id": { "description": "ID of application source's ID.", "required": true, "type": "number" } }, "id": "ApplicationSourceId", "type": "object" }, "required": true, "id": "ApplicationSourceIds", "type": "array" } }, "id": "Application", "type": "object" }, "id": "Applications", "type": "array", "example": [] }, "authorization": "required" } } }, "Port_Names": { "methods": { "Update port names": { "description": "Update system port names.", "request": { "description": "List of port name definitions.", "items": { "description": "Object representing port name definitions.", "required": false, "properties": { "port": { "description": "Port name's port.", "required": true, "type": "number" }, "protocol": { "description": "Port name's protocol.", "required": true, "type": "number" }, "name": { "description": "Port name's name.", "required": true, "type": "string" } }, "id": "CPortNameDef", "type": "object" }, "id": "CPortNameDefs", "type": "array", "example": [ { "protocol": 6, "name": "smtp", "port": 25 }, { "protocol": 6, "name": "nsw-fe", "port": 27 } ] }, "httpmethod": "PUT", "path": "port_names", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "List port names": { "description": "Get the system port names.", "parameters": { "offset": { "required": false, "type": "number", "description": "Starting element number." }, "name": { "required": false, "type": "string", "description": "Filter port names by the name specified." }, "limit": { "required": false, "type": "number", "description": "Number of rows to be returned." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "port_names", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of PortNames objects.", "items": { "description": "Object representing port name information.", "required": false, "properties": { "port": { "description": "Port name's port.", "required": true, "type": "number" }, "server_port": { "description": "Defined as server port.", "required": true, "type": "string" }, "protocol": { "description": "Port name's protocol.", "required": true, "type": "number" }, "avg_bytes_ps": { "description": "Speed information of port name.", "required": true, "type": "number" }, "name": { "description": "Port name's name.", "required": true, "type": "string" }, "grouped": { "description": "Used in port groups.", "required": true, "type": "string" } }, "id": "CPortName", "type": "object" }, "id": "CPortNames", "type": "array", "example": [ { "protocol": 6, "name": "smtp", "grouped": false, "server_port": true, "avg_bytes_ps": 32767, "port": 25 }, { "protocol": 6, "name": "nsw-fe", "grouped": false, "server_port": false, "avg_bytes_ps": 32767, "port": 27 } ] }, "authorization": "required" } } }, "System": { "methods": { "Start all processes (one module)": { "description": "Start all system processes on one module on Enterprise systems. The operation is asynchronous. Use \"GET system/{module}/status\" to poll for status. The {module} can be either the IP Address or the module name.", "httpmethod": "POST", "path": "system/{module}/start", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get status of all processes": { "description": "Get status of all system processes. On Enterprise systems, get system process statuses on all modules.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "system/status", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "SystemStatus object.", "items": { "description": "SystemProcess object.", "required": false, "properties": { "process_id": { "description": "Process ID.", "required": false, "type": "string" }, "process_name": { "description": "Process name.", "required": true, "type": "string" }, "module_name": { "description": "Module name. Available on Enterprise systems only.", "required": false, "type": "string" }, "status": { "description": "Process status.", "required": true, "type": "string", "enum": [ "Running", "Stopped" ] }, "module_ipaddr": { "description": "Module IP address. Available on Enterprise systems only.", "required": false, "type": "string" } }, "id": "SystemProcess", "type": "object" }, "id": "SystemStatus", "type": "array", "example": [ { "process_id": "25096", "process_name": "memmonitor", "status": "Running" }, { "process_name": "healthd", "status": "Stopped" }, { "process_id": "25092", "process_name": "diskmon", "status": "Running" }, { "process_id": "25123", "process_name": "dispatcher", "status": "Running" }, { "process_name": "analyzer", "status": "Stopped" } ] }, "authorization": "required" }, "Kill all processes": { "description": "Kill all system processes. The operation is asynchronous. Use \"GET system/status\" to poll for status. On Enterprise systems, kill system processes on all modules. Warning: this operation can result in data being corrupted.", "httpmethod": "POST", "path": "system/kill", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Restart all processes": { "description": "Restart all system processes. The operation is asynchronous. Use \"GET system/status\" to poll for status. On Enterprise systems, stop system processes on all modules.", "httpmethod": "POST", "path": "system/restart", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Start all processes": { "description": "Start all system processes. The operation is asynchronous. Use \"GET system/status\" to poll for status. On Enterprise systems, start system processes on all modules.", "httpmethod": "POST", "path": "system/start", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Restart all processes (one module)": { "description": "Restart all system processes on one module on Enterprise systems. The operation is asynchronous. Use \"GET system/{module}/status\" to poll for status. The {module} can be either the IP Address or the module name.", "httpmethod": "POST", "path": "system/{module}/restart", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Stop all processes (one module)": { "description": "Stop all system processes on one module on Enterprise systems. The operation is asynchronous. Use \"GET system/{module}/status\" to poll for status. The {module} can be either the IP Address or the module name.", "httpmethod": "POST", "path": "system/{module}/stop", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get status of all processes (one module)": { "description": "Get status of all system processes on one module on Enterprise systems. The {module} can be either the IP Address or the module name.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "system/{module}/status", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "SystemStatus object.", "items": { "description": "SystemProcess object.", "required": false, "properties": { "process_id": { "description": "Process ID.", "required": false, "type": "string" }, "process_name": { "description": "Process name.", "required": true, "type": "string" }, "module_name": { "description": "Module name. Available on Enterprise systems only.", "required": false, "type": "string" }, "status": { "description": "Process status.", "required": true, "type": "string", "enum": [ "Running", "Stopped" ] }, "module_ipaddr": { "description": "Module IP address. Available on Enterprise systems only.", "required": false, "type": "string" } }, "id": "SystemProcess", "type": "object" }, "id": "SystemStatus", "type": "array", "example": [ { "process_id": "25096", "process_name": "memmonitor", "status": "Running" }, { "process_name": "healthd", "status": "Stopped" }, { "process_id": "25092", "process_name": "diskmon", "status": "Running" }, { "process_id": "25123", "process_name": "dispatcher", "status": "Running" }, { "process_name": "analyzer", "status": "Stopped" } ] }, "authorization": "required" }, "Shutdown": { "description": "Shutdown the system. The operation is asynchronous.", "httpmethod": "POST", "path": "system/shutdown", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Reboot": { "description": "Reboot the system. The operation is asynchronous.", "httpmethod": "POST", "path": "system/reboot", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Stop all processes": { "description": "Stop all system processes. The operation is asynchronous. Use \"GET system/status\" to poll for status. On Enterprise systems, stop system processes on all modules.", "httpmethod": "POST", "path": "system/stop", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Kill all processes (one module)": { "description": "Kill all system processes on one module on Enterprise systems. The operation is asynchronous. Use \"GET system/{module}/status\" to poll for status. The {module} can be either the IP Address or the module name. Warning: this operation can result in data being corrupted.", "httpmethod": "POST", "path": "system/{module}/kill", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" } } }, "Users": { "methods": { "List users": { "description": "Get a list of user accounts.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "users", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "List of user accounts on the system.", "items": { "description": "User account.", "required": false, "properties": { "enabled": { "description": "Boolean flag indicating if the user account is enabled.", "required": true, "type": "string" }, "last_name": { "description": "Last name of the user.", "required": true, "type": "string" }, "id": { "description": "Numeric ID of the user that the system uses internally and in the API.", "required": true, "type": "number" }, "last_login": { "description": "Time of last login. Unix time (epoch).", "required": true, "type": "number" }, "authentication_type": { "description": "Type of authentication for the user, such as Local or RADIUS.", "required": true, "type": "string", "enum": [ "Local", "Remote" ] }, "username": { "description": "User name (short name) that identifies the user to the system, such as 'admin'.", "required": true, "type": "string" }, "authorization_type": { "description": "Type of authorization for the user, such as Local or RADIUS.", "required": true, "type": "string", "enum": [ "Local", "Remote" ] }, "role": { "description": "Role of the user. Defines permissions.", "required": true, "type": "string", "enum": [ "Developer", "Administrator", "Operator", "Monitor", "Event_Viewer", "Dashboard_Viewer", "Restricted" ] }, "first_name": { "description": "First name of the user.", "required": true, "type": "string" }, "traffic_filter": { "description": "Traffic expression. Only applicable to Restricted role.", "required": false, "type": "string" }, "last_access": { "description": "Time of last access to the system. Unix time (epoch).", "required": true, "type": "number" }, "view_packet_details": { "description": "Boolean flag indicating if the user has access to packet data.", "required": false, "type": "string" }, "last_authentication": { "description": "Time of last authentication. Unix time (epoch).", "required": true, "type": "number" }, "view_user_information": { "description": "Boolean flag indicating if the user has access to identity information, such as Active Directory information.", "required": false, "type": "string" }, "login_timeout": { "description": "Timeout (in seconds) during which the user cannot log in to the system because of security policies.", "required": true, "type": "number" } }, "id": "User", "type": "object" }, "id": "Users", "type": "array", "example": [ { "username": "admin", "last_authentication": 1352313328, "first_name": "Jonh", "last_name": "Smith", "authorization_type": "Local", "enabled": true, "id": 123, "authentication_type": "Local", "last_login": 1352313328, "login_timeout": 900, "view_user_information": true, "role": "Administrator", "last_access": 1352313328 }, { "username": "admin2", "last_authentication": 1352313328, "first_name": "Mark", "last_name": "Greg", "authorization_type": "Local", "enabled": true, "id": 124, "authentication_type": "Local", "last_login": 1352313328, "login_timeout": 900, "view_user_information": true, "role": "Administrator", "last_access": 1352313328 } ] }, "authorization": "required" }, "Re-authenticate user": { "description": "Re-authenticate user account. Requires basic authentication.", "httpmethod": "GET", "path": "users/re_authenticate", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "authorization": "required" }, "Get user": { "description": "User account by user ID.", "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "users/{user_id}", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "User account.", "properties": { "enabled": { "description": "Boolean flag indicating if the user account is enabled.", "required": true, "type": "string" }, "last_name": { "description": "Last name of the user.", "required": true, "type": "string" }, "id": { "description": "Numeric ID of the user that the system uses internally and in the API.", "required": true, "type": "number" }, "last_login": { "description": "Time of last login. Unix time (epoch).", "required": true, "type": "number" }, "authentication_type": { "description": "Type of authentication for the user, such as Local or RADIUS.", "required": true, "type": "string", "enum": [ "Local", "Remote" ] }, "username": { "description": "User name (short name) that identifies the user to the system, such as 'admin'.", "required": true, "type": "string" }, "authorization_type": { "description": "Type of authorization for the user, such as Local or RADIUS.", "required": true, "type": "string", "enum": [ "Local", "Remote" ] }, "role": { "description": "Role of the user. Defines permissions.", "required": true, "type": "string", "enum": [ "Developer", "Administrator", "Operator", "Monitor", "Event_Viewer", "Dashboard_Viewer", "Restricted" ] }, "first_name": { "description": "First name of the user.", "required": true, "type": "string" }, "traffic_filter": { "description": "Traffic expression. Only applicable to Restricted role.", "required": false, "type": "string" }, "last_access": { "description": "Time of last access to the system. Unix time (epoch).", "required": true, "type": "number" }, "view_packet_details": { "description": "Boolean flag indicating if the user has access to packet data.", "required": false, "type": "string" }, "last_authentication": { "description": "Time of last authentication. Unix time (epoch).", "required": true, "type": "number" }, "view_user_information": { "description": "Boolean flag indicating if the user has access to identity information, such as Active Directory information.", "required": false, "type": "string" }, "login_timeout": { "description": "Timeout (in seconds) during which the user cannot log in to the system because of security policies.", "required": true, "type": "number" } }, "id": "User", "type": "object", "example": { "username": "admin", "last_authentication": 1352313328, "first_name": "Jonh", "last_name": "Smith", "authorization_type": "Local", "enabled": true, "id": 123, "authentication_type": "Local", "last_login": 1352313328, "login_timeout": 900, "view_user_information": true, "role": "Administrator", "last_access": 1352313328 } }, "authorization": "required" }, "Test RADIUS user": { "description": "Test a RADIUS user.", "parameters": { "password": { "required": true, "type": "string", "description": "RADIUS password." }, "username": { "required": true, "type": "string", "description": "RADIUS username." } }, "formats": [ "xml", "json" ], "request": { "description": "RemoteTestUserRequest object.", "properties": { "password": { "description": "password.", "required": true, "type": "string" }, "username": { "description": "user name.", "required": true, "type": "string" } }, "id": "RemoteTestUserRequest", "type": "object", "example": { "username": "testusername", "password": "testpassword" } }, "httpmethod": "POST", "path": "users/radius/test_user", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "RemoteTestUserResponse object.", "properties": { "role_id": { "description": "Matched role ID.", "required": true, "type": "number" }, "error_message": { "description": "Error message.", "required": true, "type": "string" }, "permission": { "description": "Matched permission name.", "required": true, "type": "string" }, "server_type": { "description": "Indicates the type of the server being tested: RADIUS(2) or TACACS+(3).", "required": true, "type": "number" }, "role": { "description": "Matched role name.", "required": true, "type": "string" }, "details": { "description": "Remote user test details.", "required": true, "type": "string" }, "permission_id": { "description": "Matched permission ID.", "required": true, "type": "string" }, "server_ip": { "description": "Remote Server IP address.", "required": true, "type": "string" }, "authenticated": { "description": "Flag indicating if the remote user was authenticated.", "required": true, "type": "string" }, "attributes": { "description": "Attributes of Remote Test User Response.", "items": { "description": "Remote attribute.", "required": false, "additionalProperties": { "description": "Remote attribute value.", "required": false, "xmlKeyName": "name", "type": "string" }, "id": "RemoteAttributes", "type": "object" }, "required": false, "id": "RemoteAttributesList", "type": "array" }, "authorized": { "description": "Flag indicating if the remote user was authorized (as Administrator, Monitor, etc).", "required": true, "type": "string" } }, "id": "RemoteTestUserResponse", "type": "object", "example": { "error_message": "", "authenticated": true, "server_type": 2, "permission_id": "", "permission": "", "role_id": 0, "role": "", "authorized": false, "server_ip": "10.38.128.112:1812", "attributes": [ { "25": "operatorClass" }, { "25": "monitorClass" }, { "25": "eventviewerClass" }, { "17164": "unMappedRole" }, { "17164": "monitorCascade" }, { "17164": "eventviewerCascade" }, { "17164": "dashboardCascade" }, { "25": "DBAccess" }, { "25": "dashboardClass" }, { "17164": "AbC10~!@#$%^&*()_+{}|[]:;<>?/.'z" }, { "17164": "operatorCascade" }, { "LOGIN_SERVER": "10.38.128.112:1812" }, { "25": "adminClass1" }, { "25": "unMappedClass" }, { "25": "eventviewerClass" }, { "17164": "adminCascade" } ], "details": "Using 10.38.128.112:1812 - Unable to match a role." } }, "authorization": "required" }, "Test TACACS+ server": { "description": "Test the connection to a TACACS+ server.", "parameters": { "port": { "required": false, "type": "string", "description": "TACACS+ server port number." }, "server": { "required": true, "type": "string", "description": "TACACS+ server identifier, either an IP or hostname." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "users/tacacs/test_server", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "RemoteTestServerResponse object.", "properties": { "success": { "description": "Flag indicating if the remote server test was successful.", "required": true, "type": "string" }, "message": { "description": "Response message.", "required": true, "type": "string" } }, "id": "RemoteTestServerResponse", "type": "object", "example": { "message": "Connection attempt succeeded", "success": true } }, "authorization": "required" }, "Test TACACS+ user": { "description": "Test a TACACS+ user.", "parameters": { "password": { "required": true, "type": "string", "description": "TACACS+ password." }, "username": { "required": true, "type": "string", "description": "TACACS+ username." } }, "formats": [ "xml", "json" ], "request": { "description": "RemoteTestUserRequest object.", "properties": { "password": { "description": "password.", "required": true, "type": "string" }, "username": { "description": "user name.", "required": true, "type": "string" } }, "id": "RemoteTestUserRequest", "type": "object", "example": { "username": "testusername", "password": "testpassword" } }, "httpmethod": "POST", "path": "users/tacacs/test_user", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "RemoteTestUserResponse object.", "properties": { "role_id": { "description": "Matched role ID.", "required": true, "type": "number" }, "error_message": { "description": "Error message.", "required": true, "type": "string" }, "permission": { "description": "Matched permission name.", "required": true, "type": "string" }, "server_type": { "description": "Indicates the type of the server being tested: RADIUS(2) or TACACS+(3).", "required": true, "type": "number" }, "role": { "description": "Matched role name.", "required": true, "type": "string" }, "details": { "description": "Remote user test details.", "required": true, "type": "string" }, "permission_id": { "description": "Matched permission ID.", "required": true, "type": "string" }, "server_ip": { "description": "Remote Server IP address.", "required": true, "type": "string" }, "authenticated": { "description": "Flag indicating if the remote user was authenticated.", "required": true, "type": "string" }, "attributes": { "description": "Attributes of Remote Test User Response.", "items": { "description": "Remote attribute.", "required": false, "additionalProperties": { "description": "Remote attribute value.", "required": false, "xmlKeyName": "name", "type": "string" }, "id": "RemoteAttributes", "type": "object" }, "required": false, "id": "RemoteAttributesList", "type": "array" }, "authorized": { "description": "Flag indicating if the remote user was authorized (as Administrator, Monitor, etc).", "required": true, "type": "string" } }, "id": "RemoteTestUserResponse", "type": "object", "example": { "error_message": "", "authenticated": true, "server_type": 2, "permission_id": "", "permission": "", "role_id": 0, "role": "", "authorized": false, "server_ip": "10.38.128.112:1812", "attributes": [ { "25": "operatorClass" }, { "25": "monitorClass" }, { "25": "eventviewerClass" }, { "17164": "unMappedRole" }, { "17164": "monitorCascade" }, { "17164": "eventviewerCascade" }, { "17164": "dashboardCascade" }, { "25": "DBAccess" }, { "25": "dashboardClass" }, { "17164": "AbC10~!@#$%^&*()_+{}|[]:;<>?/.'z" }, { "17164": "operatorCascade" }, { "LOGIN_SERVER": "10.38.128.112:1812" }, { "25": "adminClass1" }, { "25": "unMappedClass" }, { "25": "eventviewerClass" }, { "17164": "adminCascade" } ], "details": "Using 10.38.128.112:1812 - Unable to match a role." } }, "authorization": "required" }, "Test RADIUS server": { "description": "Test the connection to a RADIUS server.", "parameters": { "port": { "required": false, "type": "string", "description": "RADIUS server port number." }, "server": { "required": true, "type": "string", "description": "RADIUS server identifier, either an IP or hostname." } }, "formats": [ "xml", "json" ], "httpmethod": "GET", "path": "users/radius/test_server", "authorization_methods": [ "BASIC", "COOKIE", "OAUTH_2_0" ], "response": { "description": "RemoteTestServerResponse object.", "properties": { "success": { "description": "Flag indicating if the remote server test was successful.", "required": true, "type": "string" }, "message": { "description": "Response message.", "required": true, "type": "string" } }, "id": "RemoteTestServerResponse", "type": "object", "example": { "message": "Connection attempt succeeded", "success": true } }, "authorization": "required" } } } }, "name": "profiler" }