systemrestorepoint¶

Configuration for Setting restorepoints for auto restore resource.

Properties¶

(click to see Operations )

Name	Data Type	Permissions	Description
filename	<String>	Read-write	Name of the restore point. Minimum length = 1 Maximum length = 63
backupfilename	<String>	Read-only	backup file name of the restore points created internally.
techsuprtname	<String>	Read-only	Tech support bundle name created during creation of restore points.
creationtime	<String>	Read-only	Creation time of the restore points.
version	<String>	Read-only	Build version of the restore points.
createdby	<String>	Read-only	Name of user who created the restore points.
ipaddress	<String>	Read-only	Ip of Netscaler box where the restore point was created.
__count	<Double>	Read-only	count parameter

Operations¶

(click to see Properties )

CREATE
DELETE
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

create¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/systemrestorepoint? action=create

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"systemrestorepoint":{
<b>      "filename":<String_value>
</b>}}

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/systemrestorepoint/ filename_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

get (all)¶

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

Query-parameters:

attrs

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

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

view

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

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

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

{ "systemrestorepoint": [ {
      "filename":<String_value>,
      "backupfilename":<String_value>,
      "techsuprtname":<String_value>,
      "creationtime":<String_value>,
      "version":<String_value>,
      "createdby":<String_value>,
      "ipaddress":<String_value>
}]}

get¶

URL: http:// <netscaler-ip-address> /nitro/v1/config/systemrestorepoint/ filename_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/systemrestorepoint/ filename_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/systemrestorepoint/ filename_value<String> ? view=summary

Use this query-parameter to get the summary output of systemrestorepoint 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:

{  "systemrestorepoint": [ {
      "filename":<String_value>,
      "backupfilename":<String_value>,
      "techsuprtname":<String_value>,
      "creationtime":<String_value>,
      "version":<String_value>,
      "createdby":<String_value>,
      "ipaddress":<String_value>
}]}

count¶

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

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