Scan Controller API v1

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Describes the API calls used to trigger the Constellation scan process.

Base URLs:

• /api/v1

Authentication

• HTTP Authentication, scheme: bearer

Scans

Retrieves status of all scans

Code samples

# You can also use wget
curl -X GET /api/v1/scans/allusers \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api/v1/scans/allusers HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/api/v1/scans/allusers',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/v1/scans/allusers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api/v1/scans/allusers', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/scans/allusers', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/scans/allusers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/v1/scans/allusers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /scans/allusers

This endpoint enables bulk retrieval of scan information from all users. Access to this functionality is restricted to requests that include a suitable ‘scope’.

The optional query parameters enable the results to be filtered by their start date, end date, the scan status and the scan’s owner.

Where a large number of scans are returned the results are paged, with links available to provide access to the ‘previous’ and ‘next’ page of results.

Parameters

Detailed descriptions

users: Include only scans submitted by the listed owners

pageSize: Limits the number of records returned in the response.

page: Identifies which page in the results is required. If the value exceeds the number of available pages, then the last page is returned.

Enumerated Values

Example responses

200 Response

{
  "total": 220,
  "scans": [
    {
      "scanOwner": "string",
      "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",
      "scanStatus": "Processing",
      "scanStartTime": "2019-08-24T14:15:22Z",
      "scanEndTime": "2019-08-24T14:15:22Z",
      "sourceStorage": "scan-source.blob.core.windows.net",
      "sourceContainerPath": "SourceContainer",
      "targetStorage": "output-location.blob.core.windows.net",
      "targetContainerPath": "TargetContainerName",
      "quarantineContainerPath": "QuarantineContainerName",
      "autoRescan": true,
      "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
      "childScans": null
    }
  ],
  "pageLinks": {
    "totalPages": 4,
    "curr": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=3",
    "next": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=4",
    "prev": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=2"
  }
}

Responses

Response Headers

Retrieves status of all self-started scans

Code samples

# You can also use wget
curl -X GET /api/v1/scans \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api/v1/scans HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/api/v1/scans',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/v1/scans',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api/v1/scans', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/scans', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/v1/scans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /scans

The optional query parameters enable the results to be filtered by their start date, end date, the scan status and the scan’s owner.

Only scans generated by the requester will be included in the response.

Where a large number of scans are returned the results are paged, with links available to provide access to the ‘previous’ and ‘next’ page of results.

Parameters

Detailed descriptions

pageSize: Limits the number of records returned in the response.

page: Identifies which page in the results is required. If the value exceeds the number of available pages, then the last page is returned.

Enumerated Values

Example responses

200 Response

{
  "total": 220,
  "scans": [
    {
      "scanOwner": "string",
      "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",
      "scanStatus": "Processing",
      "scanStartTime": "2019-08-24T14:15:22Z",
      "scanEndTime": "2019-08-24T14:15:22Z",
      "sourceStorage": "scan-source.blob.core.windows.net",
      "sourceContainerPath": "SourceContainer",
      "targetStorage": "output-location.blob.core.windows.net",
      "targetContainerPath": "TargetContainerName",
      "quarantineContainerPath": "QuarantineContainerName",
      "autoRescan": true,
      "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
      "childScans": null
    }
  ],
  "pageLinks": {
    "totalPages": 4,
    "curr": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=3",
    "next": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=4",
    "prev": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=2"
  }
}

Responses

Response Headers

Starts a new scan of the specified storage container

Code samples

# You can also use wget
curl -X POST /api/v1/scans \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

POST /api/v1/scans HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "sourceConnectionString": "BlobEndpoint=https://scantest.blob.core.windows.net/;QueueEn......%3D",
  "sourceContainerPath": "sourceContainer",
  "destinationConnectionString": "BlobEndpoint=https://scantest.blob.core.windows.net/;QueueEn......%3D",
  "targetContainerPath": "targetContainerName",
  "quarantineContainerPath": "quarantineContainerName",
  "autoRescan": false
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/api/v1/scans',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/api/v1/scans',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/api/v1/scans', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/api/v1/scans', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/scans");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/api/v1/scans", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /scans

This will start a new scan of the specified storage container

Body parameter

{
  "sourceConnectionString": "BlobEndpoint=https://scantest.blob.core.windows.net/;QueueEn......%3D",
  "sourceContainerPath": "sourceContainer",
  "destinationConnectionString": "BlobEndpoint=https://scantest.blob.core.windows.net/;QueueEn......%3D",
  "targetContainerPath": "targetContainerName",
  "quarantineContainerPath": "quarantineContainerName",
  "autoRescan": false
}

Parameters

Example responses

200 Response

{
  "scanOwner": "string",
  "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",
  "scanStatus": "Processing",
  "scanStartTime": "2019-08-24T14:15:22Z",
  "scanEndTime": "2019-08-24T14:15:22Z",
  "sourceStorage": "scan-source.blob.core.windows.net",
  "sourceContainerPath": "SourceContainer",
  "targetStorage": "output-location.blob.core.windows.net",
  "targetContainerPath": "TargetContainerName",
  "quarantineContainerPath": "QuarantineContainerName",
  "autoRescan": true,
  "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
  "childScans": null
}

Responses

Response Headers

Retrieves status of the specified scan.

Code samples

# You can also use wget
curl -X GET /api/v1/scans/{scanId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET /api/v1/scans/{scanId} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/api/v1/scans/{scanId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/api/v1/scans/{scanId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/api/v1/scans/{scanId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/v1/scans/{scanId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/scans/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/v1/scans/{scanId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /scans/{scanId}

This endpoint enables information regarding the status of the specified scan to be retrieved.

Requests submitted with the ‘StandardUser’ role are only permitted to view self-started scans.

Parameters

Example responses

200 Response

{
  "scanOwner": "string",
  "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",
  "scanStatus": "Processing",
  "scanStartTime": "2019-08-24T14:15:22Z",
  "scanEndTime": "2019-08-24T14:15:22Z",
  "sourceStorage": "scan-source.blob.core.windows.net",
  "sourceContainerPath": "SourceContainer",
  "targetStorage": "output-location.blob.core.windows.net",
  "targetContainerPath": "TargetContainerName",
  "quarantineContainerPath": "QuarantineContainerName",
  "autoRescan": true,
  "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
  "childScans": null
}

Responses

Response Headers

Cancels the specified scan.

Code samples

# You can also use wget
curl -X DELETE /api/v1/scans/{scanId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

DELETE /api/v1/scans/{scanId} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/api/v1/scans/{scanId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.delete '/api/v1/scans/{scanId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.delete('/api/v1/scans/{scanId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/api/v1/scans/{scanId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/scans/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/api/v1/scans/{scanId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /scans/{scanId}

This endpoint enables an active scan to be cancelled. The action of cancellation stops the cataloging action of the scan from finding files in the specified container. Any files that have already been found and submitted for processing will continue to be processed.

Requests submitted with the ‘StandardUser’ role are only permitted to cancel self-started scans.

Parameters

Example responses

202 Response

{
  "scanOwner": "string",
  "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",
  "scanStatus": "Processing",
  "scanStartTime": "2019-08-24T14:15:22Z",
  "scanEndTime": "2019-08-24T14:15:22Z",
  "sourceStorage": "scan-source.blob.core.windows.net",
  "sourceContainerPath": "SourceContainer",
  "targetStorage": "output-location.blob.core.windows.net",
  "targetContainerPath": "TargetContainerName",
  "quarantineContainerPath": "QuarantineContainerName",
  "autoRescan": true,
  "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
  "childScans": null
}

Responses

Response Headers

Restarts an existing scan.

Code samples

# You can also use wget
curl -X PATCH /api/v1/scans/{scanId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH /api/v1/scans/{scanId} HTTP/1.1

Accept: application/json

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('/api/v1/scans/{scanId}',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/api/v1/scans/{scanId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/api/v1/scans/{scanId}', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/api/v1/scans/{scanId}', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/v1/scans/{scanId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/api/v1/scans/{scanId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /scans/{scanId}

When a scan completes, if any files have been added to the container during or after the scan they may not be included in the scan results. This endpoint enables a scan to be restarted to include those new files.

Requests submitted with the ‘StandardUser’ role are only permitted to restart self-started scans.

Rescans are not permitted whilst the original/parent scan is still in the ‘Listing’ status.

Parameters

Example responses

200 Response

{
  "scanOwner": "string",
  "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",
  "scanStatus": "Processing",
  "scanStartTime": "2019-08-24T14:15:22Z",
  "scanEndTime": "2019-08-24T14:15:22Z",
  "sourceStorage": "scan-source.blob.core.windows.net",
  "sourceContainerPath": "SourceContainer",
  "targetStorage": "output-location.blob.core.windows.net",
  "targetContainerPath": "TargetContainerName",
  "quarantineContainerPath": "QuarantineContainerName",
  "autoRescan": true,
  "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
  "childScans": null
}

Responses

Response Headers

Schemas

ScanStartItem

{
  "sourceConnectionString": "BlobEndpoint=https://scantest.blob.core.windows.net/;QueueEn......%3D",
  "sourceContainerPath": "sourceContainer",
  "destinationConnectionString": "BlobEndpoint=https://scantest.blob.core.windows.net/;QueueEn......%3D",
  "targetContainerPath": "targetContainerName",
  "quarantineContainerPath": "quarantineContainerName",
  "autoRescan": false
}

Properties

ScanStatusItemList

{
  "total": 220,
  "scans": [
    {
      "scanOwner": "string",
      "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",
      "scanStatus": "Processing",
      "scanStartTime": "2019-08-24T14:15:22Z",
      "scanEndTime": "2019-08-24T14:15:22Z",
      "sourceStorage": "scan-source.blob.core.windows.net",
      "sourceContainerPath": "SourceContainer",
      "targetStorage": "output-location.blob.core.windows.net",
      "targetContainerPath": "TargetContainerName",
      "quarantineContainerPath": "QuarantineContainerName",
      "autoRescan": true,
      "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
      "childScans": null
    }
  ],
  "pageLinks": {
    "totalPages": 4,
    "curr": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=3",
    "next": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=4",
    "prev": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=2"
  }
}

Properties

ScanStatusItemListAllUsers

{
  "total": 220,
  "scans": [
    {
      "scanOwner": "string",
      "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",
      "scanStatus": "Processing",
      "scanStartTime": "2019-08-24T14:15:22Z",
      "scanEndTime": "2019-08-24T14:15:22Z",
      "sourceStorage": "scan-source.blob.core.windows.net",
      "sourceContainerPath": "SourceContainer",
      "targetStorage": "output-location.blob.core.windows.net",
      "targetContainerPath": "TargetContainerName",
      "quarantineContainerPath": "QuarantineContainerName",
      "autoRescan": true,
      "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
      "childScans": null
    }
  ],
  "pageLinks": {
    "totalPages": 4,
    "curr": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=3",
    "next": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=4",
    "prev": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=2"
  }
}

Properties

ScanStatusItem

{
  "scanOwner": "string",
  "scanId": "83d71394-faa2-4b6c-b13b-6d3118de459e",
  "scanStatus": "Processing",
  "scanStartTime": "2019-08-24T14:15:22Z",
  "scanEndTime": "2019-08-24T14:15:22Z",
  "sourceStorage": "scan-source.blob.core.windows.net",
  "sourceContainerPath": "SourceContainer",
  "targetStorage": "output-location.blob.core.windows.net",
  "targetContainerPath": "TargetContainerName",
  "quarantineContainerPath": "QuarantineContainerName",
  "autoRescan": true,
  "parentScan": "f18eda36-7eb5-477a-a1b1-51c71ab2ba81",
  "childScans": null
}

Properties

Enumerated Values

ScanResultsLinks

{
  "totalPages": 4,
  "curr": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=3",
  "next": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=4",
  "prev": "/scans?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=2"
}

These links provide access to the paged results either side of the current page segment
along with the total number of pages.

If the number of results returned is within a single page segment, then these links are not included in the response.

Properties

ScanResultsLinksAllUsers

{
  "totalPages": 4,
  "curr": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=3",
  "next": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=4",
  "prev": "/scans/allusers?startDate=2022-12-20T16:44:41.741Z?endDate=2022-12-20T16:44:41.741Z?scanStatus=Processing&scanStatus=Completed?pageSize=10?page=2"
}

These links provide access to the paged results either side of the current page segment, along with the total number of pages.

If the number of results returned is within a single page segment, then these links are not included in the response.

Properties

PageLinksForFiles

{
  "totalPages": 4,
  "curr": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=3",
  "next": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=4",
  "prev": "/scan-results/{scanId}/files?pageSize=100?includeRebuilt=true?page=2"
}

These links provide access to the paged results either side of the current page segment, along with the total number of pages.

If the number of results returned is within a single page segment, then these links are not included in the response.

Properties

PageLinksForArchives

{
  "totalPages": 4,
  "curr": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=3",
  "next": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=4",
  "prev": "/scan-results/{scanId}/files/{fileId}?pageSize=100?includeRebuilt=true?page=2"
}

These links provide access to the paged results either side of the current page segment, along with the total number of pages.

If the number of results returned is within a single page segment, then these links are not included in the response.

Properties

ScanFilesAssessmentMetadata

{
  "fileLocation": "supported/1/test.png",
  "fileSize": 123456,
  "fileHash": "n4bQgYhMfWWaL+qgxVrQFaO/TxsrC4Is0V1sFbDwCgg=",
  "fileId": "cd88f362-6c83-49a1-bbcb-7c08389a0caa",
  "status": "Failed"
}

Properties

Enumerated Values

EmptyContainerErrorResponseList

[
  {
    "errorCode": 107,
    "message": "Source container was empty."
  }
]

List of errors found during validation

Properties

ErrorResponseList

[
  {
    "errorCode": 105,
    "message": "The signed start (se) parameter must be in the future for the source connection string."
  }
]

List of errors found during validation

Properties

CacheControlHeader

"no-store"

Prevent sensitive information from being cached.

Properties

ContentTypeHeader

"application/json"

Indicates the response content type

Properties

ContentTypeOptionsHeader

"nosniff"

To prevent browsers from performing MIME sniffing, and inappropriately interpreting responses as HTML.

Properties

FrameOptionsHeader

"DENY"

To protect against drag-and-drop style clickjacking attacks.

Properties

ContentSecurityPolicyHeader

"frame-ancestors 'none'"

To protect against drag-and-drop style clickjacking attacks.

Properties

StrictTransportSecurityHeader

"max-age=604800"

Uses a week long max-age to prevent any communications from being sent to this domain over HTTP

Properties