Restore Status - Restore Status

Service:

Key Vault

API Version:

7.4

Returns the status of restore operation

GET {vaultBaseUrl}/restore/{jobId}/pending?api-version=7.4

URI Parameters

Name	In	Required	Type	Description
jobId	path	True	string	The Job Id returned part of the restore operation
vaultBaseUrl	path	True	string	The vault name, for example https://myvault.vault.azure.net.
api-version	query	True	string	Client API version.

Responses

Name	Type	Description
200 OK	RestoreOperation	OK - Returns the full restore status
Other Status Codes	KeyVaultError	Key Vault error response describing why the operation failed.

Examples

Restore status

Sample Request

HTTP

GET https://myvault.vault.azure.net//restore/45aacd568ab049a2803861e8dd3ae21f/pending?api-version=7.4

Sample Response

Status code:

200

{
  "status": "InProgress",
  "statusDetails": "Full restore is in progress",
  "jobId": "45aacd568ab049a2803861e8dd3ae21f",
  "startTime": 1490790000,
  "endTime": 0
}

Definitions

Name	Description
Error	The key vault server error.
KeyVaultError	The key vault error exception.
RestoreOperation	Restore operation

Error

The key vault server error.

Name	Type	Description
code	string	The error code.
innererror	Error	The key vault server error.
message	string	The error message.

KeyVaultError

The key vault error exception.

Name	Type	Description
error	Error	The key vault server error.

RestoreOperation

Restore operation

Name	Type	Description
endTime	integer	The end time of the restore operation
error	Error	Error encountered, if any, during the restore operation.
jobId	string	Identifier for the restore operation.
startTime	integer	The start time of the restore operation
status	string	Status of the restore operation.
statusDetails	string	The status details of restore operation.