API ReferenceSite Explorer

Trigger Site Explorer Endpoint Action

View as Markdown

Clear the last exploration error or queue re-exploration for all explored endpoints at a Site or an explicit BMC IP address list.

The operation calls Core once per endpoint. If a call fails, processing stops and endpoints earlier in the list may already have completed.

User must have authorization role with PROVIDER_ADMIN suffix.

Authentication

AuthorizationBearer
``` export JWT_BEARER_TOKEN="<jwt-bearer-token>" # Example org name: "acme-inc export ORG_NAME=<org-name> # Use the JWT bearer token in your API request auth header: curl -v -X GET -H "Content-Type: application/json" -H "Authorization: Bearer $JWT_BEARER_TOKEN" https://nico-rest-api.nico.svc.cluster.local/v2/org/$ORG_NAME/nico/user/current ```

Path parameters

orgstringRequired
Name of the Org

Request

This endpoint expects an object.
siteIdstringRequiredformat: "uuid"
ID of the Site whose explored endpoints are targeted.
actionenumRequired
Site Explorer endpoint action to trigger.
targetenumRequired
Endpoint set to target.
endpointIdslist of stringsOptional
BMC IP addresses to target when target is EndpointIds.

Response

The action completed for every selected endpoint.
siteIdstringformat: "uuid"
ID of the Site whose explored endpoints were targeted.
actionenum
Site Explorer endpoint action that completed.
targetenum
Endpoint set that was selected.
endpointIdslist of strings
BMC IP addresses for which the action completed.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
412
Precondition Failed Error
500
Internal Server Error
504
Gateway Timeout Error