Skip to content
TTX-Zone
The API may change between versions while TTX-Zone is 0.x.

Scenario catalog

GET
/api/v1/scenario-catalog
curl --request GET \
  --url https://example.com/api/v1/scenario-catalog \
  --cookie ttx_access_token=<ttx_access_token>

TTX-Zone’s own scenarios, in the reader’s language when available.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
accept-language
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
ScenarioListResponse
object
items
required
Items
Array<object>
ScenarioSummary

A scenario as a library lists it (any level).

object
attack_version
Any of:
string
counts
required
ScenarioCounts
object
actors
Actors
integer
0
files
Files
integer
0
images
Images
integer
0
injects
Injects
integer
0
needs
Needs
integer
0
objectives
Objectives
integer
0
phases
Phases
integer
0
tags
Tags
integer
0
threat_actors
Threat Actors
integer
0
created_at
Any of:
string format: date-time
description
Any of:
string
disabled_at
Any of:
string format: date-time
format_version
required
Format Version
integer
id
required
Id
string
language
required
Language
string
languages
required
Languages
Array<string>
name
required
Name
string
origin
Any of:
ActorOrigin

Where a simulated actor comes from – the actor library’s levels. An exercise’s cast only holds copies; the origin says of what.

string
Allowed values: system organization exercise
origin_id
Any of:
string
origin_name
Any of:
string
updated_at
Any of:
string format: date-time
usage_count
Usage Count
integer
0

Example 

{
  "items": [
    {
      "counts": {
        "actors": 0,
        "files": 0,
        "images": 0,
        "injects": 0,
        "needs": 0,
        "objectives": 0,
        "phases": 0,
        "tags": 0,
        "threat_actors": 0
      },
      "origin": "system",
      "usage_count": 0
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}