Service Profiles API

/v1/serviceprofiles returns information about service profiles that are defined in the Zerto Cloud Manager that is connected to the site where the API runs.

URL

HTTP Method

Security

See Also

Format

URL

All service profiles https://zvm_ip:port/v1/serviceprofiles
Filtered service profiles https://zvm_ip:port/v1/serviceprofiles?site={siteIdentifier}
Single service profile https://zvm_ip:port/v1/serviceprofiles/{serviceProfileId}

Where:

zvm_ip The IP address of the Zerto Virtual Manager where the API is run.
port The port to access the Zerto Virtual Manager. The default port is 9669.
serviceProfileId The service profile ID for which information should be returned.
Filters Filters are optional and any combination of filters is valid. When no filter is specified, all service profiles are returned. Filters are not case-sensitive.
 
Filter
Description
  siteIdentifier The identifier of the site for which service profiles should be returned.

HTTP Method

GET

Security

The API is exposed over HTTPS. Client code must use the x-zerto-session HTTP authorization header.

See Also

Starting a session: Session: POST

Format

Json, XML

Request Body Using Json Format

The request body is empty.

Response In Json Format

The following is an example response Json body for https://zvm_ip:port/v1/serviceprofiles and for https://zvm_ip:port/v1/serviceprofiles/{SiteIdentifier}.

[{
  "Description": "String content",
  "History":"P428DT10H30M12.3S",
  "JournalWarningThresholdInPercent":4294967295,
  "Link": {
    "href": "String content",
    "identifier": "String content",
    "rel": "String content",
    "type": "String content"
  },
  "MaxJournalSizeInPercent":4294967295,
  "Rpo":"P428DT10H30M12.3S",
  "ServiceProfileIdentifier": "String content",
  "ServiceProfileName": "String content",
  "TestInterval":"P428DT10H30M12.3S"},
}]

XML Response Format

For the XML response format, see Service Profiles API XML Response Formats.

Response Values

Response values for https://zvm_ip:port/v1/serviceprofiles and for https://zvm_ip:port/v1/serviceprofiles/{SiteIdentifier}.

Parameter Description
Description A description of the service profile.
History The length of time all write commands are saved in the journal.
JournalWarningThresholdInPercent The journal size that triggers a warning that the journal has neared its hard limit, as a percentage of the virtual machine volume size.
Link The link details.

href

The URL used.

identifier

The unique identifier of the service profile.

rel

The next path level for the API relative to the current path.

type

The API interface service.
MaxJournalSizeInPercent The maximum size that the journal can grow, as a percentage of the virtual machine volume size.
Rpo The maximum desired time between each automatic checkpoint being written to the journal before an alert is issued.
ServiceProfileIdentifier The unique identifier of the service profile.
ServiceProfileName The name of the service profile.
TestInterval The period of time specified in the VPG that should pass between testing the failover process.
PowerShell Scripts

For complete PowerShell Scripts, see Examples.