Hypervisors Api Start Agent Software Check

Hypervisors Api Start Agent Software Check
Check the Agent software of the selected hypervisors

Starts a check of 1 to 10 selected hypervisors (the limit is vtp.discovery.software-inventory.manual-max-hosts, at most 25) and answers at once. Hosts are checked one at a time. The server derives each host's source: its vCenter connection, or the host itself when standalone. At most 2 checks run at once and one per source; there is no queue. Requires the ADMIN role.

Request
URI
POST
https://{api_host}/api/v1/hypervisors/agent-software-checks
COPY
Request Body

The hypervisor ids to check

AgentSoftwareCheckRequest of type(s) application/json
Required  

Show optional properties

{
    "hypervisorIds": [
        {}
    ]
}
{
    "hypervisorIds": [
        101,
        102
    ]
}
array of integer
hypervisorIds
Required  
Constraints: minItems: 1 maxItems: 25

Hypervisor ids, 1 to the configured limit (default 10)

Authentication
This operation uses the following authentication methods.
Responses
200

200 OK: the identical selection is already running; its job is returned and nothing new starts.

Returns AgentSoftwareCheckJob of type(s) application/json
{
    "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
}
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


202

202 Accepted: the check started. It continues after the response; poll GET /api/v1/hypervisors/agent-software-checks/{jobId} for the outcome.

Returns AgentSoftwareCheckJob of type(s) application/json
{
    "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
}
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


400

400 Bad Request: VIB_CHECK_INVALID_SELECTION. No host, too many hosts, a duplicate, or a host that is unknown, not active or has no source.

Returns AgentSoftwareCheckError of type(s) application/json
{
    "code": "VIB_CHECK_INVALID_SELECTION",
    "message": "Select at most 10 hosts to check at a time.",
    "runningJobId": null,
    "busySources": []
}
string
code
Required  

Machine-readable reason

Enumeration: VIB_CHECK_INVALID_SELECTION, VIB_CHECK_SOURCE_BUSY, VIB_CHECK_CAPACITY, VIB_CHECK_UNAVAILABLE
string
message
Required  

Text safe to show to the operator

string
runningJobId
Optional

For VIB_CHECK_SOURCE_BUSY, the running job that holds the source

array of string
busySources
Optional

For VIB_CHECK_SOURCE_BUSY, the sources held, as vcenter: or standalone:


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.


409

409 Conflict: VIB_CHECK_SOURCE_BUSY. A different selection shares a source that a running check already covers.

Returns AgentSoftwareCheckError of type(s) application/json
{
    "code": "VIB_CHECK_SOURCE_BUSY",
    "message": "An Agent software check is already running for vcenter:db-1. Wait for it to finish, then check again.",
    "runningJobId": "vibjob-00000000-0000-4000-8000-000000000011",
    "busySources": [
        "vcenter:db-1"
    ]
}
string
code
Required  

Machine-readable reason

Enumeration: VIB_CHECK_INVALID_SELECTION, VIB_CHECK_SOURCE_BUSY, VIB_CHECK_CAPACITY, VIB_CHECK_UNAVAILABLE
string
message
Required  

Text safe to show to the operator

string
runningJobId
Optional

For VIB_CHECK_SOURCE_BUSY, the running job that holds the source

array of string
busySources
Optional

For VIB_CHECK_SOURCE_BUSY, the sources held, as vcenter: or standalone:


429

429 Too Many Requests: VIB_CHECK_CAPACITY. Two checks are already running.

Returns AgentSoftwareCheckError of type(s) application/json
{
    "code": "VIB_CHECK_CAPACITY",
    "message": "The Console is already running 2 Agent software checks. Try again in a moment.",
    "runningJobId": null,
    "busySources": []
}
string
code
Required  

Machine-readable reason

Enumeration: VIB_CHECK_INVALID_SELECTION, VIB_CHECK_SOURCE_BUSY, VIB_CHECK_CAPACITY, VIB_CHECK_UNAVAILABLE
string
message
Required  

Text safe to show to the operator

string
runningJobId
Optional

For VIB_CHECK_SOURCE_BUSY, the running job that holds the source

array of string
busySources
Optional

For VIB_CHECK_SOURCE_BUSY, the sources held, as vcenter: or standalone:

Response Headers

integer
Retry-After

Seconds to wait before trying again.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"hypervisorIds":["integer"]}' https://{api_host}/api/v1/hypervisors/agent-software-checks