Description
Retrieve a single story.
Request
HTTP Method: GET
| Parameter | Description |
|---|---|
| id | The ID of the story to retrieve. |
curl -X GET \
https://<<META.tenant.domain>>/api/v1/stories/<<story_id>> \
-H 'content-type: application/json' \
-H 'x-user-email: <email-address>' \
-H 'x-user-token: <api-token>'
Response
A successful request will return a JSON object representing the specified 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. |
| 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 |
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,
"guid": "df1e838a18d20696120b41516497b017",
"slug": "simple_story",
"created_at": "2021-05-10T08:56:50Z",
"updated_at": "2021-05-10T08:56:50Z"
}