Zerto Cloud Manager APIs : Service Profile APIs : Add a Service Profile
  
Add a Service Profile
Request
Response
 
method
URL
POST
https://zcm_ip:port/v1/resources
 
Where:
 
zcm_ip
The IP address of the Zerto Cloud Manager where the API is run.
port
The port to access the Zerto Cloud Manager. The default port is 9989.
 
Request
The following is an example request Json body.
 
[{
  "ServiceProfileName": "gold",
  "RecoveryPolicy": "Extended Recovery" ,
  "Description": "gold",
  "DRPolicy": {
    "TargetRpoAlert": "1 minute",
    "DefaultJournalHistory": "15 hours",
    "JournalSizeHardLimit": "Unlimited",
    "JournalSizeWarningThreshold": "Unlimited",
    "TestFrequencyReminder": "9 months,
  },
  "BackupPolicy": {"
    "RetentionPeriod": "1 month"
    "SchedulePeriodType": "Daily"
    "ScheduleDayOfWeek": "Thursday"
  }
}]
 
rESPONSe
type
Description
ServiceProfileName
String
The name of the service profile.
RecoveryPolicy
String
The selected policy. Possible values:
Standard disaster recovery
Extended recovery (includes backup)
Description
String
The description of the service profile.
DRPolicy
String
Policy configuration.
TargetRpoAlert
String
The maximum requested time between each automatic checkpoint being written to the journal before an alert is issued.
The value can be between one minute and 12 hours.
DefaultJournalHistory
String
The default time that all write commands are saved in the journal. The value can be between one hour and 30 days.
JournalSizeHardLimit
String
The maximum journal size. The value is between 1 and 100 percent. 0 means unlimited.
JournalSizeWarningThreshold
String
The journal size that generates a warning that the journal is nearing its hard limit. The value is between 1 and 100 percent. 0 means unlimited.
TestFrequencyReminder
String
The time recommended between testing the integrity of the VPG. A
warning is issued if a test is not done within this time frame.
Possible values are between 1 and 12 months. 0 means none.
BackupPolicy
String
Details about the offsite backup policy.
RetentionPeriod
String
The length of time to keep offsite backups, starting from a minimum of one week, and up to a maximum of 12 months. Over time, Zerto reduces the number of stored offsite backups to save space.
 
The SchedulerPeriod parameter defines whether backups are created daily or weekly.
For an explanation of how Zerto reduces the number of offsite backups, see the Zerto Cloud Manager Administration Guide.
SchedulePeriodType
String
The type of scheduled period in which offsite backup will run.
Daily – The offsite backups will run every day.
Weekly – The offsite backups will run once a week.
ScheduleDayOfWeek
String
The day of the week when the backup is performed.
 
Response
The following is an example response Json body.
 
{
  "ServiceProfileIdentifier": "620cb569-a29b-45ae-bd10-6b9b2b96709b"
}
 
Parameter
type
Description
ServiceProfileIdentifie
String
The identifier of the service profile to use for the VPG.
 
Back to Service Profile APIs
Back to List of APIs
See also Starting and Ending a Session.