Getting Configured Applications

In this article

    You can get a list of backup applications that are added to the specified Microsoft 365 organization.

    Request

    GET https://<hostname>:4443/v6/Organizations/{organizationId}/BackupApplications

    Request Headers

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

    Request Parameters

    The following parameter must be specified in the URL of the request:

    Parameter

    Type

    Description

    organizationId

    string

    Specifies the identification number of the Microsoft 365 organization. For more information on how to get this parameter, see Getting Organizations.

    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

    The response body contains the following properties:

    Property

    Type

    Description

    results

    Results Object

    Contains the Results object.

    _links

    Dictionary of string [key] and Object [value]

    Links to related resources (navigation property).

    Results Object

    Property

    Type

    Description

    applicationId

    string

    Specifies an identification number of the application in Microsoft Azure.

    displayName

    string

    Specifies the backup application name.

    certificateThumbprint

    string

    Specifies the thumbprint of the used certificate.

    Example

    The example shows how to get a list of backup applications configured for the Microsoft organization with the ID 7a53143a-b7c8-4d5a-a569-7dcbca8ab71b.

    Request:

    GET https://abc.tech.local:4443/v6/Organizations/7a53143a-b7c8-4d5a-a569-7dcbca8ab71b/BackupApplications

     

    Request Header:

    Authorization: Bearer <Access-Token>

     

    Response:

    200 OK

     

    Response Body:

    {

      "offset": 0,

      "limit": 30,

      "results": [   {

         "applicationId": "eefb5987-1430-4768-a545-84c6abd1dbca",

         "displayName": "APP01",

         "certificateThumbprint": "8F0B564280FBDD3B41C8AED9B5628AEE91BD319D"

      }],

      "_links": {"self": {"href": "/v6/Organizations/7a53143a-b7c8-4d5a-a569-7dcbca8ab71b/BackupApplications?offset=0&limit=30"}}

    }