---
title: "POST /v1/ssh-command-actions/dispatch"
method: POST
path: "/v1/ssh-command-actions/dispatch"
tags: ["SSHCommand"]
---

# POST /v1/ssh-command-actions/dispatch

`POST /v1/ssh-command-actions/dispatch`

DispatchSSHCommandToAgents pushes one command to target jade_tree agents.

## Request body

- JadeTreeApiV1DispatchSSHCommandToAgentsRequest
  - `commandUid` string
  - `username` string
  - `password` string
  - `privateKey` string
  - `port` integer
  - `timeoutSeconds` integer
  - `filter` JadeTreeApiV1DispatchSSHCommandFilter
    - `includeMachineUids` string[]
    - `includeSystemTypes` string[]
    - `includeAgentVersions` string[]
    - `excludeMachineUids` string[]
    - `excludeSystemTypes` string[]
    - `excludeAgentVersions` string[]

## Response `200`

OK

- JadeTreeApiV1DispatchSSHCommandToAgentsReply
  - `total` string
  - `success` string
  - `failed` string
  - `items` JadeTreeApiV1DispatchSSHCommandTargetResult[]
    - `machineUid` string
    - `machineUuid` string
    - `hostName` string
    - `localIp` string
    - `endpoint` string
    - `reply` JadeTreeApiV1ExecuteSSHCommandReply
      - `stdout` string
      - `stderr` string
      - `exitCode` integer
    - `error` string

---

[API](https://skmtc.net/aide-family/apis/untitled-api-4.md) · [All operations](https://skmtc.net/aide-family/apis/untitled-api-4/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aide-family/untitled-api-4/versions/7c1198712e80/schema)