Create

POST v1/protection_templates

Description

Create a protection template with given attributes.

Normal Response Codes

201

HTTP Error Codes

400 401 404 409 500 503

Detail Error Codes

Request

Parameter	Type	JSON Type	Description	Default	Mandatory	Deprecated
name	NsObjectName	string	User provided identifier. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.		Yes
description	NsDescription	string	Text description of protection template. String of up to 255 printable ASCII characters. Example: '99.9999% availability'.	''	No
app_sync	NsAppSyncType	string enum	Application synchronization ({none\|vss\|vmware}). Possible values: 'none', 'vss', 'vmware'.	'none'	No
app_server	NsObjectName	string	Application server hostname. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.	''	No
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'.	null (unspecified)	No
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'.	''	No
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'.	''	No
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'.	''	No
vcenter_username	NsObjectName	string	VMware vCenter username. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.	''	No
vcenter_password	NsPassword	string	VMware vCenter password. String of 8 to 255 printable characters excluding ampersand, backslash and ~;[]`. Example: 'password-91'.	''	No

JSON Request

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