[{"label":"Latest (v1.0)","version":"latest"}]
nsx-intelligence-and-application-platform

Report Pre Check

Description

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

Request

URL

URL


post
https://{api_host}/napp/api/v1/platform/report/precheck
Copy

Request Body

Request Body

CheckResult of mimetype application/json Required
{
	"desc": "string",
	"feature": "malware-prevention",
	"id": "string",
	"name": "string",
	"reason": "string",
	"status": "SUCCESS"
}
string
desc Required

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


feature Required

Possible values are: malware-preventioncloud-connectorintelligenceintelligence-migrationmetricsndrreputation-service


string
id Required

Unique identification for the pre-check.


string
name Required

Name of the pre-check.


string
reason Required

The reason, especially needed when the status is abnormal.


status Required

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

Possible values are: SUCCESSFAILEDWARNINGSKIPPEDINPROGRESSSTOPPINGSTOPPEDPENDINGNOT_STARTED

Authentication

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Scopes: enterprise_admin

Response

Response

Response Body

Response Body

200 OK returns CheckResult of type application/json

Successfully updated the pre-check status at backend.

string
desc Required

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


feature Required

Possible values are: malware-preventioncloud-connectorintelligenceintelligence-migrationmetricsndrreputation-service


string
id Required

Unique identification for the pre-check.


string
name Required

Name of the pre-check.


string
reason Required

The reason, especially needed when the status is abnormal.


status Required

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

Possible values are: SUCCESSFAILEDWARNINGSKIPPEDINPROGRESSSTOPPINGSTOPPEDPENDINGNOT_STARTED

Errors

Errors

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.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"desc":"string","feature":"malware-prevention","id":"string","name":"string","reason":"string","status":"SUCCESS"}' https://{api_host}/napp/api/v1/platform/report/precheck


Feedback

Was this page helpful?