Report Pre Check

Report Pre Check

POST hook to record pre-check status as provided by pre-check jobs. Updating directly by end-user may result in incorrect system state, causing deployment failure.

Request
URI
POST
https://{api_host}/napp/api/v1/platform/report/precheck
COPY
Request Body
CheckResult of type(s) application/json
Required 
{
    "id": "string",
    "name": "string",
    "desc": "string",
    "feature": "string",
    "status": "string",
    "reason": "string"
}
string
id
Required

Unique identification for the pre-check.

string
name
Required

Name of the pre-check.

string
desc
Required

Description of the pre-check - specifying what is being checked.

Feature
feature
Required

feature

CheckStatus
status
Required

Status of an individual pre-check for the given feature.

string
reason
Required

The reason, especially needed when the status is abnormal.

Authentication
This operation uses the following authentication methods.
Responses
200

Successfully updated the pre-check status at backend.

Returns CheckResult of type(s) application/json 
{
    "id": "string",
    "name": "string",
    "desc": "string",
    "feature": "string",
    "status": "string",
    "reason": "string"
}
string
id
Required

Unique identification for the pre-check.

string
name
Required

Name of the pre-check.

string
desc
Required

Description of the pre-check - specifying what is being checked.

Feature
feature
Required

feature

CheckStatus
status
Required

Status of an individual pre-check for the given feature.

string
reason
Required

The reason, especially needed when the status is abnormal.


default

An error occurred while updating the pre-check status. Please refer logs for cluster-api pod to get more information. Recovery includes re-running the pre-checks from UI.

Returns Error of type(s) application/json 
{
    "code": 0,
    "message": "string"
}
integer As int32 As int32
code
Required

Error code refers to either HTTP status code OR a unique code identifying the internal error - which can be referenced in VMware documents for more information.

string
message
Required

Descriptive user understandable error message to help identify root cause of the error.


On This Page
Clusterapi Operations
POST
Clear Feature Deployment Pre Checks
GET
Get Cloud Connector Feature Configurations
GET
Get Cloud Connector Regions
GET
Get Feature Deployment Pre Check Results
GET
Get Feature Deployment Status
GET
Get Features Versions
GET
Get Intelligence Feature Configurations
GET
Get Malware Prevention Feature Configurations
GET
Get NDR Feature Configurations
POST
Manage Feature Deployment
POST
Report Pre Check
POST
Run Feature Deployment Pre Checks
PATCH
Update Cloud Connector Feature Configurations
PATCH
Update Intelligence Feature Configurations
PATCH
Update Malware Prevention Feature Configurations
PATCH
Update NDR Feature Configurations