Policies

Get a specific Policy Result.

This endpoint will return the policy results for a specific policy.

Sample Request
curl -X GET https://console.jumpcloud.com/api/v2/policyresults/{Policy_ID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
get/policyresults/{id}

Request

Headers

x-org-idstring

Organization identifier that can be obtained from console settings.

Response

OK

detailstring

Details pertaining to the policy result.

endedAtstring date-time

The end of the policy application.

exitStatusinteger

The 32-bit unsigned exit status from the applying the policy.

idstring

ObjectId uniquely identifying a Policy Result.

policyIDstring

ObjectId uniquely identifying the parent Policy.

startedAtstring date-time

The start of the policy application.

statestring

Enumeration describing the state of the policy. Success, failed, or pending.

stdErrstring

The STDERR output from applying the policy.

stdOutstring

The STDOUT output from applying the policy.

successboolean

True if the policy was successfully applied; false otherwise.

systemIDstring

ObjectId uniquely identifying the parent System.

userObjectIdstring

ObjectId uniquely identifying the parent User.

Changes

No recorded changes to this operation across all 1 revision of this API.