Get Command Result

This endpoint returns a specific command result.

Sample Request

curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandResultID} \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'

Basic Parameters

Parameter	Description
Fields	Use a space separated string of field parameters to include the data in the response. If omitted, the default list of fields will be returned.
Filter	A filter to apply to the query. See the supported operators below. For more complex searches,see the related /search/<domain> endpoints,e.g. /search/systems.Filter structure: <field>:<operator>:<value>.field = Populate with a valid field from an endpoint response.operator = Supported operators are: $eq (equals) $ne (does not equal) $gt (is greater than) $gte (is greater than or equal to) $lt (is less than) $lte (is less than or equal to) Note: v1 operators differ from v2 operators.Note: For v1 operators, excluding the $ will result in undefined behavior.value = Populate with the value you want to search for. Is case sensitive.Examples GET /users?filter=username:$eq:testuser GET /systemusers?filter=password_expiration_date:$lte:2021-10-24 GET /systemusers?filter=department:$ne:Accounting GET /systems?filter[0]=firstname:$eq:foo&filter[1]=lastname:$eq:bar - this willAND the filters together. GET /systems?filter[or][0]=lastname:$eq:foo&filter[or][1]=lastname:$eq:bar - this willOR the filters together.
ID	The command ID.

Advanced Parameters

Parameter	Description
Organization ID	Organization identifier that can be obtained from console settings.

Example Output

{
    "_id": "string",
    "command": "string",
    "files": [
        "string"
    ],
    "name": "string",
    "organization": "string",
    "requestTime": "2019-08-24T14:15:22Z",
    "response": {
        "data": {
            "exitCode": 0,
            "output": "string"
        },
        "error": "string",
        "id": "string"
    },
    "responseTime": "2019-08-24T14:15:22Z",
    "sudo": true,
    "system": "string",
    "systemId": "string",
    "user": "string",
    "workflowId": "string",
    "workflowInstanceId": "string"
}

Workflow Library Example

Get Command Result with Jumpcloud and Send Results Via Email

Preview this Workflow on desktop