Hypervisors Api List Active Agent Software Checks

Hypervisors Api List Active Agent Software Checks
List the running Agent software checks

Checks still running, oldest first; empty when none. Lets a reloaded page pick up a check. Jobs are held in memory only. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.

Request
URI
GET
https://{api_host}/api/v1/hypervisors/agent-software-checks/active
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The running checks

[
    {
        "jobId": "vibjob-00000000-0000-4000-8000-000000000011",
        "status": "RUNNING",
        "total": 2,
        "completed": 1,
        "installed": 1,
        "notInstalled": 0,
        "heldInstalled": 0,
        "shared": 0,
        "inconclusive": 0,
        "hosts": [
            {
                "hypervisorId": 101,
                "hostname": "host-a.example.com",
                "source": "vcenter:db-1",
                "outcome": "INSTALLED",
                "reason": null
            },
            {
                "hypervisorId": 102,
                "hostname": "host-b.example.com",
                "source": "vcenter:db-1",
                "outcome": "CHECKING",
                "reason": null
            }
        ],
        "startedAt": "2026-01-16T10:00:00Z",
        "completedAt": null
    }
]
array of object
Optional

One targeted Agent software check. Every count describes this run, not the stored status. Jobs are held in memory and not persisted.


401

401 Unauthorized: UNAUTHENTICATED when the VTP_SESSION cookie is missing, unknown, expired or revoked

Returns Unauthenticated of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


403

403 Forbidden: FORBIDDEN or CSRF_ERROR. CSRF_ERROR when the X-XSRF-TOKEN header is missing or wrong on a POST, PUT, PATCH or DELETE (only POST /api/v1/auth/login is exempt, and a request without a valid session gets 401 UNAUTHENTICATED instead); PASSWORD_CHANGE_REQUIRED when the account must change its password first (only GET /api/v1/auth/session, POST /api/v1/auth/logout and POST /api/v1/auth/change-password are exempt); LICENSE_REQUIRED or LICENSE_EXPIRED while the license pool is restricted (no license, or expired past grace) (exempt: every route under /api/v1/auth, GET /api/v1/user/preferences, GET /api/v1/licensing/summary and POST /api/v1/licensing/licenses)

Returns ApiErrorResponse of type(s) application/json
{
    "errorCode": "string",
    "message": "string",
    "path": "string",
    "timestamp": "string",
    "reason": "string"
}
errorCode
Required  

Stable machine-readable error code. The known values are listed in ApiErrorCode; the set is not closed, so a client must tolerate an unlisted value.

string
message
Required  

Human-readable error description

string
path
Required  

Request URI path that produced the error

string As date-time As date-time
timestamp
Required  

Timestamp when the error occurred as an ISO 8601 date-time with offset

string
reason
Optional

A finer code, present only where an endpoint documents it. The Rule Pack endpoints' PACK_ENTRY_INVALID carries the import core's code here.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/hypervisors/agent-software-checks/active