Citrix ADC 12.1 NITRO API Reference

vpnstoreinfo

Configuration for Store information for a URL resource.

Properties

(click to see Operations)

Name Data Type Permissions Description
url Read-write StoreFront URL to be scanned.
storeserverstatus Read-only Availability of the server for TCP connections.
Possible values = UP, DOWN
storeserverissf Read-only Indicates if the server being scanned is running StoreFront.
Possible values = YES, NO
storeapisupport Read-only Indicates StoreFront API support status.
Possible values = YES, NO
storelist Read-only List of available stores return by StoreFront API.
storestatus Read-only Availability of the specified StoreFront store.
Possible values = UP, DOWN
__count Read-only count parameter

Operations

(click to see Properties)

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 Citrix ADC appliance, the URL is as follows:

    http://<Citrix-ADC-IP-address(NSIP)>/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 Citrix ADC 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>.

get (all)

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnstoreinfo

Query-parameters:

args

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnstoreinfo?args=url:<String_value>,

Use this query-parameter to get vpnstoreinfo resources based on additional properties.

attrs

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnstoreinfo?attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnstoreinfo?filter=property-name1:property-val1,property-name2:property-val2

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

view

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnstoreinfo?view=summary

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

pagination

http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnstoreinfo?pagesize=#no;pageno=#no

Use this query-parameter to get the vpnstoreinfo 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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:


{ "vpnstoreinfo": [ {
<b>url:<String_value>,</b>"storeserverstatus":<String_value>,
"storeserverissf":<String_value>,
"storeapisupport":<String_value>,
"storelist":<String_value>,
"storestatus":<String_value>
}]}

<!--NeedCopy-->

count

URL:http://<Citrix-ADC-IP-address(NSIP)>/nitro/v1/config/vpnstoreinfo?args=url:<String_value>,;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 Citrix ADC specific errors). The response payload provides details of the errorResponse Headers:

Content-Type:application/json

Response Payload:


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

<!--NeedCopy-->
vpnstoreinfo