Operar una alerta
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
Operar una alerta
Reconoce, asigna, resuelve, descarta, reabre o comenta una alerta.
Cuerpo del pedido con cualquiera de estos campos:
status:open,acknowledged,resolvedodismissed;resolution:confirmed,expectedofalse_positive;assignee_user_id: la persona responsable. Puede ser quien consulta o, si la vigilancia está compartida, una persona activa de la organización (verGET /v1/guard/members);unassign: true: quita la persona asignada;comment: un comentario.
Cada cambio queda en el historial de la alerta (log) y, si hay webhooks, genera un aviso
guard.alert.updated. Responde la alerta, con la misma forma que GET /v1/guard/alerts/{aid}.
La puede operar cualquiera que vea su vigilancia.
Errores:
400: estado, motivo o persona inválidos.404: la alerta no existe o quien consulta no la ve.409: la alerta está retractada porque una reorganización de la cadena sacó su transacción.422: el cuerpo del pedido trae un campo desconocido.
Requiere una clave de API asignada a una persona (403).
Costo: sin cargo.
PATCH
/
v1
/
guard
/
alerts
/
{aid}
Operar una alerta
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>"
}Autorizaciones
APIKeyHeaderBearerAuth
Encabezados
Parámetros de ruta
Cuerpo
application/json
Respuesta
Respuesta correcta.