perf_custom_dashboard

Last published : Aug 10, 2026
Configuration for Custom Dashboard for Network reports resource.
Related information

Properties

(click to see Operations )
Name Data Type Permissions Description
device_family <String> Read-write Device Family of which this custom dashboard belongs to.
name <String> Read-write name. Minimum length = 1 Maximum length = 128
description <String> Read-write Custom dashboard description.
no_of_columns <Integer> Read-write No of columns in dashboard. Minimum value = 1 Maximum value =
timestamp <Double> Read-write timestamp in seconds.
entity_type <String> Read-write Entity Type.
id <String> Read-write Id is system generated key for all the perf custom dashboard configuration . Maximum length = 256
agg_level <String> Read-write Aggregation Level.
entities_array <String[]> Read-write Entities (Virtual servers or Network Interfaces).
coordinates_array <String[]> Read-write Co-ordinates in array.
instances_array <String[]> Read-write Instances in array.
report_names_array <String[]> Read-write Report names in array.
report_names <String> Read-only Report Names.
coordinates <String> Read-only Co-ordinates.
instances <String> Read-only Instances.
entities <String> Read-only Entities(virtual servers or network interfaces).

Operations

(click to see Properties )
  • ADD
  • DELETE
  • GET (ALL)
  • GET
  • UPDATE
Some options that you can use for each operations:
  • Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:
    http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes
    If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
  • Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,
    To do this, you must specify the username and password in the request header of the NITRO request as follows:
    X-NITRO-USER: <username>
    X-NITRO-PASS: <password>
    Note: In such cases, make sure that the request header DOES not include the following:
    Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
*Note: * Mandatory parameters are marked in red and placeholder content is marked in green
The following parameters can be used in the nitro request : onerror <String_value>
Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.
Default value: EXIT
Possible values = EXIT, CONTINUE

add

URL: https://<MGMT-IP>/nitro/v2/config/perf_custom_dashboard?onerror=<String_value> HTTPS Method: POST
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"perf_custom_dashboard": {
"report_names_array":<String_value[]>,
"name":<String_value>,
"description":<String_value>,
"timestamp":<Double_value>,
"instances_array":<String_value[]>,
"id":<String_value>,
"entities_array":<String_value[]>,
"device_family":<String_value>,
"entity_type":<String_value>,
"agg_level":<String_value>,
"coordinates_array":<String_value[]>,
"no_of_columns":<Integer_value>}}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "perf_custom_dashboard":[{
"report_names":<String_value>,
"coordinates":<String_value>,
"instances":<String_value>,
"device_family":<String_value>,
"name":<String_value>,
"description":<String_value>,
"entities":<String_value>,
"no_of_columns":<Integer_value>,
"timestamp":<Double_value>,
"entity_type":<String_value>,
"id":<String_value>,
"agg_level":<String_value>,
"entities_array":<String_value>,
"coordinates_array":<String_value>,
"instances_array":<String_value>,
"report_names_array":<String_value>}]}

delete

URL: https://<MGMT-IP>/nitro/v2/config/perf_custom_dashboard/id_value<String> HTTPS Method: DELETE
Request Headers: X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt }

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/perf_custom_dashboard Query-parameters:
filter https://<MGMT-IP>/nitro/v2/config/perf_custom_dashboard ?filter=property-name1:property-value1,property-name2:property-value2 Use this query-parameter to get the filtered set of perf_custom_dashboard resources configured on the system. You can set a filter on any property of the resource.
pagesize=#no;pageno=#no https://<MGMT-IP>/nitro/v2/config/perf_custom_dashboard ?pagesize=#no;pageno=#no Use this query-parameter to get the perf_custom_dashboard resources in chunks.
count https://<MGMT-IP>/nitro/v2/config/perf_custom_dashboard ?count=yes Use this query-parameter to get the count of perf_custom_dashboard resources.
HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "perf_custom_dashboard":[{
"report_names":<String_value>,
"coordinates":<String_value>,
"instances":<String_value>,
"device_family":<String_value>,
"name":<String_value>,
"description":<String_value>,
"entities":<String_value>,
"no_of_columns":<Integer_value>,
"timestamp":<Double_value>,
"entity_type":<String_value>,
"id":<String_value>,
"agg_level":<String_value>,
"entities_array":<String_value>,
"coordinates_array":<String_value>,
"instances_array":<String_value>,
"report_names_array":<String_value>}]}

get

URL: https://<MGMT-IP>/nitro/v2/config/perf_custom_dashboard/id_value<String> HTTPS Method: GET
Request Headers: Accept: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Headers:
Content-Type:application/json
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "perf_custom_dashboard":[{
"report_names":<String_value>,
"coordinates":<String_value>,
"instances":<String_value>,
"device_family":<String_value>,
"name":<String_value>,
"description":<String_value>,
"entities":<String_value>,
"no_of_columns":<Integer_value>,
"timestamp":<Double_value>,
"entity_type":<String_value>,
"id":<String_value>,
"agg_level":<String_value>,
"entities_array":<String_value>,
"coordinates_array":<String_value>,
"instances_array":<String_value>,
"report_names_array":<String_value>}]}

update

URL: https://<MGMT-IP>/nitro/v2/config/perf_custom_dashboard/id_value<String> HTTPS Method: PUT
Request Headers: Content-Type: application/json
X-NITRO-USER:username_value<String>
X-NITRO-PASS:password_value<String>
or
Cookie:NITRO_AUTH_TOKEN=token_value<String>
Request Payload:
{"perf_custom_dashboard":{
<b>"id":<String_value></b>,
"report_names_array":<String_value[]>,
"name":<String_value>,
"description":<String_value>,
"timestamp":<Double_value>,
"instances_array":<String_value[]>,
"entities_array":<String_value[]>,
"device_family":<String_value>,
"entity_type":<String_value>,
"agg_level":<String_value>,
"coordinates_array":<String_value[]>,
"no_of_columns":<Integer_value>}}
Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error
Response Payload:
{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "perf_custom_dashboard":[{
"report_names":<String_value>,
"coordinates":<String_value>,
"instances":<String_value>,
"device_family":<String_value>,
"name":<String_value>,
"description":<String_value>,
"entities":<String_value>,
"no_of_columns":<Integer_value>,
"timestamp":<Double_value>,
"entity_type":<String_value>,
"id":<String_value>,
"agg_level":<String_value>,
"entities_array":<String_value>,
"coordinates_array":<String_value>,
"instances_array":<String_value>,
"report_names_array":<String_value>}]}