Site Explorer

Retrieve all Explored Endpoints

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.

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

Query parameters

siteIdstring uuid required

ID of 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

Changed in 3 of the 94 revisions of this API.61

    • for the query request parameter pageNumber, the max was set to 21474836.00

      request-parameter-max-set

    • for the query request parameter pageSize, the max was set to 100.00

      request-parameter-max-set

    • for the query request parameter pageNumber, the min was set to 1.00

      request-parameter-min-set

    • for the query request parameter pageSize, the min was set to 1.00

      request-parameter-min-set

    • added the new Hibernating enum value to the items/report/systems/items/powerState response property for the response status 200

      response-property-enum-value-added

    • added the new Sleeping enum value to the items/report/systems/items/powerState response property for the response status 200

      response-property-enum-value-added

    • endpoint added

      endpoint-added