44 lines
36 KiB
HTML
44 lines
36 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
|
|
<link href="../../../rdx/css/rdx.css" rel="stylesheet" type="text/css" />
|
|
<link href="../../../index.css" rel="stylesheet" type="text/css" />
|
|
<title>mpsgroup</title>
|
|
</head>
|
|
<body class="ns_body">
|
|
<p class="ns_wp_header">mpsgroup</p>
|
|
<P>Configuration for System Groups resource.</P>
|
|
<p class="heading">Read/write properties</p>
|
|
<p class="property_name">apply_all_bound_entities<span class="property_type"><Boolean></span></p><p class="property_description">Apply for all bound entities (TRUE|FALSE).</p>
|
|
<p class="property_name">role<span class="property_type"><String></span></p><p class="property_description">Role (admin|nonadmin).</p>
|
|
<p class="property_name">authscope_props<span class="property_type"><rba_authscope_props[]></span></p><p class="property_description">Authorized Scope Properties.</p>
|
|
<p class="property_name">session_timeout<span class="property_type"><Integer></span></p><p class="property_description">Session timeout for the Group.</p>
|
|
<p class="property_name">assign_all_apps<span class="property_type"><Boolean></span></p><p class="property_description">Assign All Applications (YES|NO).</p>
|
|
<p class="property_name">name<span class="property_type"><String></span></p><p class="property_description">Group Name.<br> Minimum length = 1<br> Maximum length = 64</p>
|
|
<p class="property_name">bound_entity_selected<span class="property_type"><Integer></span></p><p class="property_description">Which bound entiy is selected VSERVER(0),SERVICE(1),SERVICEGROUP(2),SERVER(3).</p>
|
|
<p class="property_name">user_session_limit<span class="property_type"><Integer></span></p><p class="property_description">Number of session(s) limited per user part of this group.<br> Minimum value = 1<br> Maximum value = </p>
|
|
<p class="property_name">enable_session_timeout<span class="property_type"><Boolean></span></p><p class="property_description">Enables session timeout for group.</p>
|
|
<p class="property_name">assign_all_selected_device_apps<span class="property_type"><Boolean></span></p><p class="property_description">Assign All Application from selected instances (YES|NO).</p>
|
|
<p class="property_name">tenant_id<span class="property_type"><String></span></p><p class="property_description">Id of the tenant.<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">select_individual_entity<span class="property_type"><Boolean></span></p><p class="property_description">Select Individual Entity Type.</p>
|
|
<p class="property_name">assign_all_devices<span class="property_type"><Boolean></span></p><p class="property_description">Assign All Instances (YES|NO).</p>
|
|
<p class="property_name">assign_all_autoscale_groups<span class="property_type"><Boolean></span></p><p class="property_description">Assign All Autoscale groups (YES|NO).</p>
|
|
<p class="property_name">session_timeout_unit<span class="property_type"><String></span></p><p class="property_description">Session timeout unit for the Group.</p>
|
|
<p class="property_name">description<span class="property_type"><String></span></p><p class="property_description">Description of Group.<br> Minimum length = 1<br> Maximum length = 1024</p>
|
|
<p class="property_name">allow_application_only<span class="property_type"><Boolean></span></p><p class="property_description">Checks if only application centic page is needed.</p>
|
|
<p class="property_name">permission<span class="property_type"><String></span></p><p class="property_description">Permission for the group (admin/read-only).<br> Minimum length = 1<br> Maximum length = 128</p>
|
|
<p class="property_name">id<span class="property_type"><String></span></p><p class="property_description">Id is system generated key for all the system groups.</p>
|
|
<p class="property_name">users<span class="property_type"><String[]></span></p><p class="property_description">Users belong to the group.</p>
|
|
<p class="property_name">application_names<span class="property_type"><String[]></span></p><p class="property_description">All Application names that are part of this group.This includes selected appnames as well as applications which are result of defined regex.</p>
|
|
<p class="property_name">roles<span class="property_type"><String[]></span></p><p class="property_description">Roles assigned to the group.</p>
|
|
<p class="property_name">autoscale_groups_id<span class="property_type"><String[]></span></p><p class="property_description">Autoscale groups belong to this groupp.</p>
|
|
<p class="property_name">standalone_instances_id<span class="property_type"><String[]></span></p><p class="property_description">Stand alone instances belong to this groupp.</p>
|
|
<p class="heading">Read only properties</p>
|
|
<p class="property_name">application_names_with_regex<span class="property_type"><String[]></span></p><p class="property_description">Application names defined with regex that are part of this group.</p>
|
|
<p class="property_name">application_names_without_regex<span class="property_type"><String[]></span></p><p class="property_description">selected application names that are part of this group.</p>
|
|
<p class="heading">Operations</p><p class="property_name">NOTE: In request payload, Mandatory parameters are marked red and bold.<br /><br />The following parameters can be used in the nitro request :</p>
|
|
<p class="property_name">onerror<span class=\"property_type\"> <String_value></span></p><p class="property_description"> Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.<br />Default value: EXIT<br />Possible values = EXIT, CONTINUE</p><a href="#update" class="operation">update</a><a href="#add" class="operation">add</a><a href="#get_all" class="operation">get (all)</a><a href="#get" class="operation">get</a><a href="#delete" class="operation">delete</a><p class="heading"><a name="update">update</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/mpsgroup/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">PUT</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"mpsgroup":{<br><font color=#FF0000><b> "id":<String_value></b></font>,<br><font color=#000000> "roles":<String_value[]></font>,<br><font color=#000000> "role":<String_value></font>,<br><font color=#000000> "authscope_props":[{<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "rbaoperator":<String_value></font>,<br><font color=#000000> "propvalue":<String_value></font>,<br><font color=#000000> "propname":<String_value></font>}]</font>,<br><font color=#000000> "assign_all_devices":<Boolean_value></font>,<br><font color=#000000> "assign_all_autoscale_groups":<Boolean_value></font>,<br><font color=#000000> "autoscale_groups_id":<String_value[]></font>,<br><font color=#000000> "session_timeout_unit":<String_value></font>,<br><font color=#000000> "name":<String_value></font>,<br><font color=#000000> "tenant_id":<String_value></font>,<br><font color=#000000> "user_session_limit":<Integer_value></font>,<br><font color=#000000> "users":<String_value[]></font>,<br><font color=#000000> "permission":<String_value></font>,<br><font color=#000000> "bound_entity_selected":<Integer_value></font>,<br><font color=#000000> "select_individual_entity":<Boolean_value></font>,<br><font color=#000000> "assign_all_selected_device_apps":<Boolean_value></font>,<br><font color=#000000> "standalone_instances_id":<String_value[]></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "application_names":<String_value[]></font>,<br><font color=#000000> "allow_application_only":<Boolean_value></font>,<br><font color=#000000> "assign_all_apps":<Boolean_value></font>,<br><font color=#000000> "session_timeout":<Integer_value></font>,<br><font color=#000000> "apply_all_bound_entities":<Boolean_value></font>,<br><font color=#000000> "enable_session_timeout":<Boolean_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "mpsgroup":[{<br> "apply_all_bound_entities":<Boolean_value></font>,<br> "role":<String_value></font>,<br> "authscope_props":[{<br> "parent_name":<String_value></font>,<br> "propname":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "propvalue":<String_value></font>,<br> "rbaoperator":<String_value></font>,<br> "id":<String_value></font><br> "propvalues":<String_value></font>}],<br> "session_timeout":<Integer_value></font>,<br> "assign_all_apps":<Boolean_value></font>,<br> "name":<String_value></font>,<br> "bound_entity_selected":<Integer_value></font>,<br> "user_session_limit":<Integer_value></font>,<br> "enable_session_timeout":<Boolean_value></font>,<br> "assign_all_selected_device_apps":<Boolean_value></font>,<br> "tenant_id":<String_value></font>,<br> "select_individual_entity":<Boolean_value></font>,<br> "assign_all_devices":<Boolean_value></font>,<br> "assign_all_autoscale_groups":<Boolean_value></font>,<br> "session_timeout_unit":<String_value></font>,<br> "description":<String_value></font>,<br> "allow_application_only":<Boolean_value></font>,<br> "permission":<String_value></font>,<br> "id":<String_value></font>,<br> "application_names_with_regex":<String_value></font>,<br> "application_names_without_regex":<String_value></font>,<br> "application_list":[{<br> "vsvr_ip_address":<String_value></font>,<br> "name":<String_value></font>,<br> "state":<String_value></font>,<br> "client_header":<String_value></font>,<br> "hostname":<String_value></font>,<br> "display_name":<String_value></font>,<br> "httpxforwardedfor":<String_value></font>,<br> "vsvr_type":<String_value></font>,<br> "ns_ip_address":<String_value></font>,<br> "id":<String_value></font>,<br> "transaction_log_effective":<String_value></font>,<br> "export_option":<String_value></font>,<br> "configuration_path":<String_value></font>,<br> "metrics_option":<String_value></font>,<br> "metrics_enabled":<Boolean_value></font>,<br> "type":<String_value></font>}],<br> "tenant_name":<String_value></font>,<br> "users":<String_value></font>,<br> "application_names":<String_value></font>,<br> "roles":<String_value></font>,<br> "autoscale_groups_id":<String_value></font>,<br> "standalone_instances_id":<String_value></font>}]}</p><p class="heading"><a name="add">add</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/mpsgroup?onerror=<String_value></span></p><p class="key">HTTPS Method:<span class="value">POST</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Request Payload:<span class="value">JSON</span></p><p class="payload">{"mpsgroup": {<br><font color=#FF0000><b> "name":<String_value></b></font>,<br><font color=#FF0000><b> "permission":<String_value></b></font>,<br><font color=#000000> "session_timeout_unit":<String_value></font>,<br><font color=#000000> "autoscale_groups_id":<String_value[]></font>,<br><font color=#000000> "tenant_id":<String_value></font>,<br><font color=#000000> "user_session_limit":<Integer_value></font>,<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "assign_all_autoscale_groups":<Boolean_value></font>,<br><font color=#000000> "assign_all_devices":<Boolean_value></font>,<br><font color=#000000> "roles":<String_value[]></font>,<br><font color=#000000> "authscope_props":[{<br><font color=#000000> "id":<String_value></font>,<br><font color=#000000> "rbaoperator":<String_value></font>,<br><font color=#000000> "propvalue":<String_value></font>,<br><font color=#000000> "propname":<String_value></font>}]</font>,<br><font color=#000000> "role":<String_value></font>,<br><font color=#000000> "allow_application_only":<Boolean_value></font>,<br><font color=#000000> "description":<String_value></font>,<br><font color=#000000> "application_names":<String_value[]></font>,<br><font color=#000000> "standalone_instances_id":<String_value[]></font>,<br><font color=#000000> "enable_session_timeout":<Boolean_value></font>,<br><font color=#000000> "session_timeout":<Integer_value></font>,<br><font color=#000000> "assign_all_apps":<Boolean_value></font>,<br><font color=#000000> "apply_all_bound_entities":<Boolean_value></font>,<br><font color=#000000> "users":<String_value[]></font>,<br><font color=#000000> "select_individual_entity":<Boolean_value></font>,<br><font color=#000000> "assign_all_selected_device_apps":<Boolean_value></font>,<br><font color=#000000> "bound_entity_selected":<Integer_value></font>}}</p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "mpsgroup":[{<br> "apply_all_bound_entities":<Boolean_value></font>,<br> "role":<String_value></font>,<br> "authscope_props":[{<br> "parent_name":<String_value></font>,<br> "propname":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "propvalue":<String_value></font>,<br> "rbaoperator":<String_value></font>,<br> "id":<String_value></font><br> "propvalues":<String_value></font>}],<br> "session_timeout":<Integer_value></font>,<br> "assign_all_apps":<Boolean_value></font>,<br> "name":<String_value></font>,<br> "bound_entity_selected":<Integer_value></font>,<br> "user_session_limit":<Integer_value></font>,<br> "enable_session_timeout":<Boolean_value></font>,<br> "assign_all_selected_device_apps":<Boolean_value></font>,<br> "tenant_id":<String_value></font>,<br> "select_individual_entity":<Boolean_value></font>,<br> "assign_all_devices":<Boolean_value></font>,<br> "assign_all_autoscale_groups":<Boolean_value></font>,<br> "session_timeout_unit":<String_value></font>,<br> "description":<String_value></font>,<br> "allow_application_only":<Boolean_value></font>,<br> "permission":<String_value></font>,<br> "id":<String_value></font>,<br> "application_names_with_regex":<String_value></font>,<br> "application_names_without_regex":<String_value></font>,<br> "application_list":[{<br> "vsvr_ip_address":<String_value></font>,<br> "name":<String_value></font>,<br> "state":<String_value></font>,<br> "client_header":<String_value></font>,<br> "hostname":<String_value></font>,<br> "display_name":<String_value></font>,<br> "httpxforwardedfor":<String_value></font>,<br> "vsvr_type":<String_value></font>,<br> "ns_ip_address":<String_value></font>,<br> "id":<String_value></font>,<br> "transaction_log_effective":<String_value></font>,<br> "export_option":<String_value></font>,<br> "configuration_path":<String_value></font>,<br> "metrics_option":<String_value></font>,<br> "metrics_enabled":<Boolean_value></font>,<br> "type":<String_value></font>}],<br> "tenant_name":<String_value></font>,<br> "users":<String_value></font>,<br> "application_names":<String_value></font>,<br> "roles":<String_value></font>,<br> "autoscale_groups_id":<String_value></font>,<br> "standalone_instances_id":<String_value></font>}]}</p><p class="heading"><a name="get_all">get (all)</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/mpsgroup</span></p><p class="key">Query-parameters:<span class="url_value"></span></p><p class="key"><b>filter</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/mpsgroup<b>?filter=property-name1:property-value1,property-name2:property-value2</b></span></p><p class="key"><span class="value">Use this query-parameter to get the filtered set of mpsgroup resources configured on the system. You can set a filter on any property of the resource.</span></p><p class="key"><b>pagesize=#no&pageno=#no</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/mpsgroup<b>?pagesize=#no&pageno=#no</b></span></p><p class="key"><span class="value">Use this query-parameter to get the mpsgroup resources in chunks.</span></p><p class="key"><b>count</b></p><p class="key"><span class="value">https://<MGMT-IP>/nitro/v2/config/mpsgroup<b>?count=yes</b></span></p><p class="key"><span class="value">Use this query-parameter to get the count of mpsgroup resources.</span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "mpsgroup":[{<br> "apply_all_bound_entities":<Boolean_value></font>,<br> "role":<String_value></font>,<br> "authscope_props":[{<br> "parent_name":<String_value></font>,<br> "propname":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "propvalue":<String_value></font>,<br> "rbaoperator":<String_value></font>,<br> "id":<String_value></font><br> "propvalues":<String_value></font>}],<br> "session_timeout":<Integer_value></font>,<br> "assign_all_apps":<Boolean_value></font>,<br> "name":<String_value></font>,<br> "bound_entity_selected":<Integer_value></font>,<br> "user_session_limit":<Integer_value></font>,<br> "enable_session_timeout":<Boolean_value></font>,<br> "assign_all_selected_device_apps":<Boolean_value></font>,<br> "tenant_id":<String_value></font>,<br> "select_individual_entity":<Boolean_value></font>,<br> "assign_all_devices":<Boolean_value></font>,<br> "assign_all_autoscale_groups":<Boolean_value></font>,<br> "session_timeout_unit":<String_value></font>,<br> "description":<String_value></font>,<br> "allow_application_only":<Boolean_value></font>,<br> "permission":<String_value></font>,<br> "id":<String_value></font>,<br> "application_names_with_regex":<String_value></font>,<br> "application_names_without_regex":<String_value></font>,<br> "application_list":[{<br> "vsvr_ip_address":<String_value></font>,<br> "name":<String_value></font>,<br> "state":<String_value></font>,<br> "client_header":<String_value></font>,<br> "hostname":<String_value></font>,<br> "display_name":<String_value></font>,<br> "httpxforwardedfor":<String_value></font>,<br> "vsvr_type":<String_value></font>,<br> "ns_ip_address":<String_value></font>,<br> "id":<String_value></font>,<br> "transaction_log_effective":<String_value></font>,<br> "export_option":<String_value></font>,<br> "configuration_path":<String_value></font>,<br> "metrics_option":<String_value></font>,<br> "metrics_enabled":<Boolean_value></font>,<br> "type":<String_value></font>}],<br> "tenant_name":<String_value></font>,<br> "users":<String_value></font>,<br> "application_names":<String_value></font>,<br> "roles":<String_value></font>,<br> "autoscale_groups_id":<String_value></font>,<br> "standalone_instances_id":<String_value></font>}]}</p><p class="heading"><a name="get">get</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/mpsgroup/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">GET</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">Accept:<span class="value">application/json</span></span></p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Headers:</p><p class="key"><span class="value">Content-Type:<span class="value">application/json</span></span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value>, "mpsgroup":[{<br> "apply_all_bound_entities":<Boolean_value></font>,<br> "role":<String_value></font>,<br> "authscope_props":[{<br> "parent_name":<String_value></font>,<br> "propname":<String_value></font>,<br> "parent_id":<String_value></font>,<br> "propvalue":<String_value></font>,<br> "rbaoperator":<String_value></font>,<br> "id":<String_value></font><br> "propvalues":<String_value></font>}],<br> "session_timeout":<Integer_value></font>,<br> "assign_all_apps":<Boolean_value></font>,<br> "name":<String_value></font>,<br> "bound_entity_selected":<Integer_value></font>,<br> "user_session_limit":<Integer_value></font>,<br> "enable_session_timeout":<Boolean_value></font>,<br> "assign_all_selected_device_apps":<Boolean_value></font>,<br> "tenant_id":<String_value></font>,<br> "select_individual_entity":<Boolean_value></font>,<br> "assign_all_devices":<Boolean_value></font>,<br> "assign_all_autoscale_groups":<Boolean_value></font>,<br> "session_timeout_unit":<String_value></font>,<br> "description":<String_value></font>,<br> "allow_application_only":<Boolean_value></font>,<br> "permission":<String_value></font>,<br> "id":<String_value></font>,<br> "application_names_with_regex":<String_value></font>,<br> "application_names_without_regex":<String_value></font>,<br> "application_list":[{<br> "vsvr_ip_address":<String_value></font>,<br> "name":<String_value></font>,<br> "state":<String_value></font>,<br> "client_header":<String_value></font>,<br> "hostname":<String_value></font>,<br> "display_name":<String_value></font>,<br> "httpxforwardedfor":<String_value></font>,<br> "vsvr_type":<String_value></font>,<br> "ns_ip_address":<String_value></font>,<br> "id":<String_value></font>,<br> "transaction_log_effective":<String_value></font>,<br> "export_option":<String_value></font>,<br> "configuration_path":<String_value></font>,<br> "metrics_option":<String_value></font>,<br> "metrics_enabled":<Boolean_value></font>,<br> "type":<String_value></font>}],<br> "tenant_name":<String_value></font>,<br> "users":<String_value></font>,<br> "application_names":<String_value></font>,<br> "roles":<String_value></font>,<br> "autoscale_groups_id":<String_value></font>,<br> "standalone_instances_id":<String_value></font>}]}</p><p class="heading"><a name="delete">delete</a></p><p class="key">URL:<span class="url_value">https://<MGMT-IP>/nitro/v2/config/mpsgroup/id_value<String></span></p><p class="key">HTTPS Method:<span class="value">DELETE</span></p><p class="key">Request Headers:</p><p class="key"><span class="value">X-NITRO-USER:<span class="value">username_value<String></span></span></p><p class="key"><span class="value">X-NITRO-PASS:<span class="value">password_value<String></span></span></p><p class="key"><span class="value"><span class="value">or</span></span></p><p class="key"><span class="value">Cookie:<span class="value">NITRO_AUTH_TOKEN=token_value<String></span></span></p><p class="key">Response:</p><p class="key"><span class="value">HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx <string> (for general HTTPS errors) or 5xx <string> (for NetScaler-MAS-specific errors). The response payload provides details of the error</span></p><p class="key">Response Payload:<span class="value">JSON</span></p><p class="payload">{ "errorcode": 0, "message": "Done", "severity": <String_value> }</p>
|
|
</body>
|
|
</html>
|