Depot dashboard

Registers the console dashboard.

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

GET /api/v1/console/dashboard

GETshared facehosteditmspremoteIdempotent

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

Source: [object Object]

Dashboard

Parameters

Name	In	Type	Required	Description
clientId	query	string	No
siteId	query	string	No

Responses

Status	Body	Description
200	application/json, DashboardResponse	Success.
400	application/problem+json, ProblemDetails	One or more validation errors occurred.
404	application/problem+json, ProblemDetails	No resource matches that scope.
500	application/problem+json, ProblemDetails	Could not list clients.
503	application/problem+json, ProblemDetails	The client scope is unavailable.

200 response body

Field	Type	Description
alerts	DashboardAlerts	dashboardAlerts is the alert tile.
alerts.acknowledgedrequired	integer	int64.
alerts.bySeverityrequired	object
alerts.openrequired	integer	int64.
discoverySuggestions	integer or null
fleet	DashboardFleet	dashboardFleet is the endpoint tile.
fleet.offlinerequired	integer
fleet.onlinerequired	integer
fleet.stalerequired	integer
fleet.totalrequired	integer
generatedAtrequired	string (date-time)
incidents	DashboardIncidents	dashboardIncidents is the incident tile, counting only incidents that are still running.
incidents.byStatusrequired	object
incidents.openrequired	integer
patches	DashboardPatches	dashboardPatches is the patch tile, passed through from store.PatchCompliance.
patches.endpointsCompliantrequired	integer
patches.endpointsNeverScannedrequired	integer
patches.endpointsPendingRebootrequired	integer
patches.endpointsTotalrequired	integer
patches.missingCriticalrequired	integer
patches.missingImportantrequired	integer
patches.missingOtherrequired	integer
practiceFacerequired	boolean
scoperequired	DashboardScope	dashboardScope tells the page what it is looking at, so a header can say "Practice" or name the client without the SPA re-deriving it from the URL it happened to call.
scope.clientName	string
scope.clientPublicId	string
scope.clientsrequired	integer
scope.kindrequired	string
scope.sitePublicId	string
siteIgnoredSections	array of string
tickets	DashboardTickets	dashboardTickets is the desk load tile.
tickets.breachedrequired	integer
tickets.byCategoryrequired	object
tickets.openrequired	integer
tickets.unassignedrequired	integer
unavailableClientsrequired	array of string

Request samples

curl

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.
curl -X GET 'https://depot.example.com/api/v1/console/dashboard?clientId=<clientId>&siteId=<siteId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -b 'outpost_console=<console-session>'

PowerShell

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

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

$response = Invoke-RestMethod `
    -Method Get `
    -Uri 'https://depot.example.com/api/v1/console/dashboard?clientId=<clientId>&siteId=<siteId>' `
    -Headers $headers

$response | ConvertTo-Json -Depth 10

Python

# Sign in first. outpost_console is a session cookie, so send it with every request.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/console/dashboard"
params = {
    "clientId": "<clientId>",
    "siteId": "<siteId>",
}
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, params=params, headers=headers, cookies=cookies, 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.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodGet, "https://depot.example.com/api/v1/console/dashboard?clientId=<clientId>&siteId=<siteId>", nil)
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Set("X-CSRF-Token", "<csrf-token>")
  req.Header.Set("Accept", "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.
// This operation is idempotent. Repeating it does not repeat its effect.
// The session cookie is set by signing in. A script cannot set it itself.

const url = new URL("https://depot.example.com/api/v1/console/dashboard");
url.searchParams.set("clientId", "<clientId>");
url.searchParams.set("siteId", "<siteId>");

const response = await fetch(url, {
  method: "GET",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
  },
  credentials: "include",
});

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.
// This operation is idempotent. Repeating it does not repeat its effect.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Get, "https://depot.example.com/api/v1/console/dashboard?clientId=<clientId>&siteId=<siteId>");
request.Headers.TryAddWithoutValidation("X-CSRF-Token", "<csrf-token>");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Cookie", "outpost_console=<console-session>");

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