Depot alertrules

Registers the routing rules on the TENANT 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/alert-rules

GETalert:readtenant facehosteditmspremoteIdempotent

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

Source: [object Object]

List alert rules

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 name, order, updated	No	Sort key.

Responses

Status	Body	Description
200	application/json, PagedResultAlertRuleView	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 alert:read.
500	application/problem+json, ProblemDetails	No client store in request context.

200 response body

Field	Type	Description
itemsrequired	array of AlertRuleView
items[].categoriesrequired	array of string
items[].channelIdsrequired	array of string
items[].createdAtrequired	string (date-time)
items[].enabledrequired	boolean
items[].escalationTiersrequired	array of EscalationTierView
items[].escalationTiers[].afterMinutesrequired	integer
items[].escalationTiers[].channelIdsrequired	array of string
items[].filterrequired	AlertRuleFilterView	alertRuleFilterView is the endpoint scope.
items[].filter.agentIdsrequired	array of string
items[].filter.osFamiliesrequired	array of string
items[].filter.siteIdsrequired	array of string
items[].minSeverityrequired	string
items[].namerequired	string
items[].notifyOnResolverequired	boolean
items[].publicIdrequired	string
items[].runOrderrequired	integer
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/alert-rules?dir=asc&page=0&pageSize=0&q=<q>&sort=name' \
  -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/alert-rules?dir=asc&page=0&pageSize=0&q=<q>&sort=name' `
    -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/alert-rules"
params = {
    "dir": "asc",
    "page": "0",
    "pageSize": "0",
    "q": "<q>",
    "sort": "name",
}
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/alert-rules?dir=asc&page=0&pageSize=0&q=<q>&sort=name", 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/alert-rules");
url.searchParams.set("dir", "asc");
url.searchParams.set("page", "0");
url.searchParams.set("pageSize", "0");
url.searchParams.set("q", "<q>");
url.searchParams.set("sort", "name");

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/alert-rules?dir=asc&page=0&pageSize=0&q=<q>&sort=name");
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/alert-rules

POSTalert:managetenant facehosteditmspremote

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

Source: [object Object]

Create alert rule

Request body

Required, sent as application/json.

Field	Type	Description
categories	array of string or null
channelIds	array of string or null
enabled	boolean or null
escalationTiers	array of EscalationTierReq or null
escalationTiers[].afterMinutesrequired	integer
escalationTiers[].channelIdsrequired	array of string
filter	AlertRuleFilterReq
filter.agentIds	array of string or null
filter.osFamilies	array of string or null
filter.siteIds	array of string or null
minSeverity	string or null
name	string or null
notifyOnResolve	boolean or null
runOrder	integer or null

Responses

Status	Body	Description
201	application/json, AlertRuleView	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 alert:manage.
404	application/problem+json, ProblemDetails	Alert rule not found.
409	application/problem+json, ProblemDetails	A rule with that name already exists.
500	application/problem+json, ProblemDetails	No client store in request context.

201 response body

Field	Type	Description
categoriesrequired	array of string
channelIdsrequired	array of string
createdAtrequired	string (date-time)
enabledrequired	boolean
escalationTiersrequired	array of EscalationTierView
escalationTiers[].afterMinutesrequired	integer
escalationTiers[].channelIdsrequired	array of string
filterrequired	AlertRuleFilterView	alertRuleFilterView is the endpoint scope.
filter.agentIdsrequired	array of string
filter.osFamiliesrequired	array of string
filter.siteIdsrequired	array of string
minSeverityrequired	string
namerequired	string
notifyOnResolverequired	boolean
publicIdrequired	string
runOrderrequired	integer
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/alert-rules' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "categories": [
    "string"
  ],
  "channelIds": [
    "string"
  ],
  "enabled": false,
  "escalationTiers": [
    {
      "afterMinutes": 0,
      "channelIds": [
        "string"
      ]
    }
  ],
  "filter": {
    "agentIds": [
      "string"
    ],
    "osFamilies": [
      "string"
    ],
    "siteIds": [
      "string"
    ]
  },
  "minSeverity": "string",
  "name": "string",
  "notifyOnResolve": false,
  "runOrder": 0
}'

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 = @'
{
  "categories": [
    "string"
  ],
  "channelIds": [
    "string"
  ],
  "enabled": false,
  "escalationTiers": [
    {
      "afterMinutes": 0,
      "channelIds": [
        "string"
      ]
    }
  ],
  "filter": {
    "agentIds": [
      "string"
    ],
    "osFamilies": [
      "string"
    ],
    "siteIds": [
      "string"
    ]
  },
  "minSeverity": "string",
  "name": "string",
  "notifyOnResolve": false,
  "runOrder": 0
}
'@

$response = Invoke-RestMethod `
    -Method Post `
    -Uri 'https://depot.example.com/api/v1/alert-rules' `
    -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/alert-rules"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "categories": [
        "string",
    ],
    "channelIds": [
        "string",
    ],
    "enabled": False,
    "escalationTiers": [
        {
            "afterMinutes": 0,
            "channelIds": [
                "string",
            ],
        },
    ],
    "filter": {
        "agentIds": [
            "string",
        ],
        "osFamilies": [
            "string",
        ],
        "siteIds": [
            "string",
        ],
    },
    "minSeverity": "string",
    "name": "string",
    "notifyOnResolve": False,
    "runOrder": 0,
}

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(`{
  "categories": [
    "string"
  ],
  "channelIds": [
    "string"
  ],
  "enabled": false,
  "escalationTiers": [
    {
      "afterMinutes": 0,
      "channelIds": [
        "string"
      ]
    }
  ],
  "filter": {
    "agentIds": [
      "string"
    ],
    "osFamilies": [
      "string"
    ],
    "siteIds": [
      "string"
    ]
  },
  "minSeverity": "string",
  "name": "string",
  "notifyOnResolve": false,
  "runOrder": 0
}`)

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

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({
    "categories": [
      "string"
    ],
    "channelIds": [
      "string"
    ],
    "enabled": false,
    "escalationTiers": [
      {
        "afterMinutes": 0,
        "channelIds": [
          "string"
        ]
      }
    ],
    "filter": {
      "agentIds": [
        "string"
      ],
      "osFamilies": [
        "string"
      ],
      "siteIds": [
        "string"
      ]
    },
    "minSeverity": "string",
    "name": "string",
    "notifyOnResolve": false,
    "runOrder": 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.

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

using var client = new HttpClient();

const string body = """
{
  "categories": [
    "string"
  ],
  "channelIds": [
    "string"
  ],
  "enabled": false,
  "escalationTiers": [
    {
      "afterMinutes": 0,
      "channelIds": [
        "string"
      ]
    }
  ],
  "filter": {
    "agentIds": [
      "string"
    ],
    "osFamilies": [
      "string"
    ],
    "siteIds": [
      "string"
    ]
  },
  "minSeverity": "string",
  "name": "string",
  "notifyOnResolve": false,
  "runOrder": 0
}
""";

var request = new HttpRequestMessage(HttpMethod.Post, "https://depot.example.com/api/v1/alert-rules");
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/alert-rules/{ruleId}

GETalert:readtenant facehosteditmspremoteIdempotent

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

Source: [object Object]

Get alert rule

Parameters

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

Responses

Status	Body	Description
200	application/json, AlertRuleView	Success.
401	application/problem+json, ProblemDetails	No signed-in identity.
403	application/problem+json, ProblemDetails	The identity does not hold alert:read.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	No client store in request context.

200 response body

Field	Type	Description
categoriesrequired	array of string
channelIdsrequired	array of string
createdAtrequired	string (date-time)
enabledrequired	boolean
escalationTiersrequired	array of EscalationTierView
escalationTiers[].afterMinutesrequired	integer
escalationTiers[].channelIdsrequired	array of string
filterrequired	AlertRuleFilterView	alertRuleFilterView is the endpoint scope.
filter.agentIdsrequired	array of string
filter.osFamiliesrequired	array of string
filter.siteIdsrequired	array of string
minSeverityrequired	string
namerequired	string
notifyOnResolverequired	boolean
publicIdrequired	string
runOrderrequired	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/alert-rules/<ruleId>' \
  -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/alert-rules/<ruleId>' `
    -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/alert-rules/<ruleId>"
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/alert-rules/<ruleId>", 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/alert-rules/<ruleId>";

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/alert-rules/<ruleId>");
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/alert-rules/{ruleId}

PUTalert:managetenant facehosteditmspremoteIdempotent

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

Source: [object Object]

Update alert rule

Parameters

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

Request body

Required, sent as application/json.

Field	Type	Description
categories	array of string or null
channelIds	array of string or null
enabled	boolean or null
escalationTiers	array of EscalationTierReq or null
escalationTiers[].afterMinutesrequired	integer
escalationTiers[].channelIdsrequired	array of string
filter	AlertRuleFilterReq
filter.agentIds	array of string or null
filter.osFamilies	array of string or null
filter.siteIds	array of string or null
minSeverity	string or null
name	string or null
notifyOnResolve	boolean or null
runOrder	integer or null

Responses

Status	Body	Description
200	application/json, AlertRuleView	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 alert:manage.
404	application/problem+json, ProblemDetails	No resource matches that id.
409	application/problem+json, ProblemDetails	A rule with that name already exists.
500	application/problem+json, ProblemDetails	No client store in request context.

200 response body

Field	Type	Description
categoriesrequired	array of string
channelIdsrequired	array of string
createdAtrequired	string (date-time)
enabledrequired	boolean
escalationTiersrequired	array of EscalationTierView
escalationTiers[].afterMinutesrequired	integer
escalationTiers[].channelIdsrequired	array of string
filterrequired	AlertRuleFilterView	alertRuleFilterView is the endpoint scope.
filter.agentIdsrequired	array of string
filter.osFamiliesrequired	array of string
filter.siteIdsrequired	array of string
minSeverityrequired	string
namerequired	string
notifyOnResolverequired	boolean
publicIdrequired	string
runOrderrequired	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/alert-rules/<ruleId>' \
  -H 'X-CSRF-Token: <csrf-token>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -b 'outpost_console=<console-session>' \
  --data '{
  "categories": [
    "string"
  ],
  "channelIds": [
    "string"
  ],
  "enabled": false,
  "escalationTiers": [
    {
      "afterMinutes": 0,
      "channelIds": [
        "string"
      ]
    }
  ],
  "filter": {
    "agentIds": [
      "string"
    ],
    "osFamilies": [
      "string"
    ],
    "siteIds": [
      "string"
    ]
  },
  "minSeverity": "string",
  "name": "string",
  "notifyOnResolve": false,
  "runOrder": 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 = @'
{
  "categories": [
    "string"
  ],
  "channelIds": [
    "string"
  ],
  "enabled": false,
  "escalationTiers": [
    {
      "afterMinutes": 0,
      "channelIds": [
        "string"
      ]
    }
  ],
  "filter": {
    "agentIds": [
      "string"
    ],
    "osFamilies": [
      "string"
    ],
    "siteIds": [
      "string"
    ]
  },
  "minSeverity": "string",
  "name": "string",
  "notifyOnResolve": false,
  "runOrder": 0
}
'@

$response = Invoke-RestMethod `
    -Method Put `
    -Uri 'https://depot.example.com/api/v1/alert-rules/<ruleId>' `
    -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/alert-rules/<ruleId>"
headers = {
    "X-CSRF-Token": "<csrf-token>",
    "Accept": "application/json",
    "Content-Type": "application/json",
}
cookies = {
    "outpost_console": "<console-session>",
}
payload = {
    "categories": [
        "string",
    ],
    "channelIds": [
        "string",
    ],
    "enabled": False,
    "escalationTiers": [
        {
            "afterMinutes": 0,
            "channelIds": [
                "string",
            ],
        },
    ],
    "filter": {
        "agentIds": [
            "string",
        ],
        "osFamilies": [
            "string",
        ],
        "siteIds": [
            "string",
        ],
    },
    "minSeverity": "string",
    "name": "string",
    "notifyOnResolve": False,
    "runOrder": 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(`{
  "categories": [
    "string"
  ],
  "channelIds": [
    "string"
  ],
  "enabled": false,
  "escalationTiers": [
    {
      "afterMinutes": 0,
      "channelIds": [
        "string"
      ]
    }
  ],
  "filter": {
    "agentIds": [
      "string"
    ],
    "osFamilies": [
      "string"
    ],
    "siteIds": [
      "string"
    ]
  },
  "minSeverity": "string",
  "name": "string",
  "notifyOnResolve": false,
  "runOrder": 0
}`)

  req, err := http.NewRequest(http.MethodPut, "https://depot.example.com/api/v1/alert-rules/<ruleId>", 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/alert-rules/<ruleId>";

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({
    "categories": [
      "string"
    ],
    "channelIds": [
      "string"
    ],
    "enabled": false,
    "escalationTiers": [
      {
        "afterMinutes": 0,
        "channelIds": [
          "string"
        ]
      }
    ],
    "filter": {
      "agentIds": [
        "string"
      ],
      "osFamilies": [
        "string"
      ],
      "siteIds": [
        "string"
      ]
    },
    "minSeverity": "string",
    "name": "string",
    "notifyOnResolve": false,
    "runOrder": 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 = """
{
  "categories": [
    "string"
  ],
  "channelIds": [
    "string"
  ],
  "enabled": false,
  "escalationTiers": [
    {
      "afterMinutes": 0,
      "channelIds": [
        "string"
      ]
    }
  ],
  "filter": {
    "agentIds": [
      "string"
    ],
    "osFamilies": [
      "string"
    ],
    "siteIds": [
      "string"
    ]
  },
  "minSeverity": "string",
  "name": "string",
  "notifyOnResolve": false,
  "runOrder": 0
}
""";

var request = new HttpRequestMessage(HttpMethod.Put, "https://depot.example.com/api/v1/alert-rules/<ruleId>");
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/alert-rules/{ruleId}

DELETEalert:managetenant facehosteditmspremoteIdempotent

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

Source: [object Object]

Delete alert rule

Parameters

Name	In	Type	Required	Description
ruleId	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 alert:manage.
404	application/problem+json, ProblemDetails	No resource matches that id.
500	application/problem+json, ProblemDetails	No client store in request context.

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/alert-rules/<ruleId>' \
  -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/alert-rules/<ruleId>' `
    -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/alert-rules/<ruleId>"
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/alert-rules/<ruleId>", 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/alert-rules/<ruleId>";

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/alert-rules/<ruleId>");
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());