vpnsecureprivateaccessprofile

Last published : Oct 30, 2026
Configuration for Secure Private Access Profile resource.
Related information
Configuration

Properties

(click to see Operations )
Name Data Type Permissions Description
name <String> Read-write name of Secure Private Access profile.
Minimum length = 1
Maximum length = 31
url <String> Read-write Public URL for your Secure Private Access site or load balancing server.
customerid <String> Read-write Customer ID of the citrix cloud customer.
Minimum length = 1
chromeenterprisepremiummode <String> Read-write Secure Private Access Chrome Enterprise Premium mode of operation.
Default value: OFF
Possible values = OFF, WITH_PARTNER_CONNECTOR, WITHOUT_PARTNER_CONNECTOR
googlecustomerid <String> Read-write Your organization's unique ID on Google's Admin console Profile settings.
Minimum length = 1
googlesecuritygatewayid <String> Read-write The ID of the Google Secure Gateway.
Minimum length = 1
forceclienttype <String> Read-write Automatically configures the session for Citrix Secure Access client connectivity.
Default value: ON
Possible values = ON, OFF
sharedsecret <String> Read-write Secure Private Access Shared Secret.
Minimum length = 32
clouddeployment <String> Read-only Secure Private Access cloud deployment.
Default value: PRODUCTION
Possible values = PRODUCTION, STAGING, DEVELOPMENT
accessrestrictedpageredirect <String> Read-only Redirect option for access restricted pages.
Default value: CDN
Possible values = CDN, NS, OFF
serverstatus <String> Read-only Status of the Secure Private Access site as determined by a TCP monitor health check.
Possible values = UP, DOWN
_nextgenapiresource <String> Read-only .
__count <Double> Read-only count parameter

Operations

(click to see Properties )
  • ADD
  • DELETE
  • UPDATE
  • UNSET
  • GET (ALL)
  • GET
  • 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/vpnsecureprivateaccessprofile HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnsecureprivateaccessprofile":{
<b>"name":<String_value>,
</b><b>"url":<String_value>,
</b>"customerid":<String_value>,
"chromeenterprisepremiummode":<String_value>,
"googlecustomerid":<String_value>,
"googlesecuritygatewayid":<String_value>,
"forceclienttype":<String_value>,
"sharedsecret":<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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnsecureprivateaccessprofile/ name_value<String> HTTP Method: DELETE
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnsecureprivateaccessprofile HTTP Method: PUT
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnsecureprivateaccessprofile":{
<b>"name":<String_value>,
</b>"url":<String_value>,
"customerid":<String_value>,
"chromeenterprisepremiummode":<String_value>,
"googlecustomerid":<String_value>,
"googlesecuritygatewayid":<String_value>,
"forceclienttype":<String_value>,
"sharedsecret":<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/vpnsecureprivateaccessprofile? action=unset HTTP Method: POST
Request Headers:
Cookie:NITRO_AUTH_TOKEN= <tokenvalue>
Content-Type:application/json
Request Payload:
{"vpnsecureprivateaccessprofile":{
<b>"name":<String_value>,
</b>"customerid":true,
"chromeenterprisepremiummode":true,
"googlecustomerid":true,
"googlesecuritygatewayid":true,
"forceclienttype":true,
"sharedsecret":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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnsecureprivateaccessprofile Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/vpnsecureprivateaccessprofile? 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/vpnsecureprivateaccessprofile? filter=property-name1:property-val1,property-name2:property-val2
Use this query-parameter to get the filtered set of vpnsecureprivateaccessprofile resources configured on NetScaler.Filtering can be done on any of the properties of the resource.
view http:// <netscaler-ip-address> /nitro/v1/config/vpnsecureprivateaccessprofile? view=summary
Use this query-parameter to get the summary output of vpnsecureprivateaccessprofile 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/vpnsecureprivateaccessprofile? pagesize=#no;pageno=#no
Use this query-parameter to get the vpnsecureprivateaccessprofile 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:
{ "vpnsecureprivateaccessprofile": [ {
"name":<String_value>,
"url":<String_value>,
"clouddeployment":<String_value>,
"customerid":<String_value>,
"accessrestrictedpageredirect":<String_value>,
"chromeenterprisepremiummode":<String_value>,
"googlecustomerid":<String_value>,
"forceclienttype":<String_value>,
"googlesecuritygatewayid":<String_value>,
"sharedsecret":<String_value>,
"serverstatus":<String_value>,
"_nextgenapiresource":<String_value>
}]}

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnsecureprivateaccessprofile/ name_value<String> Query-parameters: attrs http:// <netscaler-ip-address> /nitro/v1/config/vpnsecureprivateaccessprofile/ name_value<String> ? attrs=property-name1,property-name2
Use this query parameter to specify the resource details that you want to retrieve.
view http:// <netscaler-ip-address> /nitro/v1/config/vpnsecureprivateaccessprofile/ name_value<String> ? view=summary
Use this query-parameter to get the summary output of vpnsecureprivateaccessprofile resources configured on NetScaler.
Note: By default, the retrieved results are displayed in detail view (?view=detail).
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:
{  "vpnsecureprivateaccessprofile": [ {
"name":<String_value>,
"url":<String_value>,
"clouddeployment":<String_value>,
"customerid":<String_value>,
"accessrestrictedpageredirect":<String_value>,
"chromeenterprisepremiummode":<String_value>,
"googlecustomerid":<String_value>,
"forceclienttype":<String_value>,
"googlesecuritygatewayid":<String_value>,
"sharedsecret":<String_value>,
"serverstatus":<String_value>,
"_nextgenapiresource":<String_value>
}]}

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/vpnsecureprivateaccessprofile? 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:
{ "vpnsecureprivateaccessprofile": [ { "__count": "#no"} ] }