Get Feature Deployment Pre Check Results

Get pre-check result of the feature specified in API path parameter.

Request

URI

GET

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

COPY

Path Parameters

Feature

feature

Required

Name of the feature for which pre-check status is to be retrieved. Please refer Feature enum for precise name.

Authentication

This operation uses the following authentication methods.

x_nsx_roles

Responses

200

Successfully retrieved the status of pre-checks.

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

Error occurred in fetching the pre-check status. Please check logs for cluster-api pod for more information.

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

200 Response Body

Errors