Depot endpointactions

Registers the direct-action route.

This page is generated from the Depot route table. Every operation carries the permission it needs and the anchor an agent can link to.

POST /api/v1/endpoints/{agentID}/actions/{action}

POSTendpoint:actiontenant facehosteditmspremote

From an MSP console, prefix the path with /api/v1/clients/{clientID} to reach one client.

Source: [object Object]

dispatchEndpointAction validates one action, persists the Command, and pushes it to the agent’s live stream.

The dispatch half is dispatchPatchCommand’s, deliberately: an action and a patch button are the same act with different parameters, and the two paths reporting a disconnected endpoint differently would be a difference the console has to know about.

Parameters

Name	In	Type	Required	Description
action	path	string	Yes
agentID	path	string	Yes	A uuid.

Request body

Required, sent as application/json.

Field	Type	Description
delaySecondsrequired	integer
forcerequired	boolean
messageBodyrequired	string
messageTimeoutSecondsrequired	integer
messageTitlerequired	string
processIdrequired	integer
reasonrequired	string
serviceNamerequired	string
serviceStartTyperequired	string

Responses

Status	Body	Description
202	application/json, CommandAccepted	Accepted.
400	application/problem+json, ProblemDetails	The request body is not valid JSON.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold endpoint:action.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	No client context in request.
502	application/problem+json, ProblemDetails	Could not dispatch command to agent.
503	application/problem+json, ProblemDetails	This Depot has no agent connection service, so nothing can be dispatched.

202 response body

Field	Type	Description
commandIdrequired	string
deliveredrequired	boolean
staterequired	string

Request samples

curl

# Sign in first. outpost_console is a session cookie, so send it with every request.
curl -X POST 'https://depot.example.com/api/v1/endpoints/<agentID>/actions/<action>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "delaySeconds": 0,
  "force": false,
  "messageBody": "string",
  "messageTimeoutSeconds": 0,
  "messageTitle": "string",
  "processId": 0,
  "reason": "string",
  "serviceName": "string",
  "serviceStartType": "string"
}'

PowerShell

# Sign in first. outpost_console is a session cookie, so send it with every request.

$headers = @{
    'X-CSRF-Token' = '<csrf-token>'
    'Accept' = 'application/json'
    'Content-Type' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{
  "delaySeconds": 0,
  "force": false,
  "messageBody": "string",
  "messageTimeoutSeconds": 0,
  "messageTitle": "string",
  "processId": 0,
  "reason": "string",
  "serviceName": "string",
  "serviceStartType": "string"
}
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/endpoints/<agentID>/actions/<action>' `
    -Headers $headers `
    -ContentType 'application/json' `
    -Body $body

$response | ConvertTo-Json -Depth 10

Python

# Sign in first. outpost_console is a session cookie, so send it with every request.

import requests

url = "https://depot.example.com/api/v1/endpoints/<agentID>/actions/<action>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "delaySeconds": 0,
    "force": False,
    "messageBody": "string",
    "messageTimeoutSeconds": 0,
    "messageTitle": "string",
    "processId": 0,
    "reason": "string",
    "serviceName": "string",
    "serviceStartType": "string",
}

response = requests.post(url, headers=headers, cookies=cookies, json=payload, timeout=30)
response.raise_for_status()
print(response.json())

Go

// Sign in first. outpost_console is a session cookie, so send it with every request.
package main

import (
  "bytes"
  "fmt"
  "io"
  "log"
  "net/http"
)

func main() {
  body := []byte(`{
  "delaySeconds": 0,
  "force": false,
  "messageBody": "string",
  "messageTimeoutSeconds": 0,
  "messageTitle": "string",
  "processId": 0,
  "reason": "string",
  "serviceName": "string",
  "serviceStartType": "string"
}`)

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/endpoints/<agentID>/actions/<action>", bytes.NewReader(body))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "application/json")
  req.Header.Set("Content-Type", "application/json")
  req.AddCookie(&http.Cookie{Name: "outpost_console", Value: "<console-session>"})

  resp, err := http.DefaultClient.Do(req)
  if err != nil {
    log.Fatal(err)
  }
  defer resp.Body.Close()

  out, err := io.ReadAll(resp.Body)
  if err != nil {
    log.Fatal(err)
  }
  fmt.Println(resp.Status, string(out))
}

TypeScript

// Sign in first. outpost_console is a session cookie, so send it with every request.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/endpoints/<agentID>/actions/<action>";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({
    "delaySeconds": 0,
    "force": false,
    "messageBody": "string",
    "messageTimeoutSeconds": 0,
    "messageTitle": "string",
    "processId": 0,
    "reason": "string",
    "serviceName": "string",
    "serviceStartType": "string"
  }),
});

if (!response.ok) {
  throw new Error(`Request failed with status ${response.status}`);
}

const data = await response.json();
console.log(data);

C#

// Sign in first. outpost_console is a session cookie, so send it with every request.

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

const string body = """
{
  "delaySeconds": 0,
  "force": false,
  "messageBody": "string",
  "messageTimeoutSeconds": 0,
  "messageTitle": "string",
  "processId": 0,
  "reason": "string",
  "serviceName": "string",
  "serviceStartType": "string"
}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/endpoints/<agentID>/actions/<action>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());