Get Host Validation State

Get Current state and details of the host being validated.

Request

URI

POST

https://{api_host}/hybridity/api/ztp/host/validator/state

COPY

Request Body

List of hosts FQDN OR HOSTNAME

getHostValidationStateRequest of type(s) application/json

Required

{
    "hosts": [
        "string"
    ]
}

array of string

hosts

Optional

FQDN or hostname of the host using which validation was triggered

Authentication

This operation uses the following authentication methods.

x-hm-authorization

Responses

200

Response with Host validation state

Returns getHostValidationStateResponse of type(s) application/json

{
    "hosts": [
        {
            "hostname": "hostname",
            "host_validation_state": "COMPLETED",
            "stages": {
                "key": {
                    "status_code": "status_code",
                    "method_name": "method_name",
                    "state": "PASSED",
                    "message": "message"
                }
            },
            "message": "message"
        },
        {
            "hostname": "hostname",
            "host_validation_state": "COMPLETED",
            "stages": {
                "key": {
                    "status_code": "status_code",
                    "method_name": "method_name",
                    "state": "PASSED",
                    "message": "message"
                }
            },
            "message": "message"
        }
    ]
}

array of getHostValidationHostState

hosts

Optional

list of hosts with their validation details

301

API endpoint has permanently moved.

Returns redirectResponse of type(s) application/json

{
    "redirectURL": "string"
}

string

redirectURL

Optional

redirectURL

Response Headers

string

Location

URI where the client will find the new endpoint.

400

Bad Request

Returns response of type(s) application/json

{
    "warnings": [
        {
            "stack": "stack",
            "code": "code",
            "message": "message"
        },
        {
            "stack": "stack",
            "code": "code",
            "message": "message"
        }
    ],
    "errors": [
        {
            "stack": "stack",
            "code": "code",
            "message": "message"
        },
        {
            "stack": "stack",
            "code": "code",
            "message": "message"
        }
    ]
}

array of warning

warnings

Optional

warnings

array of error

errors

Optional

errors

401

Unauthorized

Operation doesn't return any data structure

403

Forbidden

Operation doesn't return any data structure

500

Internal Server Error

Returns response of type(s) application/json

{
    "warnings": [
        {
            "stack": "stack",
            "code": "code",
            "message": "message"
        },
        {
            "stack": "stack",
            "code": "code",
            "message": "message"
        }
    ],
    "errors": [
        {
            "stack": "stack",
            "code": "code",
            "message": "message"
        },
        {
            "stack": "stack",
            "code": "code",
            "message": "message"
        }
    ]
}

array of warning

warnings

Optional

warnings

array of error

errors

Optional

errors

On This Page

Description

Request

Request Body