Hypervisors Api Get Agent Software Check

Hypervisors Api Get Agent Software Check
Get an Agent software check

The job with each host's outcome from this run. Jobs are kept in memory: an unknown id, or a job from before a Console restart, answers 404, which the page reports as interrupted. Requires the ADMIN, SECURITY_OPERATOR or AUDITOR role.

Request
URI
GET
https://{api_host}/api/v1/hypervisors/agent-software-checks/{jobId}
COPY
Path Parameters
string
jobId
Required  

Job id returned when the check was started

jobId example
vibjob-00000000-0000-4000-8000-000000000011

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK successful response envelope. The job and its progress

Returns AgentSoftwareCheckJob of type(s) application/json
{
    "jobId": "vibjob-00000000-0000-4000-8000-000000000011",
    "status": "COMPLETED_WITH_GAPS",
    "total": 2,
    "completed": 2,
    "installed": 1,
    "notInstalled": 0,
    "heldInstalled": 1,
    "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": "HELD_INSTALLED",
            "reason": "TIMEOUT"
        }
    ],
    "startedAt": "2026-01-16T10:00:00Z",
    "completedAt": "2026-01-16T10:01:10Z"
}
string
jobId
Required  

Identifier to poll with GET /api/v1/hypervisors/agent-software-checks/{jobId}

string
status
Required  

RUNNING while hosts remain. COMPLETED when this run confirmed or shared every host. COMPLETED_WITH_GAPS when any host was held or inconclusive. FAILED when the job stopped on an error.

Enumeration: RUNNING, COMPLETED, COMPLETED_WITH_GAPS, FAILED
integer As int32 As int32
total
Required  

Hosts in the job

integer As int32 As int32
completed
Required  

Hosts the job has finished with so far

integer As int32 As int32
installed
Required  

Hosts this run confirmed Installed

integer As int32 As int32
notInstalled
Required  

Hosts this run confirmed Not installed

integer As int32 As int32
heldInstalled
Required  

Hosts whose check timed out while the earlier Installed status was kept

integer As int32 As int32
shared
Required  

Hosts covered by another check, not verified by this run

integer As int32 As int32
inconclusive
Required  

Hosts this run could not confirm

array of object
hosts
Required  

One entry per host, in selection order

string As date-time As date-time
startedAt
Required  

Time the job started

string As date-time As date-time
completedAt
Optional

When the last host finished; null while running


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.


404

404 Not Found: no job with this id (empty body)

Operation doesn't return any data structure

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