Skip to main content
POST
/
firework
/
v2
/
assets
/
{asset_id}
/
alerts
cURL
curl --request POST \
  --url https://api.flare.io/firework/v2/assets/{asset_id}/alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "frequency": 123,
  "params": {},
  "start_at": "2023-11-07T05:31:56Z",
  "type": "email",
  "created_at": "2023-11-07T05:31:56Z",
  "experimental_search_types": [
    "<string>"
  ],
  "feed_target_id": 123,
  "feed_target_type": "assets/groups",
  "feed_url": "<string>",
  "id": 123,
  "name": "<string>",
  "organization_id": 123,
  "risks": [
    123
  ],
  "search_types": [
    "attachment"
  ],
  "tenant_alert_channel_id": 123,
  "tenant_id": 123
}
'
{
  "frequency": 123,
  "params": {},
  "start_at": "2023-11-07T05:31:56Z",
  "type": "email",
  "created_at": "2023-11-07T05:31:56Z",
  "experimental_search_types": [
    "<string>"
  ],
  "feed_target_id": 123,
  "feed_target_type": "assets/groups",
  "feed_url": "<string>",
  "id": 123,
  "name": "<string>",
  "organization_id": 123,
  "risks": [
    123
  ],
  "search_types": [
    "attachment"
  ],
  "tenant_alert_channel_id": 123,
  "tenant_id": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
asset_id
integer
required

Body

application/json
​
frequency
integer
required
​
params
object
required
​
start_at
string<date-time>
required
​
type
enum<string>
required
Available options:
email,
channel,
azure_sentinel,
azure_sentinel_v2,
slack,
discord,
splunk,
jira,
teams,
servicenow,
webhook
Example:

"email"

​
created_at
string<date-time>
​
experimental_search_types
string[]
​
feed_target_id
integer
​
feed_target_type
enum<string>
Available options:
assets/groups,
assets,
home
Example:

"assets/groups"

​
feed_url
string
​
id
integer
​
name
string
​
organization_id
integer
​
risks
integer[]
​
search_types
enum<string>[]
Available options:
attachment,
listing,
ransomleak,
forum_post,
forum_topic,
forum_profile,
blog_post,
seller,
paste,
leak,
chat_message,
domain,
bot,
stealer_log,
infected_devices,
driller,
driller_forum_topic,
driller_forum_post,
driller_profile,
cc,
ccbin,
financial_data,
leaked_data,
leaked_file,
document,
account,
actor,
forum_content,
blog_content,
profile,
leaked_credential,
illicit_networks,
open_web,
domains,
leaks,
social_media_account,
social_media,
source_code,
source_code_secrets_np,
source_code_secrets,
source_code_files,
docker,
stack_exchange,
google,
service,
driller_host,
buckets,
bucket,
bucket_object,
whois,
ad,
ads,
cookie,
pii,
experimental
​
tenant_alert_channel_id
integer
​
tenant_id
integer

Response

200 - application/json

Success

​
frequency
integer
required
​
params
object
required
​
start_at
string<date-time>
required
​
type
enum<string>
required
Available options:
email,
channel,
azure_sentinel,
azure_sentinel_v2,
slack,
discord,
splunk,
jira,
teams,
servicenow,
webhook
Example:

"email"

​
created_at
string<date-time>
​
experimental_search_types
string[]
​
feed_target_id
integer
​
feed_target_type
enum<string>
Available options:
assets/groups,
assets,
home
Example:

"assets/groups"

​
feed_url
string
​
id
integer
​
name
string
​
organization_id
integer
​
risks
integer[]
​
search_types
enum<string>[]
Available options:
attachment,
listing,
ransomleak,
forum_post,
forum_topic,
forum_profile,
blog_post,
seller,
paste,
leak,
chat_message,
domain,
bot,
stealer_log,
infected_devices,
driller,
driller_forum_topic,
driller_forum_post,
driller_profile,
cc,
ccbin,
financial_data,
leaked_data,
leaked_file,
document,
account,
actor,
forum_content,
blog_content,
profile,
leaked_credential,
illicit_networks,
open_web,
domains,
leaks,
social_media_account,
social_media,
source_code,
source_code_secrets_np,
source_code_secrets,
source_code_files,
docker,
stack_exchange,
google,
service,
driller_host,
buckets,
bucket,
bucket_object,
whois,
ad,
ads,
cookie,
pii,
experimental
​
tenant_alert_channel_id
integer
​
tenant_id
integer