subscriberprofile

Last published : Oct 30, 2026
Configuration for Subscriber Profile resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
ip <String> Read-write Subscriber ip address.
vlan <Integer> Read-write The vlan number on which the subscriber is located.
Default value: 0
Minimum value = 0
Maximum value = 4096
subscriberrules <String[]> Read-write Rules configured for this subscriber. This is similar to rules received from PCRF for dynamic subscriber sessions.
subscriptionidtype <String> Read-write Subscription-Id type.
Possible values = E164, IMSI, SIP_URI, NAI, PRIVATE
subscriptionidvalue <String> Read-write Subscription-Id value.
servicepath <String> Read-write Name of the servicepath to be taken for this subscriber.
flags <Integer> Read-only Subscriber Session flags.
ttl <Integer> Read-only Subscriber Session TTL.
avpdisplaybuffer <String> Read-only Subscriber Attributes Display.
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • ADD
  • UPDATE
  • UNSET
  • DELETE
  • GET (ALL)
  • COUNT
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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/subscriberprofile HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"subscriberprofile":{
<b>"ip":<String_value>,
</b>"vlan":<Integer_value>,
"subscriberrules":<String[]_value>,
"subscriptionidtype":<String_value>,
"subscriptionidvalue":<String_value>,
"servicepath":<String_value>
}}
Response: HTTP Status Code on Success: 201 Created
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/subscriberprofile HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"subscriberprofile":{
<b>"ip":<String_value>,
</b>"vlan":<Integer_value>,
"subscriberrules":<String[]_value>,
"subscriptionidtype":<String_value>,
"subscriptionidvalue":<String_value>,
"servicepath":<String_value>
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/subscriberprofile? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"subscriberprofile":{
<b>"ip":<String_value>,
</b>"servicepath":true
}}
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/subscriberprofile/ ip_value<String> Query-parameters: args=vlan: <Integer_value>

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/subscriberprofile Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/subscriberprofile? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
filter http:// <netscaler-ip-address> /nitro/v1/config/subscriberprofile? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of subscriberprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/subscriberprofile? view=summary
Use this query-parameter to get the summary output of subscriberprofile resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
pagination http:// <netscaler-ip-address> /nitro/v1/config/subscriberprofile? pagesize=#no;pageno=#no
Use this query-parameter to get the subscriberprofile resources in chunks.
HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "subscriberprofile": [ {
"ip":<String_value>,
"vlan":<Integer_value>,
"subscriptionidtype":<String_value>,
"subscriptionidvalue":<String_value>,
"subscriberrules":<String[]_value>,
"flags":<Integer_value>,
"ttl":<Integer_value>,
"avpdisplaybuffer":<String_value>,
"servicepath":<String_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/subscriberprofile? count=yes HTTP Method: GET
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Accept:application/json
Response: HTTP Status Code on Success: 200 OK
HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error
Response Header:
Content-Type:application/json
Response Payload:
{ "subscriberprofile": [ { "__count": "#no"} ] }