Skip to main content
PUT
/
alerts
/
external
/
{externalId}
Create or update a alert by external ID
curl --request PUT \
  --url https://api.artu.ai/alerts/external/{externalId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Environment: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "metadata": {},
  "scopeData": {
    "MX": {
      "actividadVulnerable": {
        "mesReportado": "<string>",
        "ARI": {},
        "AVI": {},
        "INM": {},
        "JYS": {},
        "MJR": {},
        "MPC": {},
        "TSC": {},
        "VEH": {}
      },
      "cnbv": {}
    },
    "US": "<unknown>"
  }
}
'
{
  "data": {
    "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

​
externalId
string
required

External ID

Minimum string length: 1

Body

application/json
​
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
​
name
string

Name

Maximum string length: 255
​
description
string

Description

Maximum string length: 2000
​
metadata
object

Metadata

​
scopeData
object

Response

200 - application/json

OK

​
data
object
required
​
action
enum<string>
required
Available options:
created,
updated,
skipped