Select the tab
ESET Connect – Table of Contents

GET List recent scan details

Relative path: /v1/scans/recent

List the scan details of all vulnerability scan attempts performed recently (within the last few days).

The list might be empty if no vulnerability scans have been performed recently.
Stale data (that is, not recent) is removed from the list over the course of several days.

Endpoint URL for Europe, Germany, United States, Canada and Japan regions:






Query parameters

Name

Type

Description

deviceUuid

string

Reference to the device whose vulnerability scan details should be listed.

If empty or null, vulnerability scan details of all devices accessible to the caller will be included in the response.

type: VulnerableDevice

deviceGroupUuid

string

Reference to the [device group].

If filled, only the vulnerability scan details of the devices within the group will be included in the response. If empty or null, scan details of any device accessible to the caller will be included in the response.

type: device_management.v1.DeviceGroup

pageSize

integer

Limit for pagination purposes.

If unspecified or 0, the default value is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.

Info: For more information, refer to Paginating Requests in APIs

or Design Patterns: Pagination

pageToken

string

Page token of the current page.

If not given or "", the first page is returned.

Info: For more information, refer to Paginating Requests in APIs

or Design Patterns: Pagination

Responses

Display Schema+Headers instead of an Example or vice-versa

Code

Description and Example

Description, Schema and Headers

200

Successful response.


Response example

{
  "scanDetails": [
    {
      "deviceUuid": "string",
      "endTime": "string",
      "endedSuccessfully": true,
      "scanTrigger": "SCAN_TRIGGER_UNSPECIFIED",
      "startTime": "string",
      "vulnerabilityCount": 0
    }
  ],
  "nextPageToken": "string"
}

Successful response.


Response schema

{
  "$ref": "v1ListRecentScanDetailsResponse",
  "scanDetails": [
    {
      "$ref": "v1ScanDetails",
      "description": "Details of the vulnerability scan.",
      "deviceUuid": {
        "type": "string",
        "description": "Reference to the [device] where the scan occurred; it might be empty if the scan was local (that is, on the very same device as the service). type: device_management.v1.Device"
      },
      "endTime": {
        "type": "string",
        "description": "Time when the scan response was returned.",
        "format": "date-time"
      },
      "endedSuccessfully": {
        "type": "boolean",
        "description": "True if the scan ended successfully, false otherwise."
      },
      "scanTrigger": {
        "$ref": "v1ScanTrigger",
        "type": "string",
        "description": "Possible triggers of a scan. SCAN_TRIGGER_UNSPECIFIED: fallback SCAN_TRIGGER_SCHEDULER: The scan was triggered by automation, for example, a scheduler. SCAN_TRIGGER_USER: The scan was triggered manually by a user.",
        "default": "SCAN_TRIGGER_UNSPECIFIED",
        "enum": [
          "SCAN_TRIGGER_UNSPECIFIED",
          "SCAN_TRIGGER_SCHEDULER",
          "SCAN_TRIGGER_USER"
        ]
      },
      "startTime": {
        "type": "string",
        "description": "Time when vulnerability management started the scan.",
        "format": "date-time"
      },
      "vulnerabilityCount": {
        "type": "integer",
        "description": "Number of detected vulnerabilities either in the applications or the operating system.",
        "format": "int64"
      }
    }
  ],
  "nextPageToken": {
    "type": "string",
    "description": "Page token of the next page. Empty or '' for the last page. Info: For more information, refer to Paginating Requests in APIs or Design Patterns: Pagination"
  }
}


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

202

Response took too long; request cached. Response can be retrieved later using the response-id header.

Response took too long; request cached. Response can be retrieved later using the response-id header.


Response schema

[]


Headers

{
  "response-id": {
    "description": "Unique ID of a pending request. Used to retrieve cached result.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  },
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

400

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.

One of the errors: 1. Bad or missing authorization. 2. Validation error. Invalid argument provided.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

401

Token has expired or is invalid.

Token has expired or is invalid.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

403

Access denied. Check permissions.

Access denied. Check permissions.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

404

Requested resource not found.

Requested resource not found.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

429

Rate limit reached. Try again later.

Rate limit reached. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

500

Internal server failure. Try again later.

Internal server failure. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

502

Internal server failure. Try again later.

Internal server failure. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

503

Environment under maintenance. Try again later.

Environment under maintenance. Try again later.


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}

504

Action took too long; timeout reached

Action took too long; timeout reached


Response schema

[]


Headers

{
  "request-id": {
    "description": "Unique ID of the request. Include in support requests.",
    "style": "simple",
    "explode": false,
    "schema": {
      "type": "string",
      "format": "uuid"
    }
  }
}