Table of Contents

Retrieve All Scan Profiles

Use this API to retrieve all the scan profiles configured for a specific customer in AvePoint Online Services.

Permissions

The following permission is required to call the API.
You must register an app through Elements for Partners > API app registration to authenticate and authorize your access to AvePoint Graph API. For details, refer to App Registration.

API Permission
/partner/customers/{id}/scanProfiles partner.scanprofiles.read.all

Request

This section outlines the HTTP method and endpoint used to retrieve your customer's information for all scan profiles configured in AvePoint Online Services.

Method Endpoint Description
GET /partner/customers/{id}/scanProfiles Retrieves all the scan profiles configured for a specific customer in AvePoint Online Services.

Query Parameters

This section outlines the parameters required to specify which customer's scan profile information you want to retrieve.

Parameter Description Type Required
Id The tenant owner ID of the customer. string Yes

Response

If the request has been successfully processed, a 200 OK response will be returned along with the requested information displayed in the response body.

Response Description Type
profileName The name of the scan profile. string
profileId The ID of the scan profile. string
scanMode The scan mode of the scan profile:
  • 0 represents Express mode
  • 1 represents Advanced mode
 integer
modifiedTime The last modified time of the scan profile. string

Request Sample

To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references.

https://graph.avepointonlineservices.com/partner/customers/caf94a89-2cc6-47aa-b04b-794cb9af5ea3/scanProfiles

Response Sample

If the request has been successfully processed, a 200 OK response will be returned along with the requested information displayed in the response body. For more details on the HTTP status code, refer to Http Status Code.

{
    "@odata.context": "https://graph.avepointonlineservices.com/partner/$metadata#Collection(Portal.Api.Model.ProfileInfo)",
    "value": [
        {
            "profileName": "test oop", // The name of the scan profile
            "profileId": "0e5e152d-65cc-65cc-65cc-65cc65cc65cc", // The ID of the scan profile
            "scanMode": 0, // The scan mode of the scan profile: 0 represents Express mode
            "modifiedTime": "2024-12-27T17:08:24Z" // The last modified time of the scan profile
        }
    ]
}