Commands

Run a command

This endpoint allows you to run a command.

Sample Request

curl -X POST https://console.jumpcloud.com/api/runCommand \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: {API_KEY}'
  -d '{"_id":"{commandID}", "systemIds":["systemId"]}'

post/runCommand

Request

Base URL
https://console.jumpcloud.com/api
Auth
API key in header x-api-key
TypeScript
https://skmtc.dev/jumpcloud/apis/jumpcloud-api/docs/runCommand/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

_idstring

The ID of the command.

systemIdsstring[]

An optional list of device IDs to run the command on. If omitted, the command will run on devices bound to the command.

Response

queueIdsstring[]

workflowInstanceIdstring

Changes

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