Getting Restore Portal Settings

You can get a resource representation of settings used to connect to Restore Portal.

Request

GET https://<hostname>:4443/v6/RestorePortalSettings

Request Headers

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

Request Body

None.

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

In the response body, the server returns a resource representation of the /RestorePortalSettings resource. The response body contains the following properties:

Property

Type

Description

applicationId

string

Specifies the identification number of an Azure AD application configured to access Restore Portal.

isEnabled

boolean

Defines that Restore Portal is enabled.

Example

The example returns a resource representation of settings used to connect to Restore Portal.

Request:

GET https://abc.tech.local:4443/v6/RestorePortalSettings

 

Request Header:

Authorization: Bearer <Access-Token>

 

Response:

200 OK

 

Response Body:

{

 "applicationId": "2b1d4885-989e-4cba-b8bd-3b13520358b8",

 "isEnabled": true

}