Update a Specific Service Profile

Request

Response

 
METHODURL
 

https://zcm_ip:port/v1/serviceprofiles/{serviceprofileidentifier}

Where:

zcm_ipThe IP address of the Zerto Cloud Manager where the API is run.
portThe port to access the Zerto Cloud Manager. The default port is 9989.
serviceprofileidentifieThe identifier of the service profile to use for the VPG.

Request

The following is an example request Json body.

[{
  "ServiceProfileName": "Gold",
  "RecoveryPolicy": "Disaster recovery",
  "Description": "Ultimate",
  "DRPolicy": {
    "TargetRpoAlert": "1 minute",
    "DefaultJournalHistory": "15 hours",
    "JournalSizeHardLimit": "Unlimited",
    "JournalSizeWarningThreshold": "Unlimited",
    "TestFrequencyReminder": "9 Months
  },
  "BackupPolicy": ",
    ""RetentionPeriod": "1 Month",
    "SchedulePeriodType": "Daily",
    "ScheduleDayOfWeek": "Thursday",
  }
}]

RESPONSETYPE 
ServiceProfileNameStringThe name of the service profile.
RecoveryPolicyString

The selected policy. Possible values:

Standard disaster recovery

Extended recovery (includes backup)

DescriptionStringThe description of the service profile.
DRPolicy Policy configuration.

TargetRpoAlert

String

The maximum requested time between each automatic checkpoint being written to the journal before an alert is issued.

The value is between one minute and 12 hours.

DefaultJournalHistory

String

The default time that all write commands are saved in the journal. The value is 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 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

StringThe day of the week when the backup is performed.

Response

The response Json body is empty.

Back to Service Profile APIs

Back to List of APIs

See also Starting and Ending a Session