Read

GET v1/protection_templates

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
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
creation_time	NsTime
last_modified	NsTime

GET v1/protection_templates/detail

Query parameters

Parameter	Type
startRow	NsUnsignedLong
endRow	NsUnsignedLong
sortBy	NsString
fields	NsCommaSeparatedList
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
creation_time	NsTime
last_modified	NsTime

GET v1/protection_templates/id

Query parameters

Parameter	Type
fields	NsCommaSeparatedList

Description

Read a set of protection templates or a single template.

Normal Response Codes

200

HTTP Error Codes

400 401 404 500 503

Detail Error Codes

SM_complex_type_query_param

SM_invalid_path_variable

SM_invalid_query_param

SM_malformed_url

SM_no_method_for_URL_pattern

SM_no_operation_found

SM_no_path_found

SM_start_row_beyond_end_row

SM_start_row_beyond_total_rows

SM_unexpected_query_param

SM_unsupported_query_operator

SM_version_name

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}). Possible values: 'none', 'vss', 'vmware'.
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'.
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'.
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