Sign in

v2

latestSwagger 2.0raw.githubusercontent.com2019-06-202346811.1 MB
BackupRestore

Gets the list of backups available for the specified backed up entity at the specified backup location.

Gets the list of backups available for the specified backed up entity (Application, Service or Partition) at the specified backup location (FileShare or Azure Blob Storage).

post/BackupRestore/$/GetBackups

Query parameters

api-version'6.4' required

The version of the API. This parameter is required and its value must be '6.4'.

Service Fabric REST API version is based on the runtime version in which the API was introduced or was changed. Service Fabric runtime supports more than one version of the API. This version is the latest supported version of the API. If a lower API version is passed, the returned response may be different from the one documented in this specification.

Additionally the runtime accepts any version that is higher than the latest supported version up to the current version of the runtime. So if the latest API version is 6.0 and the runtime is 6.1, the runtime will accept version 6.1 for that API. However the behavior of the API will be as per the documented 6.0 version.

timeoutinteger

The server timeout for performing the operation in seconds. This timeout specifies the time duration that the client is willing to wait for the requested operation to complete. The default value for this parameter is 60 seconds.

ContinuationTokenstring

The continuation token parameter is used to obtain next set of results. A continuation token with a non-empty value is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token does not contain a value. The value of this parameter should not be URL encoded.

MaxResultsinteger

The maximum number of results to be returned as part of the paged queries. This parameter defines the upper bound on the number of results returned. The results returned can be less than the specified maximum results if they do not fit in the message as per the max message size restrictions defined in the configuration. If this parameter is zero or not specified, the paged query includes as many results as possible that fit in the return message.

Request body

StartDateTimeFilterstring date-time

Specifies the start date time in ISO8601 from which to enumerate backups. If not specified, backups are enumerated from the beginning.

EndDateTimeFilterstring date-time

Specifies the end date time in ISO8601 till which to enumerate backups. If not specified, backups are enumerated till the end.

Latestboolean

If specified as true, gets the most recent backup (within the specified time range) for every partition under the specified backup entity.

Response

A successful operation will return 200 status code and a paged list of backup information.

ContinuationTokenstring

The continuation token parameter is used to obtain next set of results. The continuation token is included in the response of the API when the results from the system do not fit in a single response. When this value is passed to the next API call, the API returns next set of results. If there are no further results, then the continuation token is not included in the response.