Site Explorer

Retrieve all Explored Endpoints

Changed on

Retrieve explored endpoints discovered by Site Explorer for a Site. Use ID_ASC or ID_DESC to order by endpoint ID; the default is ID_ASC.

Optional machineId filtering is applied before pagination and the total count. It requires a site-agent and nico-api version that supports the filter; older versions may ignore it and return unfiltered results and pagination totals. An empty or malformed Machine ID returns HTTP 400 when the filter is supported.

The response is paged over Core FindExploredEndpointIds followed by FindExploredEndpointsByIds. Pagination metadata is returned in the X-Pagination response header.

User must have authorization role with PROVIDER_ADMIN suffix.

get/v2/org/{org}/nico/site-explorer/endpoint

Request

  • Base URL
    https://nico-rest-api.nico.svc.cluster.local
  • URL
    https://nico-rest-api.nico.svc.cluster.local/v2/org/{org}/nico/site-explorer/endpoint
  • Auth
    HTTP bearer

Query parameters

siteIdstring uuid required

ID of the Site

machineIdstring

Only return endpoints whose exploration report has this Machine ID. Omit to return all endpoints in the Site.

pageNumberinteger

One-indexed page number.

Page number of results returned

pageSizeinteger

Number of results per page

orderBy'ID_ASC' | 'ID_DESC'

Order results by endpoint ID

Response

Explored endpoints for the Site

addressstring required

BMC IP address used as the explored endpoint ID.

reportVersionstring required

Version of the exploration report; increases when the report is updated.

explorationRequestedboolean required

Whether the endpoint will be explored in the next Site Explorer run.

preingestionStatestring required

Current preingestion state for the endpoint.

lastRedfishBmcResetstring required

Last BMC Redfish reset time.

lastIpmitoolBmcResetstring required

Last BMC IPMI tool reset time.

lastRedfishRebootstring required

Last BMC Redfish reboot time.

lastRedfishPowercyclestring required

Last BMC Redfish power-cycle time.

pauseRemediationboolean required

When true, Site Explorer will not take remediation actions for Redfish errors.

Changes

  • 293dc126ab73Revision changes
    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

    • info

      removed the nico enum value from the response property for the response status

  • 78f3b35615a5Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status