Fetch Hcp Names For Hosts

This API is to be used for fetching the Host Config Profile names for the specified hosts.

Request

URI

POST

https://{api_host}/hybridity/api/ztp/v1/host-config-profiles/hostnames

COPY

Request Body

The request payload for Fetch HCP Names for Hosts API.

InlineZtpV1HostConfigProfilesHostnamesRequestBody of type(s) application/json

Required

{
    "hosts": [
        "string"
    ]
}

array of string

hosts

Required

The FQDN of the host.

Authentication

This operation uses the following authentication methods.

x-hm-authorization

Responses

200

The request for fetching Host Config Profile names for the specified hosts is successful.

Returns Array of InlineZtpV1HostConfigProfilesHostnames200Response of type(s) application/json

[
    {
        "id": "string",
        "name": "string",
        "domainId": "string",
        "parent": "string",
        "hcpId": "string",
        "hcpName": "string"
    }
]

301

API endpoint has permanently moved.

Returns InlineZtpV1HostConfigProfilesHostnames301Response 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

Response may include details of why the request is bad.

Returns InlineZtpV1HostConfigProfilesHostnames400Response of type(s) application/json

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

array of object

warnings

Optional

The list of warnings.

array of object

errors

Optional

The list of errors.

401

User is not authenticated to invoke this endpoint.

Operation doesn't return any data structure

403

User is not authorized to invoke this endpoint.

Operation doesn't return any data structure

422

The request payload couldn't be processed by the server.

Returns InlineZtpV1HostConfigProfilesHostnames422Response of type(s) application/json

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

array of object

warnings

Optional

The list of warnings.

array of object

errors

Optional

The list of errors.

500

An internal server error has occurred.

Returns InlineZtpV1HostConfigProfilesHostnames500Response of type(s) application/json

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

array of object

warnings

Optional

The list of warnings.

array of object

errors

Optional

The list of errors.

On This Page

Description

Request

Request Body