Read
GET v1/protection_templates
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsObjectName |
| full_name | NsObjectName |
| search_name | NsSearchName |
| description | NsDescription |
| app_sync | NsAppSyncType |
| app_server | NsObjectName |
| app_id | NsAppIdType |
| app_cluster_name | NsObjectName |
| app_service_name | NsObjectName |
| vcenter_hostname | NsObjectName |
| vcenter_username | NsObjectName |
| agent_hostname | NsObjectName |
| agent_username | NsObjectName |
| agent_password | NsFlexiblePassword |
| creation_time | NsTime |
| last_modified | NsTime |
GET v1/protection_templates/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| id | NsObjectID |
| name | NsObjectName |
| full_name | NsObjectName |
| search_name | NsSearchName |
| description | NsDescription |
| app_sync | NsAppSyncType |
| app_server | NsObjectName |
| app_id | NsAppIdType |
| app_cluster_name | NsObjectName |
| app_service_name | NsObjectName |
| vcenter_hostname | NsObjectName |
| vcenter_username | NsObjectName |
| agent_hostname | NsObjectName |
| agent_username | NsObjectName |
| agent_password | NsFlexiblePassword |
| creation_time | NsTime |
| last_modified | NsTime |
Description
Read a set of protection templates or a single template.
Normal Response Codes
200 206
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for protection template. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| name | NsObjectName | string | User provided identifier. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| full_name | NsObjectName | string | Fully qualified name of protection template. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| search_name | NsSearchName | string | Name of protection template used for object search. Alphanumeric string, up to 64 characters including hyphen, period, colon. Example: 'vol:1'. | |
| description | NsDescription | string | Text description of protection template. String of up to 255 printable ASCII characters. Example: '99.9999% availability'. | |
| app_sync | NsAppSyncType | string enum | Application synchronization ({none|vss|vmware|generic}). Possible values: 'none', 'vss', 'vmware', 'generic'. | |
| app_server | NsObjectName | string | Application server hostname. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| app_id | NsAppIdType | string enum | Application ID running on the server. Application ID can only be specified if application synchronization is VSS. Possible values: 'inval', 'exchange', 'sql2005', 'sql2008', 'sql2012', 'exchange_dag', 'sql2014', 'sql2016', 'hyperv'. | |
| app_cluster_name | NsObjectName | string | If the application is running within a Windows cluster environment then this is the cluster name. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| app_service_name | NsObjectName | string | If the application is running within a Windows cluster environment then this is the instance name of the service running within the cluster environment. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| vcenter_hostname | NsObjectName | string | VMware vCenter hostname. Custom port number can be specified with vCenter hostname using :. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| vcenter_username | NsObjectName | string | VMware vCenter username. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| agent_hostname | NsObjectName | string | Generic Backup agent hostname. Custom port number can be specified with agent hostname using \\":\\". String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| agent_username | NsObjectName | string | Generic Backup agent username. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| agent_password | NsFlexiblePassword | string | Generic Backup agent password. A password with few constraints. A string of up to 255 characters. Example: 'password_25-24'. | |
| creation_time | NsTime | number | Time when this protection template was created. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| last_modified | NsTime | number | Time when this protection template was last modified. Seconds since last epoch i.e. 00:00 January 1, 1970. Example: '3400'. | |
| schedule_list | NsScheduleList | Array of NsSchedule | List of schedules for this protection policy. List of snapshot schedules associated with a volume collection or protection template. |
JSON Response
{
"data" : {
"vcenter_hostname" : "",
"schedule_list" : null,
"search_name" : "policy0.165174564653174",
"name" : "policy0.165174564653174",
"last_modified" : 1426776067,
"app_id" : null,
"vcenter_username" : "",
"full_name" : "policy0.165174564653174",
"description" : "K6t0CF8YyNmGEilLItAoZoryBqU4K2JkrxyeBpePWuFAU20utoJPajntF2DLtVD4",
"app_server" : "",
"app_sync" : "none",
"app_service_name" : "",
"id" : "1200000000000004d3000000000000000000000011",
"app_cluster_name" : "",
"creation_time" : 1426776067
}
}