Run Feature Deployment Pre Checks

Begin execution of pre-checks for the feature specified in the API path parameter. These would run asynchronously on NAPP as pre-check jobs. Results can be monitored via pre-checks/status API.

Request

URI

POST

https://{api_host}/napp/api/v1/platform/features/{feature}/pre-checks

COPY

Path Parameters

Feature

feature

Required

Name of the feature for pre-check execution is to be performed. Please refer Feature enum for precise name.

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Responses

202

Pre-check execution started successfully.

Returns PreCheckResults of type(s) application/json

{
    "feature": "string",
    "results": [
        {
            "id": "string",
            "name": "string",
            "desc": "string",
            "feature": "string",
            "status": "string",
            "reason": "string"
        }
    ]
}

Feature

feature

Required

feature

array of CheckResult

results

Required

The list of pre check reports.

default

Pre-check execution could not be started. Please check connectivity to helm repository, since fetching metadata prior to deployment of pre-checks is required.

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

Description

Request

Path Parameters

Authentication

Response

202 Response Body

Errors