Skip to main content
POST
/
alerts
/
{alertId}
/
file
Mark an alert as filed with an acknowledgment receipt
curl --request POST \
  --url https://api.artu.ai/alerts/{alertId}/file \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Environment: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organizationId": "<string>",
  "itemCount": 4503599627370495,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "externalId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "metadata": {},
  "scopeData": {
    "MX": {
      "actividadVulnerable": {
        "mesReportado": "<string>",
        "ARI": {},
        "AVI": {},
        "INM": {},
        "JYS": {},
        "MJR": {},
        "MPC": {},
        "TSC": {},
        "VEH": {}
      },
      "cnbv": {
        "TRANSMISOR": "<unknown>"
      }
    },
    "US": "<unknown>"
  },
  "filedAt": "2023-11-07T05:31:56Z",
  "filedReportId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "createdByWorkflowId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "color": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

​
X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

​
alertId
string<uuid>
required

Response

200 - application/json

OK

​
scope
enum<string>
required
Available options:
base,
MX:AV,
MX:AV:ARI,
MX:AV:AVI,
MX:AV:INM,
MX:AV:JYS,
MX:AV:MJR,
MX:AV:MPC,
MX:AV:TSC,
MX:AV:VEH,
MX:CNBV,
MX:CNBV:TRANSMISOR,
MX
​
id
string<uuid>
required
​
organizationId
string
required
​
environment
enum<string>
required
Available options:
test,
live
​
status
enum<string>
required

Alert status

Available options:
new,
in_review,
report_draft,
report_validating,
report_valid,
report_invalid,
filed,
resolved,
dismissed
​
itemCount
integer
required
Required range: 0 <= x <= 9007199254740991
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
externalId
string

External ID

​
name
string

Name

Maximum string length: 255
​
description
string

Description

Maximum string length: 2000
​
metadata
object

Metadata

​
scopeData
object
​
filedAt
string<date-time> | null

Filed at

​
filedReportId
string<uuid> | null

Filed report ID

​
createdByWorkflowId
string<uuid>
​
tags
object[]