Create

Description

Use a HTTP POST request to create a story.

Request

HTTP Method: POST

Query Parameter Description
name Optional The story name.
description Optional A user-defined description of the story.
keep_events_for Optional Event retention period in seconds:
1 hour: 3600
6 hours: 21600
1 day: 86400
3 days: 259200
7 days: 604800
14 days: 1209600
30 days:2592000
60 days:5184000
90 days:7776000
180 days:15552000
365 days: 31536000
team_id Optional ID of team to which the story should be added.
folder_id Optional ID of folder to which the story should be added.
tags Optional An array of Strings used to create tags to classify the story.
disabled Optional Boolean flag indicating whether the story is disabled (default: false)
priority Optional Boolean flag indicating if this is a high priority story (default: false).
Path Parameter Description
N/A

Sample request

curl -X POST \
  https://<<META.tenant.domain>>/api/v1/stories/ \
  -H 'content-type: application/json' \
  -H 'x-user-token: <api-token>' \
  -d '{
        "name": "Simple story",
        "description": "In the simple story we will create a fictional situation where a detection system is configured to send alerts to our Tines tenant",
        "team_id": 1,
        "folder_id": 1
      }'

Response

A successful request will return a JSON object describing the created story

Field description

Parameter Description
id The story ID.
name The story name.
user_id ID of story owner.
description A user-defined description of the story.
created_at ISO 8601 Timestamp representing date and time the story was created.
updated_at ISO 8601 Timestamp representing date and time the story was last updated.
keep_events_for Defined event retention period in seconds.
disabled Boolean flag indicating whether story is disabled.
priority Boolean flag indicating whether story is hight priority story.
tags An array of tags used to classify the story.
guid Unique identifier of the story.
team_id ID of team to which the story belongs.
folder_id ID of folder to which the story belongs.
send_to_story_enabled Boolean flag indicating if Send to Story is enabled.
send_to_story_access Controls who is allowed to send to this story.
change_control_enabled Boolean flag indicating if change control is enabled.
entry_agent_id The ID of the entry action for this story.
exit_agents An Array of objects describing exit actions for this story.
slug An underscored representation of the story name.
published Boolean flag indicating the published state of the story.

Sample response

{
  "id": 7981,
  "name": "Simple story",
  "user_id": 167,
  "description": "In the simple story we will create a fictional situation where a detection system is configured to send alerts to our Tines tenant",
  "keep_events_for": 604800,
  "disabled": false,
  "priority": false,
  "send_to_story_enabled": false,
  "send_to_story_access": null,
  "change_control_enabled": false,
  "entry_agent_id": null,
  "exit_agents": [],
  "team_id": 1,
  "folder_id": 1,
  "tags": ["Tag 1", "Tag 2"],
  "guid": "df1e838a18d20696120b41516497b017",
  "slug": "simple_story",
  "created_at": "2021-05-10T08:56:50Z",
  "updated_at": "2021-05-10T08:56:50Z",
  "published": false
}
Was this helpful?