Operate an alert
curl --request PATCH \
--url https://app.blockgence.com/v1/guard/alerts/{aid} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"status": "<string>",
"resolution": "<string>",
"assignee_user_id": 123,
"unassign": false,
"comment": "<string>"
}
'import requests
url = "https://app.blockgence.com/v1/guard/alerts/{aid}"
payload = {
"status": "<string>",
"resolution": "<string>",
"assignee_user_id": 123,
"unassign": False,
"comment": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: '<string>',
resolution: '<string>',
assignee_user_id: 123,
unassign: false,
comment: '<string>'
})
};
fetch('https://app.blockgence.com/v1/guard/alerts/{aid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.blockgence.com/v1/guard/alerts/{aid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => '<string>',
'resolution' => '<string>',
'assignee_user_id' => 123,
'unassign' => false,
'comment' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.blockgence.com/v1/guard/alerts/{aid}"
payload := strings.NewReader("{\n \"status\": \"<string>\",\n \"resolution\": \"<string>\",\n \"assignee_user_id\": 123,\n \"unassign\": false,\n \"comment\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.blockgence.com/v1/guard/alerts/{aid}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"<string>\",\n \"resolution\": \"<string>\",\n \"assignee_user_id\": 123,\n \"unassign\": false,\n \"comment\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/guard/alerts/{aid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"<string>\",\n \"resolution\": \"<string>\",\n \"assignee_user_id\": 123,\n \"unassign\": false,\n \"comment\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Guard
Operate an alert
Acknowledges, assigns, resolves, dismisses, reopens or comments on an alert.
Body with any of these fields:
status:open,acknowledged,resolvedordismissed;resolution:confirmed,expectedorfalse_positive;assignee_user_id: the person responsible. It can be the requester or, if the watch is shared, an active person of the organization (seeGET /v1/guard/members);unassign: true: removes the assigned person;comment: a comment.
Each change is recorded in the alert’s history (log) and, if there are webhooks, produces a
guard.alert.updated notification. Returns the alert, in the same shape as GET /v1/guard/alerts/{aid}.
Anyone who can view its watch can operate it.
Errors:
400: invalid status, resolution or person.404: the alert does not exist or the requester cannot view it.409: the alert is retracted because a chain reorganization removed its transaction.422: the body contains an unknown field.
Requires an API key assigned to a person (403).
Cost: free.
PATCH
/
v1
/
guard
/
alerts
/
{aid}
Operate an alert
curl --request PATCH \
--url https://app.blockgence.com/v1/guard/alerts/{aid} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"status": "<string>",
"resolution": "<string>",
"assignee_user_id": 123,
"unassign": false,
"comment": "<string>"
}
'import requests
url = "https://app.blockgence.com/v1/guard/alerts/{aid}"
payload = {
"status": "<string>",
"resolution": "<string>",
"assignee_user_id": 123,
"unassign": False,
"comment": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: '<string>',
resolution: '<string>',
assignee_user_id: 123,
unassign: false,
comment: '<string>'
})
};
fetch('https://app.blockgence.com/v1/guard/alerts/{aid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.blockgence.com/v1/guard/alerts/{aid}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'status' => '<string>',
'resolution' => '<string>',
'assignee_user_id' => 123,
'unassign' => false,
'comment' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.blockgence.com/v1/guard/alerts/{aid}"
payload := strings.NewReader("{\n \"status\": \"<string>\",\n \"resolution\": \"<string>\",\n \"assignee_user_id\": 123,\n \"unassign\": false,\n \"comment\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://app.blockgence.com/v1/guard/alerts/{aid}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": \"<string>\",\n \"resolution\": \"<string>\",\n \"assignee_user_id\": 123,\n \"unassign\": false,\n \"comment\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.blockgence.com/v1/guard/alerts/{aid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": \"<string>\",\n \"resolution\": \"<string>\",\n \"assignee_user_id\": 123,\n \"unassign\": false,\n \"comment\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"detail": "<string>",
"error": "<string>"
}{
"detail": "<string>",
"error": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"detail": "<string>",
"error": "<string>"
}Authorizations
APIKeyHeaderBearerAuth
Headers
Body
application/json
Response
Successful response.