List Service Profiles / Get Information for a Specific Service Profile
The response for both APIs is identical.
Display a list of all service profiles by running the following API.
METHOD | URL |
---|---|
GET | https://zcm_ip:port/v1/serviceprofiles |
Display information about a specific service profile by its ID by running the following API.
METHOD | URL |
---|---|
GET | https://zcm_ip:port/v1/serviceprofiles/{serviceprofileidentifier} |
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. |
serviceprofileidentifie | The identifier of the service profile to use for the VPG. |
Request
The request body is empty.
Response
The following is an example response Json body of a list of all service profiles and, without the array statement, of a specific service profile.
{
"BackupPolicy": {
"RetentionPeriod": "",
"SchedulePeriodType": "String content",
"ScheduleDayOfWeek": "String content"
},
"DRPolicy": {
"DefaultJournalHistory": "1 day",
"JournalSizeHardLimit": "75%",
"JournalSizeWarningThreshold": "50%",
"TargetRpoAlert": "5 minutes",
"TestFrequencyReminder": "None"
},
"Description": "System Service Profile",
"IsDefaultServiceProfile": true,
"Link" {
"href": "https://172.20.184.51:9989/v1/serviceprofiles/18f89b73-e6dc-4430-9f47-e9d55dc204b",
"identifier": "18f89b73-e6dc-4430-9f47-e9d55dc204be",
"rel": null,
"type": "ServiceProfileApi"
"RecoveryPolicy": "Disaster Recovery",
"ServiceProfileIdentifier": "b4438eb2-b7f0-41d4-ad21-14d881be566c",
"ServiceProfileName": "System Service Profile"
}]
RESPONSE | TYPE | |
---|---|---|
BackupPolicy | Details about the offsite backup policy. | |
RetentionPeriod | String | The length of time to keep offsite backups, 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. |
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 can be 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. |
Description | String | A description of the service profile. |
IsDefaultServiceProfile | Boolean | |
Link | Link information for the URL. | |
href | String | URL for API call(s) to the service profile. |
identifier | String | The unique internal identifier of the service profile. |
rel | String | Next path level for the API relative to the current path. |
type | String | API interface type. |
RecoveryPolicy | String | The selected policy. Possible values: Standard disaster recovery Extended recovery (includes backup) |
ServiceProfileIdentifier | String | The identifier of the service profile to use for the VPG. |
ServiceProfileName | String | The name of the service profile. |
Back to Service Profile APIs
Back to List of APIs
See also Starting and Ending a Session