HostingAntivirusNullableResponse

Successful response with one HostingAntivirus, or null

errorintegerrequired

Always 0 in a successful response

Constant value: 0

messagestring | nullnullablerequired

Always null in a successful response

data objectrequired

Resource returned by the operation, or null: the description of the response says when

anyOf

• HostingAntivirus
• null

antivirus_idintegerrequired

Id of the scan (GET /api/v3/hostings/{hosting_id}/antivirus/scans/{antivirus_id})

hosting_idinteger | nullnullablerequired

Id of the main hosting (GET /api/v3/hostings/{hosting_id}): the scan covers its whole space, subdomains included

status_codestring | nullnullablerequired

Status of the scan: RUNNING, FAILED, SUCCESS (no infection found) or PROBLEM (infections found)

status_namestring | nullnullablerequired

Translated name of the status, for display

status_colorstring | nullnullablerequired

Color of the status, in hexadecimal, for display

antivirus_typestringrequired

Type of the scan: M manual, A automatic

date_starteddate-timenullablerequired

Start of the scan, as sent by the antivirus; null until the scan completes, and for a failed scan

date_completeddate-timenullablerequired

End of the scan, as sent by the antivirus; null until the scan completes, and for a failed scan

date_timeoutdate-timenullablerequired

When the scan was marked as failed because it ran too long; null otherwise

total_filesinteger | nullnullablerequired

Files scanned; null when zero, and until the scan completes

total_infectedinteger | nullnullablerequired

Infected files found; null when zero, and until the scan completes

total_cleanedinteger | nullnullablerequired

Infected files cleaned by the antivirus; null when zero, and until the scan completes

metarequired

Always null: only the paginated lists have a meta

Constant value: null

HostingAntivirusNullableResponse

{
  "error": 0,
  "message": "string",
  "data": {
    "antivirus_id": 0,
    "hosting_id": 0,
    "status_code": "string",
    "status_name": "string",
    "status_color": "string",
    "antivirus_type": "string",
    "date_started": "2024-07-29T15:51:28.071Z",
    "date_completed": "2024-07-29T15:51:28.071Z",
    "date_timeout": "2024-07-29T15:51:28.071Z",
    "total_files": 0,
    "total_infected": 0,
    "total_cleaned": 0
  }
}