app_category¶

Configuration for Application Category resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
tenant_id	<String>	Read-write	Tenant Id of app_category. Minimum length = 1 Maximum length = 128
is_default	<Boolean>	Read-write	True, if this profile is system generated and can not be deleted.
name	<String>	Read-write	Application Category. Minimum length = 1 Maximum length = 128
id	<String>	Read-only	Id is system generated key for all the app_category.

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/app_category?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:

{"app_category": {
<b>      "name":<String_value></b>,
      "tenant_id":<String_value>,
      "is_default":<Boolean_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, "app_category":[{
      "tenant_id":<String_value>,
      "is_default":<Boolean_value>,
      "name":<String_value>,
      "id":<String_value>}]}

delete¶

URL: https://<MGMT-IP>/nitro/v2/config/app_category/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/app_category

Query-parameters:

filter https://<MGMT-IP>/nitro/v2/config/app_category ?filter=property-name1:property-value1,property-name2:property-value2

Use this query-parameter to get the filtered set of app_category 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/app_category ?pagesize=#no;pageno=#no

Use this query-parameter to get the app_category resources in chunks.

count https://<MGMT-IP>/nitro/v2/config/app_category ?count=yes

Use this query-parameter to get the count of app_category 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, "app_category":[{
      "tenant_id":<String_value>,
      "is_default":<Boolean_value>,
      "name":<String_value>,
      "id":<String_value>}]}

get¶

URL: https://<MGMT-IP>/nitro/v2/config/app_category/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, "app_category":[{
      "tenant_id":<String_value>,
      "is_default":<Boolean_value>,
      "name":<String_value>,
      "id":<String_value>}]}

update¶

URL: https://<MGMT-IP>/nitro/v2/config/app_category/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:

{"app_category":{
      "name":<String_value>,
      "tenant_id":<String_value>,
      "is_default":<Boolean_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, "app_category":[{
      "tenant_id":<String_value>,
      "is_default":<Boolean_value>,
      "name":<String_value>,
      "id":<String_value>}]}