Admin - WorkspaceInfo GetScanStatus

Gets the scan status for the specified scan.

Permissions

The user must have administrator rights (such as Microsoft 365 Global Administrator or Power BI Service Administrator) or authenticate using a service principal.

When running under service principal authentication, an app must not have any admin-consent required permissions for Power BI set on it in the Azure portal.

Required Scope

Tenant.Read.All or Tenant.ReadWrite.All

Relevant only when authenticating via a standard delegated admin access token. Must not be present when authentication via a service principal is used.

Limitations

Maximum 10,000 requests per hour.

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanStatus/{scanId}

URI Parameters

Name In Required Type Description
scanId
path True

string

uuid

The scan ID, which is included in the response from the workspaces or the Admin - WorkspaceInfo PostWorkspaceInfo API call that triggered the scan.

Responses

Name Type Description
200 OK

ScanRequest

OK

Examples

Example

Sample Request

GET https://api.powerbi.com/v1.0/myorg/admin/workspaces/scanStatus/e7d03602-4873-4760-b37e-1563ef5358e3

Sample Response

{
  "id": "e7d03602-4873-4760-b37e-1563ef5358e3",
  "createdDateTime": "2020-06-15T16:46:28.0487687Z",
  "status": "Succeeded"
}

Definitions

Name Description
PowerBIApiErrorResponseDetail

Detailed information about a Power BI error response

ScanRequest

A scan request

PowerBIApiErrorResponseDetail

Detailed information about a Power BI error response

Name Type Description
code

string

The error code

message

string

The error message

target

string

The error target

ScanRequest

A scan request

Name Type Description
createdDateTime

string

The scan creation date and time

error

PowerBIApiErrorResponseDetail

The scan error (if any)

id

string

The scan ID

status

string

The scan state