This is an archive version of the document. To get the most up-to-date information, see the current version.

Editing Backup Repository Properties by Backup Repository ID

This section explains how to edit properties of the specified backup repository.

Request

PUT https://<hostname>/api/v1/repositories/{repositoryId}

Request Headers

The request header must contain an authorization token of the current session.

Request Parameters

The following parameters must be posted as URL.

Parameter	Description
repositoryId	The identification number of the backup repository. Can be obtained as described in Getting Backup Repositories.

Request Body

Property	Type	Description
oldPassword	string	Sets the old password.
name	string	Sets the name.
description	string	Sets the description.
enableEncryption	string	Enables/disable encryption.
password	string	Sets a new password.
hint	string	Sets the hint.

Request Example

Request:

PUT https://abc.ukwest.cloudapp.azure.com/api/v1/repositories/4

Request Header:

Authorization: Bearer <Access-Token>

Request Body:

{

"oldPassword": "xxxxx",

"name": "Backup Repository_Renamed",

"description": "New Description",

"enableEncryption": false,

"password": "xxxxx",

"hint": "New Password"

}

Response

The server returns the following response to the client.

Response Codes

A successfully completed operation returns a response code 200 (OK).

Response Headers

The response to this request contains the following headers. The response may also include additional standard HTTPS headers.

Header	Description
Content-length	The length of the response body.
Content-type	The media type and syntax of the response body message: application/json; charset=utf-8

Response Body

The response contains the following information.

Property	Type	Description
id	string	Shows the identification number of the session.
type	string	Shows the type of the session.
executionStartTime	string	Shows at what time the session was started.
executionDuration	string	Shows the duration of the session.
status	string	Shows the status of the session.
usn	string	Shows the version of the backup policy. Used by platform services to detect if a backup policy has been hanged since the last sync.
repositoryJobInfo	RepositoryJobInfo Object	Contains the RepositoryJobInfo object.
_links	Dictionary of string [key] and Object [value]	Links to related resources (navigation property).

RepositoryJobInfo Object

Property	Type	Description
repositoryId	integer	Shows the identification number of the backup repository.
repositoryName	string	Shows the name of the backup repository.
repositoryRemoved	boolean	Shows if the backup repository is removed.

Response Example

Response:

200 OK

Response Body:

{

"id": "35",

"type": "RepositoryCreation",

"executionStartTime": "2020-02-05T09:16:48.3880849Z",

"executionDuration": "00:00:00.0007395",

"status": "Running",

"usn": 0,

"repositoryJobInfo": {

"repositoryId": 4,

"repositoryName": "Backup Repository",

"repositoryRemoved": false

"_links": {

"self": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/35"},

"log": {"href": "https://abc.ukwest.cloudapp.azure.com/api/v1/jobSessions/35/log"}

}