Depot mspreports

Registers the practice-wide reporting surface on the MSP mux.

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/msp/reports/{name}

GETmsp facemspIdempotentdownload

Source: [object Object]

runMspCannedReport runs one shipped practice-wide report.

THE PERMISSION CHECK IS HERE rather than at the mount, because one route serves nine reports answering to seven different codes. The refusal names the code, so an operator who cannot open the vulnerability aggregate is told they need vuln:read rather than that the screen is broken.

Parameters

Name	In	Type	Required	Description
name	path	string	Yes
clients	query	string	No
format	query	string	No

Responses

Status	Body	Description
200	application/octet-stream, string (binary)	Success.
400	application/problem+json, ProblemDetails	One or more validation errors occurred.
401	application/problem+json, ProblemDetails	Authentication is required.
402	application/problem+json, ProblemDetails	This report is not included in your plan.
403	application/problem+json, ProblemDetails	The identity does not hold the required permission.
404	application/problem+json, ProblemDetails	Outpost ships no practice report by that name.
500	application/problem+json, ProblemDetails	Could not evaluate permissions.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

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/msp/reports/<name>?clients=<clients>&format=<format>' \
  -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/msp/reports/<name>?clients=<clients>&format=<format>' `
    -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/msp/reports/<name>"
params = {
    "clients": "<clients>",
    "format": "<format>",
}
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/msp/reports/<name>?clients=<clients>&format=<format>", 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/msp/reports/<name>");
url.searchParams.set("clients", "<clients>");
url.searchParams.set("format", "<format>");

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/msp/reports/<name>?clients=<clients>&format=<format>");
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());

GET /api/v1/msp/reports/catalog

GETreport:readmsp facemspIdempotent

Source: [object Object]

Get msp report catalog

Responses

Status	Body	Description
200	application/json, ReportCatalogView	Success.
401	application/problem+json, ProblemDetails	Authentication is required.
403	application/problem+json, ProblemDetails	The identity does not hold report:read.
500	application/problem+json, ProblemDetails	Could not evaluate permissions.

200 response body

Field	Type	Description
datasetsrequired	array of ReportCatalogEntryView
datasets[].columns	array of ReportColumnView
datasets[].columns[].keyrequired	string
datasets[].columns[].titlerequired	string
datasets[].columns[].typerequired	string
datasets[].feature	string
datasets[].framework	string
datasets[].maxRows	integer
datasets[].namerequired	string
datasets[].permissionrequired	string
datasets[].planLocked	boolean
datasets[].runnablerequired	boolean
datasets[].titlerequired	string
reportsrequired	array of ReportCatalogEntryView
reports[].columns	array of ReportColumnView
reports[].columns[].keyrequired	string
reports[].columns[].titlerequired	string
reports[].columns[].typerequired	string
reports[].feature	string
reports[].framework	string
reports[].maxRows	integer
reports[].namerequired	string
reports[].permissionrequired	string
reports[].planLocked	boolean
reports[].runnablerequired	boolean
reports[].titlerequired	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/msp/reports/catalog' \
  -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/msp/reports/catalog' `
    -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/msp/reports/catalog"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, 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/msp/reports/catalog", 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 = "https://depot.example.com/api/v1/msp/reports/catalog";

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/msp/reports/catalog");
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());

GET /api/v1/msp/reports/client-health-settings

GETreport:readmsp facemspIdempotent

Source: [object Object]

Get client health settings

Responses

Status	Body	Description
200	application/json, ClientHealthSettingsView	Success.
400	application/problem+json, ProblemDetails	One or more validation errors occurred.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold report:read.
500	application/problem+json, ProblemDetails	The request failed.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
criticalAlertsRedrequired	integer
hoursOverIncludedPercentAmberrequired	integer
patchAmberPercentrequired	integer
patchRedPercentrequired	integer
prepaidLowHoursAmberrequired	integer
redProjectMakesRedrequired	boolean
slaBreachedAmberrequired	integer
slaBreachedRedrequired	integer
staleAmberPercentrequired	integer
staleRedPercentrequired	integer
updatedAtrequired	string (date-time)

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/msp/reports/client-health-settings' \
  -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/msp/reports/client-health-settings' `
    -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/msp/reports/client-health-settings"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, 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/msp/reports/client-health-settings", 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 = "https://depot.example.com/api/v1/msp/reports/client-health-settings";

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/msp/reports/client-health-settings");
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());

PUT /api/v1/msp/reports/client-health-settings

PUTreport:managemsp facemspIdempotent

Source: [object Object]

Update client health settings

Request body

Required, sent as application/json.

Field	Type	Description
criticalAlertsRedrequired	integer
hoursOverIncludedPercentAmberrequired	integer
patchAmberPercentrequired	integer
patchRedPercentrequired	integer
prepaidLowHoursAmberrequired	integer
redProjectMakesRedrequired	boolean
slaBreachedAmberrequired	integer
slaBreachedRedrequired	integer
staleAmberPercentrequired	integer
staleRedPercentrequired	integer

Responses

Status	Body	Description
200	application/json, ClientHealthSettingsView	Success.
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 report:manage.
500	application/problem+json, ProblemDetails	The request failed.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
criticalAlertsRedrequired	integer
hoursOverIncludedPercentAmberrequired	integer
patchAmberPercentrequired	integer
patchRedPercentrequired	integer
prepaidLowHoursAmberrequired	integer
redProjectMakesRedrequired	boolean
slaBreachedAmberrequired	integer
slaBreachedRedrequired	integer
staleAmberPercentrequired	integer
staleRedPercentrequired	integer
updatedAtrequired	string (date-time)

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 PUT 'https://depot.example.com/api/v1/msp/reports/client-health-settings' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "criticalAlertsRed": 0,
  "hoursOverIncludedPercentAmber": 0,
  "patchAmberPercent": 0,
  "patchRedPercent": 0,
  "prepaidLowHoursAmber": 0,
  "redProjectMakesRed": false,
  "slaBreachedAmber": 0,
  "slaBreachedRed": 0,
  "staleAmberPercent": 0,
  "staleRedPercent": 0
}'

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'
    'Content-Type' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{
  "criticalAlertsRed": 0,
  "hoursOverIncludedPercentAmber": 0,
  "patchAmberPercent": 0,
  "patchRedPercent": 0,
  "prepaidLowHoursAmber": 0,
  "redProjectMakesRed": false,
  "slaBreachedAmber": 0,
  "slaBreachedRed": 0,
  "staleAmberPercent": 0,
  "staleRedPercent": 0
}
'@

$response = Invoke-RestMethod `
    -Method Put `
    -Uri 'https://depot.example.com/api/v1/msp/reports/client-health-settings' `
    -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.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/msp/reports/client-health-settings"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "criticalAlertsRed": 0,
    "hoursOverIncludedPercentAmber": 0,
    "patchAmberPercent": 0,
    "patchRedPercent": 0,
    "prepaidLowHoursAmber": 0,
    "redProjectMakesRed": False,
    "slaBreachedAmber": 0,
    "slaBreachedRed": 0,
    "staleAmberPercent": 0,
    "staleRedPercent": 0,
}

response = requests.put(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.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  body := []byte(`{
  "criticalAlertsRed": 0,
  "hoursOverIncludedPercentAmber": 0,
  "patchAmberPercent": 0,
  "patchRedPercent": 0,
  "prepaidLowHoursAmber": 0,
  "redProjectMakesRed": false,
  "slaBreachedAmber": 0,
  "slaBreachedRed": 0,
  "staleAmberPercent": 0,
  "staleRedPercent": 0
}`)

  req, err := http.NewRequest(http.MethodPut, "https://depot.example.com/api/v1/msp/reports/client-health-settings", 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.
// 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 = "https://depot.example.com/api/v1/msp/reports/client-health-settings";

const response = await fetch(url, {
  method: "PUT",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({
    "criticalAlertsRed": 0,
    "hoursOverIncludedPercentAmber": 0,
    "patchAmberPercent": 0,
    "patchRedPercent": 0,
    "prepaidLowHoursAmber": 0,
    "redProjectMakesRed": false,
    "slaBreachedAmber": 0,
    "slaBreachedRed": 0,
    "staleAmberPercent": 0,
    "staleRedPercent": 0
  }),
});

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 System.Text;

using var client = new HttpClient();

const string body = """
{
  "criticalAlertsRed": 0,
  "hoursOverIncludedPercentAmber": 0,
  "patchAmberPercent": 0,
  "patchRedPercent": 0,
  "prepaidLowHoursAmber": 0,
  "redProjectMakesRed": false,
  "slaBreachedAmber": 0,
  "slaBreachedRed": 0,
  "staleAmberPercent": 0,
  "staleRedPercent": 0
}
""";

var request = new HttpRequestMessage(HttpMethod.Put, "https://depot.example.com/api/v1/msp/reports/client-health-settings");
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());

GET /api/v1/msp/reports/definitions

GETreport:readmsp facemspIdempotent

Source: [object Object]

List msp report definitions

Parameters

Name	In	Type	Required	Description
dir	query	string, one of asc, desc	No	Sort direction.
page	query	integer	No	One-based page number. Defaults to 1.
pageSize	query	integer	No	Rows per page, 1 to 200. Defaults to 50.
q	query	string	No	Free-text search term.
sort	query	string, one of created, name, updated	No	Sort key.

Responses

Status	Body	Description
200	application/json, PagedResultMspReportDefinitionView	Success.
400	application/problem+json, ProblemDetails	One or more validation errors occurred.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold report:read.
500	application/problem+json, ProblemDetails	The request failed.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
itemsrequired	array of MspReportDefinitionView
items[].clientsrequired	array of string
items[].createdAtrequired	string (date-time)
items[].createdByUserId	string
items[].descriptionrequired	string
items[].namerequired	string
items[].publicIdrequired	string
items[].sectionsrequired	array of ReportSectionRequest
items[].sections[].columnsrequired	array of string
items[].sections[].datasetrequired	string
items[].sections[].filtersrequired	array of ReportFilterRequest
items[].sections[].filters[].columnrequired	string
items[].sections[].filters[].oprequired	string
items[].sections[].filters[].valuerequired	string
items[].sections[].groupByrequired	string
items[].sections[].limitrequired	integer
items[].sections[].sortrequired	array of ReportSortKeyRequest
items[].sections[].sort[].columnrequired	string
items[].sections[].sort[].descrequired	boolean
items[].sections[].summaryrequired	boolean
items[].sections[].titlerequired	string
items[].updatedAtrequired	string (date-time)
pagerequired	integer
pageSizerequired	integer
totalrequired	integer

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/msp/reports/definitions?dir=asc&page=0&pageSize=0&q=<q>&sort=created' \
  -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/msp/reports/definitions?dir=asc&page=0&pageSize=0&q=<q>&sort=created' `
    -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/msp/reports/definitions"
params = {
    "dir": "asc",
    "page": "0",
    "pageSize": "0",
    "q": "<q>",
    "sort": "created",
}
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/msp/reports/definitions?dir=asc&page=0&pageSize=0&q=<q>&sort=created", 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/msp/reports/definitions");
url.searchParams.set("dir", "asc");
url.searchParams.set("page", "0");
url.searchParams.set("pageSize", "0");
url.searchParams.set("q", "<q>");
url.searchParams.set("sort", "created");

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/msp/reports/definitions?dir=asc&page=0&pageSize=0&q=<q>&sort=created");
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());

POST /api/v1/msp/reports/definitions

POSTreport:managemsp facemsp

Source: [object Object]

Create msp report definition

Request body

Required, sent as application/json.

Field	Type	Description
clientsrequired	array of string
descriptionrequired	string
namerequired	string
sectionsrequired	array of ReportSectionRequest
sections[].columnsrequired	array of string
sections[].datasetrequired	string
sections[].filtersrequired	array of ReportFilterRequest
sections[].filters[].columnrequired	string
sections[].filters[].oprequired	string
sections[].filters[].valuerequired	string
sections[].groupByrequired	string
sections[].limitrequired	integer
sections[].sortrequired	array of ReportSortKeyRequest
sections[].sort[].columnrequired	string
sections[].sort[].descrequired	boolean
sections[].summaryrequired	boolean
sections[].titlerequired	string

Responses

Status	Body	Description
201	application/json, MspReportDefinitionView	Created.
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 report:manage.
404	application/problem+json, ProblemDetails	Report not found.
409	application/problem+json, ProblemDetails	A report with that name already exists.
500	application/problem+json, ProblemDetails	Could not save the report.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

201 response body

Field	Type	Description
clientsrequired	array of string
createdAtrequired	string (date-time)
createdByUserId	string
descriptionrequired	string
namerequired	string
publicIdrequired	string
sectionsrequired	array of ReportSectionRequest
sections[].columnsrequired	array of string
sections[].datasetrequired	string
sections[].filtersrequired	array of ReportFilterRequest
sections[].filters[].columnrequired	string
sections[].filters[].oprequired	string
sections[].filters[].valuerequired	string
sections[].groupByrequired	string
sections[].limitrequired	integer
sections[].sortrequired	array of ReportSortKeyRequest
sections[].sort[].columnrequired	string
sections[].sort[].descrequired	boolean
sections[].summaryrequired	boolean
sections[].titlerequired	string
updatedAtrequired	string (date-time)

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/msp/reports/definitions' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "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 = @'
{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "string"
    }
  ]
}
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/msp/reports/definitions' `
    -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/msp/reports/definitions"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "clients": [
        "string",
    ],
    "description": "string",
    "name": "string",
    "sections": [
        {
            "columns": [
                "string",
            ],
            "dataset": "string",
            "filters": [
                {
                    "column": "string",
                    "op": "string",
                    "value": "string",
                },
            ],
            "groupBy": "string",
            "limit": 0,
            "sort": [
                {
                    "column": "string",
                    "desc": False,
                },
            ],
            "summary": False,
            "title": "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(`{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "string"
    }
  ]
}`)

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/msp/reports/definitions", 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/msp/reports/definitions";

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({
    "clients": [
      "string"
    ],
    "description": "string",
    "name": "string",
    "sections": [
      {
        "columns": [
          "string"
        ],
        "dataset": "string",
        "filters": [
          {
            "column": "string",
            "op": "string",
            "value": "string"
          }
        ],
        "groupBy": "string",
        "limit": 0,
        "sort": [
          {
            "column": "string",
            "desc": false
          }
        ],
        "summary": false,
        "title": "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 = """
{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "string"
    }
  ]
}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/msp/reports/definitions");
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());

GET /api/v1/msp/reports/definitions/{definitionId}

GETreport:readmsp facemspIdempotent

Source: [object Object]

Get msp report definition

Parameters

Name	In	Type	Required	Description
definitionId	path	string	Yes	A uuid.

Responses

Status	Body	Description
200	application/json, MspReportDefinitionView	Success.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold report:read.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	Could not read the report.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
clientsrequired	array of string
createdAtrequired	string (date-time)
createdByUserId	string
descriptionrequired	string
namerequired	string
publicIdrequired	string
sectionsrequired	array of ReportSectionRequest
sections[].columnsrequired	array of string
sections[].datasetrequired	string
sections[].filtersrequired	array of ReportFilterRequest
sections[].filters[].columnrequired	string
sections[].filters[].oprequired	string
sections[].filters[].valuerequired	string
sections[].groupByrequired	string
sections[].limitrequired	integer
sections[].sortrequired	array of ReportSortKeyRequest
sections[].sort[].columnrequired	string
sections[].sort[].descrequired	boolean
sections[].summaryrequired	boolean
sections[].titlerequired	string
updatedAtrequired	string (date-time)

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/msp/reports/definitions/<definitionId>' \
  -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/msp/reports/definitions/<definitionId>' `
    -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/msp/reports/definitions/<definitionId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, 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/msp/reports/definitions/<definitionId>", 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 = "https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>";

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/msp/reports/definitions/<definitionId>");
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());

PUT /api/v1/msp/reports/definitions/{definitionId}

PUTreport:managemsp facemspIdempotent

Source: [object Object]

Update msp report definition

Parameters

Name	In	Type	Required	Description
definitionId	path	string	Yes	A uuid.

Request body

Required, sent as application/json.

Field	Type	Description
clientsrequired	array of string
descriptionrequired	string
namerequired	string
sectionsrequired	array of ReportSectionRequest
sections[].columnsrequired	array of string
sections[].datasetrequired	string
sections[].filtersrequired	array of ReportFilterRequest
sections[].filters[].columnrequired	string
sections[].filters[].oprequired	string
sections[].filters[].valuerequired	string
sections[].groupByrequired	string
sections[].limitrequired	integer
sections[].sortrequired	array of ReportSortKeyRequest
sections[].sort[].columnrequired	string
sections[].sort[].descrequired	boolean
sections[].summaryrequired	boolean
sections[].titlerequired	string

Responses

Status	Body	Description
200	application/json, MspReportDefinitionView	Success.
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 report:manage.
404	application/problem+json, ProblemDetails	No resource matches that id.
409	application/problem+json, ProblemDetails	A report with that name already exists.
500	application/problem+json, ProblemDetails	Could not read the report.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
clientsrequired	array of string
createdAtrequired	string (date-time)
createdByUserId	string
descriptionrequired	string
namerequired	string
publicIdrequired	string
sectionsrequired	array of ReportSectionRequest
sections[].columnsrequired	array of string
sections[].datasetrequired	string
sections[].filtersrequired	array of ReportFilterRequest
sections[].filters[].columnrequired	string
sections[].filters[].oprequired	string
sections[].filters[].valuerequired	string
sections[].groupByrequired	string
sections[].limitrequired	integer
sections[].sortrequired	array of ReportSortKeyRequest
sections[].sort[].columnrequired	string
sections[].sort[].descrequired	boolean
sections[].summaryrequired	boolean
sections[].titlerequired	string
updatedAtrequired	string (date-time)

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 PUT 'https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "string"
    }
  ]
}'

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'
    'Content-Type' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "string"
    }
  ]
}
'@

$response = Invoke-RestMethod `
    -Method Put `
    -Uri 'https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>' `
    -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.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "clients": [
        "string",
    ],
    "description": "string",
    "name": "string",
    "sections": [
        {
            "columns": [
                "string",
            ],
            "dataset": "string",
            "filters": [
                {
                    "column": "string",
                    "op": "string",
                    "value": "string",
                },
            ],
            "groupBy": "string",
            "limit": 0,
            "sort": [
                {
                    "column": "string",
                    "desc": False,
                },
            ],
            "summary": False,
            "title": "string",
        },
    ],
}

response = requests.put(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.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  body := []byte(`{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "string"
    }
  ]
}`)

  req, err := http.NewRequest(http.MethodPut, "https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>", 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.
// 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 = "https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>";

const response = await fetch(url, {
  method: "PUT",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({
    "clients": [
      "string"
    ],
    "description": "string",
    "name": "string",
    "sections": [
      {
        "columns": [
          "string"
        ],
        "dataset": "string",
        "filters": [
          {
            "column": "string",
            "op": "string",
            "value": "string"
          }
        ],
        "groupBy": "string",
        "limit": 0,
        "sort": [
          {
            "column": "string",
            "desc": false
          }
        ],
        "summary": false,
        "title": "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.
// This operation is idempotent. Repeating it does not repeat its effect.

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

using var client = new HttpClient();

const string body = """
{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "string"
    }
  ]
}
""";

var request = new HttpRequestMessage(HttpMethod.Put, "https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>");
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());

DELETE /api/v1/msp/reports/definitions/{definitionId}

DELETEreport:managemsp facemspIdempotent

Source: [object Object]

Delete msp report definition

Parameters

Name	In	Type	Required	Description
definitionId	path	string	Yes	A uuid.

Responses

Status	Body	Description
204	None	Success, with no body.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold report:manage.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	Could not read the report.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

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 DELETE 'https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>' \
  -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 Delete `
    -Uri 'https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>' `
    -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/msp/reports/definitions/<definitionId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.delete(url, 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.MethodDelete, "https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>", 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 = "https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>";

const response = await fetch(url, {
  method: "DELETE",
  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.Delete, "https://depot.example.com/api/v1/msp/reports/definitions/<definitionId>");
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());

GET /api/v1/msp/reports/definitions/{definitionId}/run

GETreport:readmsp facemspIdempotentdownload

Source: [object Object]

runMspReportDefinition runs a saved practice-wide report under the CALLER’s permissions, over the definition’s own client subset unless the request narrows it further.

Parameters

Name	In	Type	Required	Description
definitionId	path	string	Yes	A uuid.
clients	query	string	No
format	query	string	No

Responses

Status	Body	Description
200	application/octet-stream, string (binary)	Success.
400	application/problem+json, ProblemDetails	One or more validation errors occurred.
401	application/problem+json, ProblemDetails	Authentication is required.
402	application/problem+json, ProblemDetails	This report is not included in your plan.
403	application/problem+json, ProblemDetails	The identity does not hold the required permission.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	Could not read the report.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

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/msp/reports/definitions/<definitionId>/run?clients=<clients>&format=<format>' \
  -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/msp/reports/definitions/<definitionId>/run?clients=<clients>&format=<format>' `
    -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/msp/reports/definitions/<definitionId>/run"
params = {
    "clients": "<clients>",
    "format": "<format>",
}
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/msp/reports/definitions/<definitionId>/run?clients=<clients>&format=<format>", 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/msp/reports/definitions/<definitionId>/run");
url.searchParams.set("clients", "<clients>");
url.searchParams.set("format", "<format>");

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/msp/reports/definitions/<definitionId>/run?clients=<clients>&format=<format>");
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());

POST /api/v1/msp/reports/preview

POSTreport:readmsp facemspdownload

Source: [object Object]

Preview msp report definition

Parameters

Name	In	Type	Required	Description
format	query	string	No

Request body

Required, sent as application/json.

Field	Type	Description
clientsrequired	array of string
descriptionrequired	string
namerequired	string
sectionsrequired	array of ReportSectionRequest
sections[].columnsrequired	array of string
sections[].datasetrequired	string
sections[].filtersrequired	array of ReportFilterRequest
sections[].filters[].columnrequired	string
sections[].filters[].oprequired	string
sections[].filters[].valuerequired	string
sections[].groupByrequired	string
sections[].limitrequired	integer
sections[].sortrequired	array of ReportSortKeyRequest
sections[].sort[].columnrequired	string
sections[].sort[].descrequired	boolean
sections[].summaryrequired	boolean
sections[].titlerequired	string

Responses

Status	Body	Description
200	application/octet-stream, string (binary)	Success.
400	application/problem+json, ProblemDetails	One or more validation errors occurred.
401	application/problem+json, ProblemDetails	Authentication is required.
402	application/problem+json, ProblemDetails	This report is not included in your plan.
403	application/problem+json, ProblemDetails	The identity does not hold the required permission.
500	application/problem+json, ProblemDetails	Could not evaluate permissions.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

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/msp/reports/preview?format=<format>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "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 = @'
{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "string"
    }
  ]
}
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/msp/reports/preview?format=<format>' `
    -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/msp/reports/preview"
params = {
    "format": "<format>",
}
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "clients": [
        "string",
    ],
    "description": "string",
    "name": "string",
    "sections": [
        {
            "columns": [
                "string",
            ],
            "dataset": "string",
            "filters": [
                {
                    "column": "string",
                    "op": "string",
                    "value": "string",
                },
            ],
            "groupBy": "string",
            "limit": 0,
            "sort": [
                {
                    "column": "string",
                    "desc": False,
                },
            ],
            "summary": False,
            "title": "string",
        },
    ],
}

response = requests.post(url, params=params, 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(`{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "string"
    }
  ]
}`)

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/msp/reports/preview?format=<format>", 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 = new URL("https://depot.example.com/api/v1/msp/reports/preview");
url.searchParams.set("format", "<format>");

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({
    "clients": [
      "string"
    ],
    "description": "string",
    "name": "string",
    "sections": [
      {
        "columns": [
          "string"
        ],
        "dataset": "string",
        "filters": [
          {
            "column": "string",
            "op": "string",
            "value": "string"
          }
        ],
        "groupBy": "string",
        "limit": 0,
        "sort": [
          {
            "column": "string",
            "desc": false
          }
        ],
        "summary": false,
        "title": "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 = """
{
  "clients": [
    "string"
  ],
  "description": "string",
  "name": "string",
  "sections": [
    {
      "columns": [
        "string"
      ],
      "dataset": "string",
      "filters": [
        {
          "column": "string",
          "op": "string",
          "value": "string"
        }
      ],
      "groupBy": "string",
      "limit": 0,
      "sort": [
        {
          "column": "string",
          "desc": false
        }
      ],
      "summary": false,
      "title": "string"
    }
  ]
}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/msp/reports/preview?format=<format>");
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());

GET /api/v1/msp/reports/schedules

GETreport:readmsp facemspIdempotent

Source: [object Object]

List msp report schedules

Parameters

Name	In	Type	Required	Description
dir	query	string, one of asc, desc	No	Sort direction.
page	query	integer	No	One-based page number. Defaults to 1.
pageSize	query	integer	No	Rows per page, 1 to 200. Defaults to 50.
q	query	string	No	Free-text search term.
sort	query	string, one of created, enabled, last, name, next	No	Sort key.

Responses

Status	Body	Description
200	application/json, PagedResultMspReportScheduleView	Success.
400	application/problem+json, ProblemDetails	One or more validation errors occurred.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold report:read.
500	application/problem+json, ProblemDetails	The request failed.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
itemsrequired	array of MspReportScheduleView
items[].cannedReport	string
items[].clientsrequired	array of string
items[].createdAtrequired	string (date-time)
items[].createdByUserId	string
items[].cronExprrequired	string
items[].definitionId	string
items[].enabledrequired	boolean
items[].graceSecondsrequired	integer
items[].lastRunAt	string (date-time) or null
items[].missedRunPolicyrequired	string
items[].namerequired	string
items[].nextDueAt	string (date-time) or null
items[].pausedrequired	boolean
items[].pausedReason	string
items[].publicIdrequired	string
items[].recipientsrequired	array of string
items[].timezonerequired	string
items[].updatedAtrequired	string (date-time)
pagerequired	integer
pageSizerequired	integer
totalrequired	integer

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/msp/reports/schedules?dir=asc&page=0&pageSize=0&q=<q>&sort=created' \
  -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/msp/reports/schedules?dir=asc&page=0&pageSize=0&q=<q>&sort=created' `
    -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/msp/reports/schedules"
params = {
    "dir": "asc",
    "page": "0",
    "pageSize": "0",
    "q": "<q>",
    "sort": "created",
}
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/msp/reports/schedules?dir=asc&page=0&pageSize=0&q=<q>&sort=created", 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/msp/reports/schedules");
url.searchParams.set("dir", "asc");
url.searchParams.set("page", "0");
url.searchParams.set("pageSize", "0");
url.searchParams.set("q", "<q>");
url.searchParams.set("sort", "created");

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/msp/reports/schedules?dir=asc&page=0&pageSize=0&q=<q>&sort=created");
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());

POST /api/v1/msp/reports/schedules

POSTreport:schedulemsp facemsp

Source: [object Object]

Create msp report schedule

Request body

Required, sent as application/json.

Field	Type	Description
cannedReport	string or null
clientsrequired	array of string
cronExpr	string or null
definitionId	string or null
enabled	boolean or null
graceSeconds	integer or null
missedRunPolicy	string or null
name	string or null
recipientsrequired	array of string
timezone	string or null

Responses

Status	Body	Description
201	application/json, MspReportScheduleView	Created.
400	application/problem+json, ProblemDetails	The request body is not valid JSON.
401	application/problem+json, ProblemDetails	No signed-in identity.
402	application/problem+json, ProblemDetails	This report is not included in your plan.
403	application/problem+json, ProblemDetails	The identity does not hold the required permission.
404	application/problem+json, ProblemDetails	Schedule not found.
409	application/problem+json, ProblemDetails	A schedule with that name already exists.
500	application/problem+json, ProblemDetails	Could not save the schedule.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

201 response body

Field	Type	Description
cannedReport	string
clientsrequired	array of string
createdAtrequired	string (date-time)
createdByUserId	string
cronExprrequired	string
definitionId	string
enabledrequired	boolean
graceSecondsrequired	integer
lastRunAt	string (date-time) or null
missedRunPolicyrequired	string
namerequired	string
nextDueAt	string (date-time) or null
pausedrequired	boolean
pausedReason	string
publicIdrequired	string
recipientsrequired	array of string
timezonerequired	string
updatedAtrequired	string (date-time)

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/msp/reports/schedules' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "cannedReport": "string",
  "clients": [
    "string"
  ],
  "cronExpr": "string",
  "definitionId": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "recipients": [
    "string"
  ],
  "timezone": "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 = @'
{
  "cannedReport": "string",
  "clients": [
    "string"
  ],
  "cronExpr": "string",
  "definitionId": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "recipients": [
    "string"
  ],
  "timezone": "string"
}
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/msp/reports/schedules' `
    -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/msp/reports/schedules"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "cannedReport": "string",
    "clients": [
        "string",
    ],
    "cronExpr": "string",
    "definitionId": "string",
    "enabled": False,
    "graceSeconds": 0,
    "missedRunPolicy": "string",
    "name": "string",
    "recipients": [
        "string",
    ],
    "timezone": "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(`{
  "cannedReport": "string",
  "clients": [
    "string"
  ],
  "cronExpr": "string",
  "definitionId": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "recipients": [
    "string"
  ],
  "timezone": "string"
}`)

  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/msp/reports/schedules", 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/msp/reports/schedules";

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({
    "cannedReport": "string",
    "clients": [
      "string"
    ],
    "cronExpr": "string",
    "definitionId": "string",
    "enabled": false,
    "graceSeconds": 0,
    "missedRunPolicy": "string",
    "name": "string",
    "recipients": [
      "string"
    ],
    "timezone": "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 = """
{
  "cannedReport": "string",
  "clients": [
    "string"
  ],
  "cronExpr": "string",
  "definitionId": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "recipients": [
    "string"
  ],
  "timezone": "string"
}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/msp/reports/schedules");
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());

GET /api/v1/msp/reports/schedules/{scheduleId}

GETreport:readmsp facemspIdempotent

Source: [object Object]

Get msp report schedule

Parameters

Name	In	Type	Required	Description
scheduleId	path	string	Yes	A uuid.

Responses

Status	Body	Description
200	application/json, MspReportScheduleView	Success.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold report:read.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	Could not read the schedule.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
cannedReport	string
clientsrequired	array of string
createdAtrequired	string (date-time)
createdByUserId	string
cronExprrequired	string
definitionId	string
enabledrequired	boolean
graceSecondsrequired	integer
lastRunAt	string (date-time) or null
missedRunPolicyrequired	string
namerequired	string
nextDueAt	string (date-time) or null
pausedrequired	boolean
pausedReason	string
publicIdrequired	string
recipientsrequired	array of string
timezonerequired	string
updatedAtrequired	string (date-time)

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/msp/reports/schedules/<scheduleId>' \
  -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/msp/reports/schedules/<scheduleId>' `
    -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/msp/reports/schedules/<scheduleId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.get(url, 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/msp/reports/schedules/<scheduleId>", 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 = "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>";

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/msp/reports/schedules/<scheduleId>");
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());

PUT /api/v1/msp/reports/schedules/{scheduleId}

PUTreport:schedulemsp facemspIdempotent

Source: [object Object]

Update msp report schedule

Parameters

Name	In	Type	Required	Description
scheduleId	path	string	Yes	A uuid.

Request body

Required, sent as application/json.

Field	Type	Description
cannedReport	string or null
clientsrequired	array of string
cronExpr	string or null
definitionId	string or null
enabled	boolean or null
graceSeconds	integer or null
missedRunPolicy	string or null
name	string or null
recipientsrequired	array of string
timezone	string or null

Responses

Status	Body	Description
200	application/json, MspReportScheduleView	Success.
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 report:schedule.
404	application/problem+json, ProblemDetails	No resource matches that id.
409	application/problem+json, ProblemDetails	A schedule with that name already exists.
500	application/problem+json, ProblemDetails	Could not read the schedule.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
cannedReport	string
clientsrequired	array of string
createdAtrequired	string (date-time)
createdByUserId	string
cronExprrequired	string
definitionId	string
enabledrequired	boolean
graceSecondsrequired	integer
lastRunAt	string (date-time) or null
missedRunPolicyrequired	string
namerequired	string
nextDueAt	string (date-time) or null
pausedrequired	boolean
pausedReason	string
publicIdrequired	string
recipientsrequired	array of string
timezonerequired	string
updatedAtrequired	string (date-time)

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 PUT 'https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "cannedReport": "string",
  "clients": [
    "string"
  ],
  "cronExpr": "string",
  "definitionId": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "recipients": [
    "string"
  ],
  "timezone": "string"
}'

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'
    'Content-Type' = 'application/json'
    'Cookie' = 'outpost_console=<console-session>'
}

$body = @'
{
  "cannedReport": "string",
  "clients": [
    "string"
  ],
  "cronExpr": "string",
  "definitionId": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "recipients": [
    "string"
  ],
  "timezone": "string"
}
'@

$response = Invoke-RestMethod `
    -Method Put `
    -Uri 'https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>' `
    -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.
# This operation is idempotent. Repeating it does not repeat its effect.

import requests

url = "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "cannedReport": "string",
    "clients": [
        "string",
    ],
    "cronExpr": "string",
    "definitionId": "string",
    "enabled": False,
    "graceSeconds": 0,
    "missedRunPolicy": "string",
    "name": "string",
    "recipients": [
        "string",
    ],
    "timezone": "string",
}

response = requests.put(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.
// This operation is idempotent. Repeating it does not repeat its effect.
package main

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

func main() {
  body := []byte(`{
  "cannedReport": "string",
  "clients": [
    "string"
  ],
  "cronExpr": "string",
  "definitionId": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "recipients": [
    "string"
  ],
  "timezone": "string"
}`)

  req, err := http.NewRequest(http.MethodPut, "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>", 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.
// 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 = "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>";

const response = await fetch(url, {
  method: "PUT",
  headers: {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
  },
  credentials: "include",
  body: JSON.stringify({
    "cannedReport": "string",
    "clients": [
      "string"
    ],
    "cronExpr": "string",
    "definitionId": "string",
    "enabled": false,
    "graceSeconds": 0,
    "missedRunPolicy": "string",
    "name": "string",
    "recipients": [
      "string"
    ],
    "timezone": "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.
// This operation is idempotent. Repeating it does not repeat its effect.

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

using var client = new HttpClient();

const string body = """
{
  "cannedReport": "string",
  "clients": [
    "string"
  ],
  "cronExpr": "string",
  "definitionId": "string",
  "enabled": false,
  "graceSeconds": 0,
  "missedRunPolicy": "string",
  "name": "string",
  "recipients": [
    "string"
  ],
  "timezone": "string"
}
""";

var request = new HttpRequestMessage(HttpMethod.Put, "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>");
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());

DELETE /api/v1/msp/reports/schedules/{scheduleId}

DELETEreport:schedulemsp facemspIdempotent

Source: [object Object]

Delete msp report schedule

Parameters

Name	In	Type	Required	Description
scheduleId	path	string	Yes	A uuid.

Responses

Status	Body	Description
204	None	Success, with no body.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold report:schedule.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	Could not read the schedule.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

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 DELETE 'https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>' \
  -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 Delete `
    -Uri 'https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>' `
    -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/msp/reports/schedules/<scheduleId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.delete(url, 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.MethodDelete, "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>", 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 = "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>";

const response = await fetch(url, {
  method: "DELETE",
  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.Delete, "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>");
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());

POST /api/v1/msp/reports/schedules/{scheduleId}/pause

POSTreport:schedulemsp facemsp

Source: [object Object]

Pause msp report schedule

Parameters

Name	In	Type	Required	Description
scheduleId	path	string	Yes	A uuid.

Responses

Status	Body	Description
200	application/json, MspReportScheduleView	Success.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold report:schedule.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	Could not read the schedule.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
cannedReport	string
clientsrequired	array of string
createdAtrequired	string (date-time)
createdByUserId	string
cronExprrequired	string
definitionId	string
enabledrequired	boolean
graceSecondsrequired	integer
lastRunAt	string (date-time) or null
missedRunPolicyrequired	string
namerequired	string
nextDueAt	string (date-time) or null
pausedrequired	boolean
pausedReason	string
publicIdrequired	string
recipientsrequired	array of string
timezonerequired	string
updatedAtrequired	string (date-time)

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/msp/reports/schedules/<scheduleId>/pause' \
  -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.

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

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/pause' `
    -Headers $headers

$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/msp/reports/schedules/<scheduleId>/pause"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.post(url, 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.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/pause", 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.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/pause";

const response = await fetch(url, {
  method: "POST",
  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.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/pause");
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());

POST /api/v1/msp/reports/schedules/{scheduleId}/resume

POSTreport:schedulemsp facemsp

Source: [object Object]

Resume msp report schedule

Parameters

Name	In	Type	Required	Description
scheduleId	path	string	Yes	A uuid.

Responses

Status	Body	Description
200	application/json, MspReportScheduleView	Success.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold report:schedule.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	Could not read the schedule.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
cannedReport	string
clientsrequired	array of string
createdAtrequired	string (date-time)
createdByUserId	string
cronExprrequired	string
definitionId	string
enabledrequired	boolean
graceSecondsrequired	integer
lastRunAt	string (date-time) or null
missedRunPolicyrequired	string
namerequired	string
nextDueAt	string (date-time) or null
pausedrequired	boolean
pausedReason	string
publicIdrequired	string
recipientsrequired	array of string
timezonerequired	string
updatedAtrequired	string (date-time)

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/msp/reports/schedules/<scheduleId>/resume' \
  -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.

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

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/resume' `
    -Headers $headers

$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/msp/reports/schedules/<scheduleId>/resume"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.post(url, 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.
package main

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

func main() {
  req, err := http.NewRequest(http.MethodPost, "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/resume", 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.
// The session cookie is set by signing in. A script cannot set it itself.

const url = "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/resume";

const response = await fetch(url, {
  method: "POST",
  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.

using System;
using System.Net.Http;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/resume");
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());

POST /api/v1/msp/reports/schedules/{scheduleId}/run-now

POSTreport:schedulemsp facemspIdempotent

Source: [object Object]

Run msp report schedule now

Parameters

Name	In	Type	Required	Description
scheduleId	path	string	Yes	A uuid.

Responses

Status	Body	Description
200	application/json, MspReportScheduleView	Success.
400	application/problem+json, ProblemDetails	One or more validation errors occurred.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold report:schedule.
404	application/problem+json, ProblemDetails	No resource matches that id.
409	application/problem+json, ProblemDetails	This schedule is turned off, so nothing would be delivered. Turn it on first.
500	application/problem+json, ProblemDetails	Could not read the schedule.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
cannedReport	string
clientsrequired	array of string
createdAtrequired	string (date-time)
createdByUserId	string
cronExprrequired	string
definitionId	string
enabledrequired	boolean
graceSecondsrequired	integer
lastRunAt	string (date-time) or null
missedRunPolicyrequired	string
namerequired	string
nextDueAt	string (date-time) or null
pausedrequired	boolean
pausedReason	string
publicIdrequired	string
recipientsrequired	array of string
timezonerequired	string
updatedAtrequired	string (date-time)

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 POST 'https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/run-now' \
  -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 Post `
    -Uri 'https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/run-now' `
    -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/msp/reports/schedules/<scheduleId>/run-now"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}

response = requests.post(url, 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.MethodPost, "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/run-now", 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 = "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/run-now";

const response = await fetch(url, {
  method: "POST",
  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.Post, "https://depot.example.com/api/v1/msp/reports/schedules/<scheduleId>/run-now");
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());

GET /api/v1/msp/reports/schedules/{scheduleId}/runs

GETreport:readmsp facemspIdempotent

Source: [object Object]

List msp report schedule runs

Parameters

Name	In	Type	Required	Description
scheduleId	path	string	Yes	A uuid.
page	query	integer	No	One-based page number. Defaults to 1.
pageSize	query	integer	No	Rows per page, 1 to 200. Defaults to 50.

Responses

Status	Body	Description
200	application/json, PagedResultReportScheduleRunView	Success.
400	application/problem+json, ProblemDetails	One or more validation errors occurred.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold report:read.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	Could not read the schedule.
503	application/problem+json, ProblemDetails	Practice-wide reports are not available on this Depot.

200 response body

Field	Type	Description
itemsrequired	array of ReportScheduleRunView
items[].dueAtrequired	string (date-time)
items[].error	string
items[].occurrenceKeyrequired	string
items[].pdfBytesrequired	integer	int64.
items[].ranAtrequired	string (date-time)
items[].recipientCountrequired	integer
items[].schedulePublicIdrequired	string
items[].statusrequired	string
pagerequired	integer
pageSizerequired	integer
totalrequired	integer

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/msp/reports/schedules/<scheduleId>/runs?page=0&pageSize=0' \
  -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/msp/reports/schedules/<scheduleId>/runs?page=0&pageSize=0' `
    -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/msp/reports/schedules/<scheduleId>/runs"
params = {
    "page": "0",
    "pageSize": "0",
}
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/msp/reports/schedules/<scheduleId>/runs?page=0&pageSize=0", 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/msp/reports/schedules/<scheduleId>/runs");
url.searchParams.set("page", "0");
url.searchParams.set("pageSize", "0");

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/msp/reports/schedules/<scheduleId>/runs?page=0&pageSize=0");
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());