Download full document:

vpnurl

Configuration for VPN URL resource.

Properties

(click to see Operations)

NameData TypePermissionsDescription
urlname<String>Read-writeName of the bookmark link.
Minimum length = 1
linkname<String>Read-writeDescription of the bookmark link. The description appears in the Access Interface.
Minimum length = 1
actualurl<String>Read-writeWeb address for the bookmark link.
Minimum length = 1
vservername<String>Read-writeName of the associated LB/CS vserver.
clientlessaccess<String>Read-writeIf clientless access to the resource hosting the link is allowed, also use clientless access for the bookmarked web address in the Secure Client Access based session. Allows single sign-on and other HTTP processing on Citrix Gateway for HTTPS resources.
Default value: OFF
Possible values = ON, OFF
comment<String>Read-writeAny comments associated with the bookmark link.
iconurl<String>Read-writeURL to fetch icon file for displaying this resource.
ssotype<String>Read-writeSingle sign on type for unified gateway.
Possible values = unifiedgateway, selfauth, samlauth
applicationtype<String>Read-writeThe type of application this VPN URL represents. Possible values are CVPN/SaaS/VPN.
Possible values = CVPN, VPN, SaaS
samlssoprofile<String>Read-writeProfile to be used for doing SAML SSO.
appjson<String>Read-writeTo store the template details in the json format.
__count<Double>Read-onlycount 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 redand placeholder content is marked in <green>.

add

URL:http://<netscaler-ip-address>/nitro/v1/config/vpnurl

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"vpnurl":{
<b>"urlname":<String_value>,
</b><b>"linkname":<String_value>,
</b><b>"actualurl":<String_value>,
</b>"vservername":<String_value>,
"clientlessaccess":<String_value>,
"comment":<String_value>,
"iconurl":<String_value>,
"ssotype":<String_value>,
"applicationtype":<String_value>,
"samlssoprofile":<String_value>,
"appjson":<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/vpnurl/urlname_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/vpnurl

HTTP Method:PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"vpnurl":{
<b>"urlname":<String_value>,
</b>"linkname":<String_value>,
"actualurl":<String_value>,
"vservername":<String_value>,
"clientlessaccess":<String_value>,
"comment":<String_value>,
"iconurl":<String_value>,
"ssotype":<String_value>,
"applicationtype":<String_value>,
"samlssoprofile":<String_value>,
"appjson":<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/vpnurl?action=unset

HTTP Method:POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN=<tokenvalue> Content-Type:application/json

Request Payload:

{"vpnurl":{
<b>"urlname":<String_value>,
</b>"vservername":true,
"clientlessaccess":true,
"comment":true,
"iconurl":true,
"ssotype":true,
"applicationtype":true,
"samlssoprofile":true,
"appjson":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/vpnurl

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/vpnurl?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/vpnurl?filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of vpnurl resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http://<netscaler-ip-address>/nitro/v1/config/vpnurl?view=summary

Note:By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http://<netscaler-ip-address>/nitro/v1/config/vpnurl?pagesize=#no;pageno=#no

Use this query-parameter to get the vpnurl 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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "vpnurl": [ {
"urlname":<String_value>,
"linkname":<String_value>,
"vservername":<String_value>,
"actualurl":<String_value>,
"clientlessaccess":<String_value>,
"comment":<String_value>,
"iconurl":<String_value>,
"ssotype":<String_value>,
"applicationtype":<String_value>,
"samlssoprofile":<String_value>,
"appjson":<String_value>
}]}

get

URL:http://<netscaler-ip-address>/nitro/v1/config/vpnurl/urlname_value<String>

Query-parameters:

attrs

http://<netscaler-ip-address>/nitro/v1/config/vpnurl/urlname_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/vpnurl/urlname_value<String>?view=summary

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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "vpnurl": [ {
"urlname":<String_value>,
"linkname":<String_value>,
"vservername":<String_value>,
"actualurl":<String_value>,
"clientlessaccess":<String_value>,
"comment":<String_value>,
"iconurl":<String_value>,
"ssotype":<String_value>,
"applicationtype":<String_value>,
"samlssoprofile":<String_value>,
"appjson":<String_value>
}]}

count

URL:http://<netscaler-ip-address>/nitro/v1/config/vpnurl?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 errorResponse Headers:

Content-Type:application/json

Response Payload:

{ "vpnurl": [ { "__count": "#no"} ] }