API docs by Redocly

CISO Assistant API — EBIOS RM (0.7.0)

Download OpenAPI specification:

CISO Assistant - API Documentation for automating all your GRC needs

attack-paths

ebios_rm_attack_paths_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
ebios_rm_study
string <uuid>
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

is_selected
boolean
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

stakeholders
Array of strings <uuid> [ items <uuid > ]
strategic_scenario
string <uuid>
used
boolean

Used

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

ebios_rm_attack_paths_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
required
string <uuid>
strategic_scenario
required
string <uuid>

Strategic scenario from which the attack path is derived

stakeholders
Array of strings <uuid> [ items <uuid > ]

Stakeholders leveraged by the attack path

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "strategic_scenario": "5969a27c-7a34-477e-b5a9-9f039b29e1fb",
  • "stakeholders": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "strategic_scenario": "5969a27c-7a34-477e-b5a9-9f039b29e1fb",
  • "stakeholders": [
    ]
}

ebios_rm_attack_paths_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Attack path.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "form_display_name": "string",
  • "ebios_rm_study": "string",
  • "folder": "string",
  • "ro_to_couple": "string",
  • "stakeholders": [
    ],
  • "risk_origin": "string",
  • "target_objective": "string",
  • "strategic_scenario": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "is_selected": true,
  • "justification": "string"
}

ebios_rm_attack_paths_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Attack path.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
required
string <uuid>
strategic_scenario
required
string <uuid>

Strategic scenario from which the attack path is derived

stakeholders
Array of strings <uuid> [ items <uuid > ]

Stakeholders leveraged by the attack path

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "strategic_scenario": "5969a27c-7a34-477e-b5a9-9f039b29e1fb",
  • "stakeholders": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "strategic_scenario": "5969a27c-7a34-477e-b5a9-9f039b29e1fb",
  • "stakeholders": [
    ]
}

ebios_rm_attack_paths_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Attack path.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
string <uuid>
strategic_scenario
string <uuid>

Strategic scenario from which the attack path is derived

stakeholders
Array of strings <uuid> [ items <uuid > ]

Stakeholders leveraged by the attack path

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "strategic_scenario": "5969a27c-7a34-477e-b5a9-9f039b29e1fb",
  • "stakeholders": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "strategic_scenario": "5969a27c-7a34-477e-b5a9-9f039b29e1fb",
  • "stakeholders": [
    ]
}

ebios_rm_attack_paths_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Attack path.

Responses

ebios_rm_attack_paths_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Attack path.

Responses

ebios_rm_attack_paths_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Attack path.

Responses

ebios_rm_attack_paths_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

elementary-actions

ebios_rm_elementary_actions_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

operating_mode_available_actions
string

Operating mode available actions

operating_mode_available_antecedents
string

Operating mode available antecedents

ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{}

ebios_rm_elementary_actions_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string (Reference ID) <= 100 characters
attack_stage
integer [ -9223372036854776000 .. 9223372036854776000 ]
Enum: 0 1 2 3

Stage of the attack in the kill chain (e.g., 'Know', 'Enter', 'Discover', 'Exploit')

  • 0 - ebiosReconnaissance
  • 1 - ebiosInitialAccess
  • 2 - ebiosDiscovery
  • 3 - ebiosExploitation
(IconEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))

Icon representing the elementary action

  • server - Server
  • computer - Computer
  • cloud - Cloud
  • file - File
  • diamond - Diamond
  • phone - Phone
  • cube - Cube
  • blocks - Blocks
  • shapes - Shapes
  • network - Network
  • database - Database
  • key - Key
  • search - Search
  • carrot - Carrot
  • money - Money
  • skull - Skull
  • globe - Globe
  • usb - USB
folder
string <uuid>
threat
string or null <uuid>

Threat that the elementary action is derived from

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "attack_stage": 0,
  • "icon": "server",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "threat": "ce5d2937-44fb-415b-bc75-4137db645cfa"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "attack_stage": 0,
  • "icon": "server",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "threat": "ce5d2937-44fb-415b-bc75-4137db645cfa"
}

ebios_rm_elementary_actions_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Elementary Action.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "icon": "string",
  • "icon_fa_class": "string",
  • "icon_fa_hex": "string",
  • "threat": "string",
  • "folder": "string",
  • "attack_stage": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string"
}

ebios_rm_elementary_actions_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Elementary Action.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string (Reference ID) <= 100 characters
attack_stage
integer [ -9223372036854776000 .. 9223372036854776000 ]
Enum: 0 1 2 3

Stage of the attack in the kill chain (e.g., 'Know', 'Enter', 'Discover', 'Exploit')

  • 0 - ebiosReconnaissance
  • 1 - ebiosInitialAccess
  • 2 - ebiosDiscovery
  • 3 - ebiosExploitation
(IconEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))

Icon representing the elementary action

  • server - Server
  • computer - Computer
  • cloud - Cloud
  • file - File
  • diamond - Diamond
  • phone - Phone
  • cube - Cube
  • blocks - Blocks
  • shapes - Shapes
  • network - Network
  • database - Database
  • key - Key
  • search - Search
  • carrot - Carrot
  • money - Money
  • skull - Skull
  • globe - Globe
  • usb - USB
folder
string <uuid>
threat
string or null <uuid>

Threat that the elementary action is derived from

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "attack_stage": 0,
  • "icon": "server",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "threat": "ce5d2937-44fb-415b-bc75-4137db645cfa"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "attack_stage": 0,
  • "icon": "server",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "threat": "ce5d2937-44fb-415b-bc75-4137db645cfa"
}

ebios_rm_elementary_actions_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Elementary Action.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string (Reference ID) <= 100 characters
attack_stage
integer [ -9223372036854776000 .. 9223372036854776000 ]
Enum: 0 1 2 3

Stage of the attack in the kill chain (e.g., 'Know', 'Enter', 'Discover', 'Exploit')

  • 0 - ebiosReconnaissance
  • 1 - ebiosInitialAccess
  • 2 - ebiosDiscovery
  • 3 - ebiosExploitation
(IconEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))

Icon representing the elementary action

  • server - Server
  • computer - Computer
  • cloud - Cloud
  • file - File
  • diamond - Diamond
  • phone - Phone
  • cube - Cube
  • blocks - Blocks
  • shapes - Shapes
  • network - Network
  • database - Database
  • key - Key
  • search - Search
  • carrot - Carrot
  • money - Money
  • skull - Skull
  • globe - Globe
  • usb - USB
folder
string <uuid>
threat
string or null <uuid>

Threat that the elementary action is derived from

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "attack_stage": 0,
  • "icon": "server",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "threat": "ce5d2937-44fb-415b-bc75-4137db645cfa"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "attack_stage": 0,
  • "icon": "server",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "threat": "ce5d2937-44fb-415b-bc75-4137db645cfa"
}

ebios_rm_elementary_actions_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Elementary Action.

Responses

ebios_rm_elementary_actions_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Elementary Action.

Responses

ebios_rm_elementary_actions_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Elementary Action.

Responses

ebios_rm_elementary_actions_attack_stage_retrieve

Authorizations:
knoxApiToken

Responses

ebios_rm_elementary_actions_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

ebios_rm_elementary_actions_icon_retrieve

Authorizations:
knoxApiToken

Responses

feared-events

ebios_rm_feared_events_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
assets
Array of strings <uuid> [ items <uuid > ]
ebios_rm_study
Array of strings <uuid> [ items <uuid > ]
gravity
integer
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

is_selected
boolean
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

qualifications
Array of strings <uuid> [ items <uuid > ]
ro_to_couples
Array of strings <uuid> [ items <uuid > ]
search
string

A search term.

Responses

Response samples

Content type
application/json
{}

ebios_rm_feared_events_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
gravity
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
required
string <uuid>
assets
Array of strings <uuid> [ items <uuid > ]

Assets that are affected by the feared event

qualifications
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "gravity": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "assets": [
    ],
  • "qualifications": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "gravity": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "assets": [
    ],
  • "qualifications": [
    ]
}

ebios_rm_feared_events_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Feared event.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ebios_rm_study": "string",
  • "qualifications": [
    ],
  • "assets": [
    ],
  • "gravity": null,
  • "folder": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "is_selected": true,
  • "justification": "string"
}

ebios_rm_feared_events_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Feared event.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
gravity
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
required
string <uuid>
assets
Array of strings <uuid> [ items <uuid > ]

Assets that are affected by the feared event

qualifications
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "gravity": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "assets": [
    ],
  • "qualifications": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "gravity": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "assets": [
    ],
  • "qualifications": [
    ]
}

ebios_rm_feared_events_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Feared event.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
gravity
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
string <uuid>
assets
Array of strings <uuid> [ items <uuid > ]

Assets that are affected by the feared event

qualifications
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "gravity": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "assets": [
    ],
  • "qualifications": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "gravity": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "assets": [
    ],
  • "qualifications": [
    ]
}

ebios_rm_feared_events_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Feared event.

Responses

ebios_rm_feared_events_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Feared event.

Responses

ebios_rm_feared_events_gravity_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Feared event.

Responses

ebios_rm_feared_events_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Feared event.

Responses

ebios_rm_feared_events_risk_matrix_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Feared event.

Responses

ebios_rm_feared_events_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

ebios_rm_feared_events_batch_create_create

Batch create multiple feared events from a text list. Expected format: { "feared_events_text": "Feared Event 1\nFeared Event 2\nREF-001:Feared Event 3", "ebios_rm_study": "study-uuid" } Lines can optionally have a ref_id prefix (REF-001:Feared Event Name). Feared events with the same name in the study will be skipped.

Authorizations:
knoxApiToken

Responses

kill-chains

ebios_rm_kill_chains_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

operating_mode
Array of strings <uuid> [ items <uuid > ]
ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{}

ebios_rm_kill_chains_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
is_highlighted
boolean
(LogicOperatorEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))

Logic operator to apply between antecedents

  • AND - AND
  • OR - OR
position_x
number <double>

X position of the node in the graph editor

position_y
number <double>

Y position of the node in the graph editor

folder
string <uuid>
operating_mode
required
string <uuid>
elementary_action
required
string <uuid>
antecedents
Array of strings <uuid> [ items <uuid > ]

Elementary actions that are antecedents to this action in the kill chain

Responses

Request samples

Content type
{
  • "is_published": true,
  • "is_highlighted": true,
  • "logic_operator": "AND",
  • "position_x": 0.1,
  • "position_y": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operating_mode": "78d8e9d3-65a0-44a3-ab58-fbc8df642881",
  • "elementary_action": "9a617930-1769-4c1b-9b3d-4126bc28492a",
  • "antecedents": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "is_highlighted": true,
  • "logic_operator": "AND",
  • "position_x": 0.1,
  • "position_y": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operating_mode": "78d8e9d3-65a0-44a3-ab58-fbc8df642881",
  • "elementary_action": "9a617930-1769-4c1b-9b3d-4126bc28492a",
  • "antecedents": [
    ]
}

ebios_rm_kill_chains_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Kill Chain.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "operating_mode": "string",
  • "elementary_action": "string",
  • "antecedents": [
    ],
  • "attack_stage": "string",
  • "folder": "string",
  • "str": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "is_highlighted": true,
  • "logic_operator": "AND",
  • "position_x": 0.1,
  • "position_y": 0.1
}

ebios_rm_kill_chains_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Kill Chain.

Request Body schema:
required
is_published
boolean (Published)
is_highlighted
boolean
(LogicOperatorEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))

Logic operator to apply between antecedents

  • AND - AND
  • OR - OR
position_x
number <double>

X position of the node in the graph editor

position_y
number <double>

Y position of the node in the graph editor

folder
string <uuid>
operating_mode
required
string <uuid>
elementary_action
required
string <uuid>
antecedents
Array of strings <uuid> [ items <uuid > ]

Elementary actions that are antecedents to this action in the kill chain

Responses

Request samples

Content type
{
  • "is_published": true,
  • "is_highlighted": true,
  • "logic_operator": "AND",
  • "position_x": 0.1,
  • "position_y": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operating_mode": "78d8e9d3-65a0-44a3-ab58-fbc8df642881",
  • "elementary_action": "9a617930-1769-4c1b-9b3d-4126bc28492a",
  • "antecedents": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "is_highlighted": true,
  • "logic_operator": "AND",
  • "position_x": 0.1,
  • "position_y": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operating_mode": "78d8e9d3-65a0-44a3-ab58-fbc8df642881",
  • "elementary_action": "9a617930-1769-4c1b-9b3d-4126bc28492a",
  • "antecedents": [
    ]
}

ebios_rm_kill_chains_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Kill Chain.

Request Body schema:
is_published
boolean (Published)
is_highlighted
boolean
(LogicOperatorEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))

Logic operator to apply between antecedents

  • AND - AND
  • OR - OR
position_x
number <double>

X position of the node in the graph editor

position_y
number <double>

Y position of the node in the graph editor

folder
string <uuid>
operating_mode
string <uuid>
elementary_action
string <uuid>
antecedents
Array of strings <uuid> [ items <uuid > ]

Elementary actions that are antecedents to this action in the kill chain

Responses

Request samples

Content type
{
  • "is_published": true,
  • "is_highlighted": true,
  • "logic_operator": "AND",
  • "position_x": 0.1,
  • "position_y": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operating_mode": "78d8e9d3-65a0-44a3-ab58-fbc8df642881",
  • "elementary_action": "9a617930-1769-4c1b-9b3d-4126bc28492a",
  • "antecedents": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "is_highlighted": true,
  • "logic_operator": "AND",
  • "position_x": 0.1,
  • "position_y": 0.1,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operating_mode": "78d8e9d3-65a0-44a3-ab58-fbc8df642881",
  • "elementary_action": "9a617930-1769-4c1b-9b3d-4126bc28492a",
  • "antecedents": [
    ]
}

ebios_rm_kill_chains_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Kill Chain.

Responses

ebios_rm_kill_chains_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Kill Chain.

Responses

ebios_rm_kill_chains_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Kill Chain.

Responses

ebios_rm_kill_chains_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

ebios_rm_kill_chains_logic_operator_retrieve

Authorizations:
knoxApiToken

Responses

operating-modes

ebios_rm_operating_modes_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

operational_scenario
Array of strings <uuid> [ items <uuid > ]
ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{}

ebios_rm_operating_modes_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string or null (Reference ID) <= 100 characters
likelihood
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
graph_columns
any

Stage column positions and sizes in the graph editor

folder
string <uuid>
operational_scenario
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "likelihood": -9223372036854776000,
  • "graph_columns": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operational_scenario": "6a00d15d-410e-4f35-8391-8526d7bfb4ad"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "likelihood": -9223372036854776000,
  • "graph_columns": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operational_scenario": "6a00d15d-410e-4f35-8391-8526d7bfb4ad"
}

ebios_rm_operating_modes_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operating Mode.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "operational_scenario": "string",
  • "folder": "string",
  • "likelihood": null,
  • "ebios_rm_study": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "graph_columns": null
}

ebios_rm_operating_modes_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operating Mode.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string or null (Reference ID) <= 100 characters
likelihood
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
graph_columns
any

Stage column positions and sizes in the graph editor

folder
string <uuid>
operational_scenario
required
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "likelihood": -9223372036854776000,
  • "graph_columns": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operational_scenario": "6a00d15d-410e-4f35-8391-8526d7bfb4ad"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "likelihood": -9223372036854776000,
  • "graph_columns": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operational_scenario": "6a00d15d-410e-4f35-8391-8526d7bfb4ad"
}

ebios_rm_operating_modes_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operating Mode.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string or null (Reference ID) <= 100 characters
likelihood
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
graph_columns
any

Stage column positions and sizes in the graph editor

folder
string <uuid>
operational_scenario
string <uuid>

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "likelihood": -9223372036854776000,
  • "graph_columns": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operational_scenario": "6a00d15d-410e-4f35-8391-8526d7bfb4ad"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "likelihood": -9223372036854776000,
  • "graph_columns": null,
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "operational_scenario": "6a00d15d-410e-4f35-8391-8526d7bfb4ad"
}

ebios_rm_operating_modes_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operating Mode.

Responses

ebios_rm_operating_modes_build_graph_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operating Mode.

Responses

ebios_rm_operating_modes_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operating Mode.

Responses

ebios_rm_operating_modes_likelihood_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operating Mode.

Responses

ebios_rm_operating_modes_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operating Mode.

Responses

ebios_rm_operating_modes_save_graph_create

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operating Mode.

Responses

ebios_rm_operating_modes_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

ebios_rm_operating_modes_default_ref_id_retrieve

Authorizations:
knoxApiToken

Responses

operational-scenarios

ebios_rm_operational_scenarios_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
ebios_rm_study
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

likelihood
integer
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

ebios_rm_operational_scenarios_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
operating_modes_description
string

Description of the operating modes of the operational scenario

likelihood
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
required
string <uuid>
attack_path
required
string <uuid>
threats
Array of strings <uuid> [ items <uuid > ]

Threats leveraged by the operational scenario

Responses

Request samples

Content type
{
  • "is_published": true,
  • "operating_modes_description": "string",
  • "likelihood": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "attack_path": "6832f2b5-0fce-4611-ba20-892d9eb41b3b",
  • "threats": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "quotation_method": "string",
  • "is_published": true,
  • "operating_modes_description": "string",
  • "likelihood": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "attack_path": "6832f2b5-0fce-4611-ba20-892d9eb41b3b",
  • "threats": [
    ]
}

ebios_rm_operational_scenarios_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operational scenario.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "str": "string",
  • "ebios_rm_study": "string",
  • "folder": "string",
  • "attack_path": "string",
  • "stakeholders": [
    ],
  • "ro_to": "string",
  • "threats": [
    ],
  • "strategic_scenario": "string",
  • "likelihood": null,
  • "gravity": null,
  • "risk_level": null,
  • "ref_id": "string",
  • "operating_modes_description": "string",
  • "operating_modes": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "is_selected": true,
  • "justification": "string"
}

ebios_rm_operational_scenarios_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operational scenario.

Request Body schema:
required
is_published
boolean (Published)
operating_modes_description
string

Description of the operating modes of the operational scenario

likelihood
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
required
string <uuid>
attack_path
required
string <uuid>
threats
Array of strings <uuid> [ items <uuid > ]

Threats leveraged by the operational scenario

Responses

Request samples

Content type
{
  • "is_published": true,
  • "operating_modes_description": "string",
  • "likelihood": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "attack_path": "6832f2b5-0fce-4611-ba20-892d9eb41b3b",
  • "threats": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "quotation_method": "string",
  • "is_published": true,
  • "operating_modes_description": "string",
  • "likelihood": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "attack_path": "6832f2b5-0fce-4611-ba20-892d9eb41b3b",
  • "threats": [
    ]
}

ebios_rm_operational_scenarios_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operational scenario.

Request Body schema:
is_published
boolean (Published)
operating_modes_description
string

Description of the operating modes of the operational scenario

likelihood
integer <int64> [ -9223372036854776000 .. 9223372036854776000 ]
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
string <uuid>
attack_path
string <uuid>
threats
Array of strings <uuid> [ items <uuid > ]

Threats leveraged by the operational scenario

Responses

Request samples

Content type
{
  • "is_published": true,
  • "operating_modes_description": "string",
  • "likelihood": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "attack_path": "6832f2b5-0fce-4611-ba20-892d9eb41b3b",
  • "threats": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "quotation_method": "string",
  • "is_published": true,
  • "operating_modes_description": "string",
  • "likelihood": -9223372036854776000,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "attack_path": "6832f2b5-0fce-4611-ba20-892d9eb41b3b",
  • "threats": [
    ]
}

ebios_rm_operational_scenarios_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operational scenario.

Responses

ebios_rm_operational_scenarios_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operational scenario.

Responses

ebios_rm_operational_scenarios_likelihood_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operational scenario.

Responses

ebios_rm_operational_scenarios_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operational scenario.

Responses

ebios_rm_operational_scenarios_risk_matrix_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Operational scenario.

Responses

ebios_rm_operational_scenarios_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

ro-to

ebios_rm_ro_to_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
ebios_rm_study
string <uuid>
feared_events
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

is_selected
boolean
limit
integer

Number of results to return per page.

motivation
Array of integers
Items Enum: 0 1 2 3 4
  • 0 - undefined
  • 1 - very_low
  • 2 - low
  • 3 - significant
  • 4 - strong
offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

pertinence
Array of integers
Items Enum: 0 1 2 3 4

Pertinence

  • 0 - undefined
  • 1 - irrelevant
  • 2 - partially_relevant
  • 3 - fairly_relevant
  • 4 - highly_relevant
risk_origin
string <uuid>
search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

ebios_rm_ro_to_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
target_objective
required
string
motivation
integer [ 0 .. 9223372036854776000 ]
Enum: 0 1 2 3 4
  • 0 - undefined
  • 1 - very_low
  • 2 - low
  • 3 - significant
  • 4 - strong
resources
integer [ 0 .. 9223372036854776000 ]
Enum: 0 1 2 3 4
  • 0 - undefined
  • 1 - limited
  • 2 - significant
  • 3 - important
  • 4 - unlimited
activity
integer [ 0 .. 4 ]
Enum: 0 1 2 3 4
  • 0 - undefined
  • 1 - very_low
  • 2 - low
  • 3 - moderate
  • 4 - important
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
required
string <uuid>
risk_origin
required
string <uuid>
feared_events
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "target_objective": "string",
  • "motivation": 0,
  • "resources": 0,
  • "activity": 0,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "risk_origin": "b45084bd-937b-4ed1-97d5-7097be45d1a5",
  • "feared_events": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "target_objective": "string",
  • "motivation": 0,
  • "resources": 0,
  • "activity": 0,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "risk_origin": "b45084bd-937b-4ed1-97d5-7097be45d1a5",
  • "feared_events": [
    ]
}

ebios_rm_ro_to_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RO/TO couple.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "str": "string",
  • "ebios_rm_study": "string",
  • "folder": "string",
  • "feared_events": [
    ],
  • "risk_origin": "string",
  • "motivation": "string",
  • "resources": "string",
  • "activity": "string",
  • "pertinence": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "target_objective": "string",
  • "is_selected": true,
  • "justification": "string"
}

ebios_rm_ro_to_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RO/TO couple.

Request Body schema:
required
is_published
boolean (Published)
target_objective
required
string
motivation
integer [ 0 .. 9223372036854776000 ]
Enum: 0 1 2 3 4
  • 0 - undefined
  • 1 - very_low
  • 2 - low
  • 3 - significant
  • 4 - strong
resources
integer [ 0 .. 9223372036854776000 ]
Enum: 0 1 2 3 4
  • 0 - undefined
  • 1 - limited
  • 2 - significant
  • 3 - important
  • 4 - unlimited
activity
integer [ 0 .. 4 ]
Enum: 0 1 2 3 4
  • 0 - undefined
  • 1 - very_low
  • 2 - low
  • 3 - moderate
  • 4 - important
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
required
string <uuid>
risk_origin
required
string <uuid>
feared_events
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "target_objective": "string",
  • "motivation": 0,
  • "resources": 0,
  • "activity": 0,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "risk_origin": "b45084bd-937b-4ed1-97d5-7097be45d1a5",
  • "feared_events": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "target_objective": "string",
  • "motivation": 0,
  • "resources": 0,
  • "activity": 0,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "risk_origin": "b45084bd-937b-4ed1-97d5-7097be45d1a5",
  • "feared_events": [
    ]
}

ebios_rm_ro_to_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RO/TO couple.

Request Body schema:
is_published
boolean (Published)
target_objective
string
motivation
integer [ 0 .. 9223372036854776000 ]
Enum: 0 1 2 3 4
  • 0 - undefined
  • 1 - very_low
  • 2 - low
  • 3 - significant
  • 4 - strong
resources
integer [ 0 .. 9223372036854776000 ]
Enum: 0 1 2 3 4
  • 0 - undefined
  • 1 - limited
  • 2 - significant
  • 3 - important
  • 4 - unlimited
activity
integer [ 0 .. 4 ]
Enum: 0 1 2 3 4
  • 0 - undefined
  • 1 - very_low
  • 2 - low
  • 3 - moderate
  • 4 - important
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
string <uuid>
risk_origin
string <uuid>
feared_events
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "is_published": true,
  • "target_objective": "string",
  • "motivation": 0,
  • "resources": 0,
  • "activity": 0,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "risk_origin": "b45084bd-937b-4ed1-97d5-7097be45d1a5",
  • "feared_events": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "target_objective": "string",
  • "motivation": 0,
  • "resources": 0,
  • "activity": 0,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "risk_origin": "b45084bd-937b-4ed1-97d5-7097be45d1a5",
  • "feared_events": [
    ]
}

ebios_rm_ro_to_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RO/TO couple.

Responses

ebios_rm_ro_to_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RO/TO couple.

Responses

ebios_rm_ro_to_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this RO/TO couple.

Responses

ebios_rm_ro_to_activity_retrieve

Authorizations:
knoxApiToken

Responses

ebios_rm_ro_to_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

ebios_rm_ro_to_motivation_retrieve

Authorizations:
knoxApiToken

Responses

ebios_rm_ro_to_pertinence_retrieve

Authorizations:
knoxApiToken

Responses

ebios_rm_ro_to_resources_retrieve

Authorizations:
knoxApiToken

Responses

stakeholders

ebios_rm_stakeholders_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
applied_controls
Array of strings <uuid> [ items <uuid > ]
category
string <uuid>
current_criticality
Array of numbers

Multiple values may be separated by commas.

ebios_rm_study
string <uuid>
entity
string <uuid>
is_selected
boolean
limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

residual_criticality
Array of numbers

Multiple values may be separated by commas.

search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

ebios_rm_stakeholders_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
current_dependency
integer [ 0 .. 4 ]
current_penetration
integer [ 0 .. 4 ]
current_maturity
integer [ 1 .. 4 ]
current_trust
integer [ 1 .. 4 ]
residual_dependency
integer [ 0 .. 4 ]
residual_penetration
integer [ 0 .. 4 ]
residual_maturity
integer [ 1 .. 4 ]
residual_trust
integer [ 1 .. 4 ]
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
required
string <uuid>

EBIOS RM study that the stakeholder is part of

entity
required
string <uuid>

Entity qualified by the stakeholder

category
required
string <uuid>
applied_controls
Array of strings <uuid> [ items <uuid > ]

Controls applied to lower stakeholder criticality

Responses

Request samples

Content type
{
  • "is_published": true,
  • "current_dependency": 4,
  • "current_penetration": 4,
  • "current_maturity": 1,
  • "current_trust": 1,
  • "residual_dependency": 4,
  • "residual_penetration": 4,
  • "residual_maturity": 1,
  • "residual_trust": 1,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "applied_controls": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "current_criticality": 0,
  • "residual_criticality": 0,
  • "is_published": true,
  • "current_dependency": 4,
  • "current_penetration": 4,
  • "current_maturity": 1,
  • "current_trust": 1,
  • "residual_dependency": 4,
  • "residual_penetration": 4,
  • "residual_maturity": 1,
  • "residual_trust": 1,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "applied_controls": [
    ]
}

ebios_rm_stakeholders_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Stakeholder.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "str": "string",
  • "ebios_rm_study": "string",
  • "folder": "string",
  • "entity": "string",
  • "applied_controls": [
    ],
  • "category": "string",
  • "current_criticality": "string",
  • "residual_criticality": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "current_dependency": 4,
  • "current_penetration": 4,
  • "current_maturity": 1,
  • "current_trust": 1,
  • "residual_dependency": 4,
  • "residual_penetration": 4,
  • "residual_maturity": 1,
  • "residual_trust": 1,
  • "is_selected": true,
  • "justification": "string"
}

ebios_rm_stakeholders_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Stakeholder.

Request Body schema:
required
is_published
boolean (Published)
current_dependency
integer [ 0 .. 4 ]
current_penetration
integer [ 0 .. 4 ]
current_maturity
integer [ 1 .. 4 ]
current_trust
integer [ 1 .. 4 ]
residual_dependency
integer [ 0 .. 4 ]
residual_penetration
integer [ 0 .. 4 ]
residual_maturity
integer [ 1 .. 4 ]
residual_trust
integer [ 1 .. 4 ]
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
required
string <uuid>

EBIOS RM study that the stakeholder is part of

entity
required
string <uuid>

Entity qualified by the stakeholder

category
required
string <uuid>
applied_controls
Array of strings <uuid> [ items <uuid > ]

Controls applied to lower stakeholder criticality

Responses

Request samples

Content type
{
  • "is_published": true,
  • "current_dependency": 4,
  • "current_penetration": 4,
  • "current_maturity": 1,
  • "current_trust": 1,
  • "residual_dependency": 4,
  • "residual_penetration": 4,
  • "residual_maturity": 1,
  • "residual_trust": 1,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "applied_controls": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "current_criticality": 0,
  • "residual_criticality": 0,
  • "is_published": true,
  • "current_dependency": 4,
  • "current_penetration": 4,
  • "current_maturity": 1,
  • "current_trust": 1,
  • "residual_dependency": 4,
  • "residual_penetration": 4,
  • "residual_maturity": 1,
  • "residual_trust": 1,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "applied_controls": [
    ]
}

ebios_rm_stakeholders_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Stakeholder.

Request Body schema:
is_published
boolean (Published)
current_dependency
integer [ 0 .. 4 ]
current_penetration
integer [ 0 .. 4 ]
current_maturity
integer [ 1 .. 4 ]
current_trust
integer [ 1 .. 4 ]
residual_dependency
integer [ 0 .. 4 ]
residual_penetration
integer [ 0 .. 4 ]
residual_maturity
integer [ 1 .. 4 ]
residual_trust
integer [ 1 .. 4 ]
is_selected
boolean
justification
string
folder
string <uuid>
ebios_rm_study
string <uuid>

EBIOS RM study that the stakeholder is part of

entity
string <uuid>

Entity qualified by the stakeholder

category
string <uuid>
applied_controls
Array of strings <uuid> [ items <uuid > ]

Controls applied to lower stakeholder criticality

Responses

Request samples

Content type
{
  • "is_published": true,
  • "current_dependency": 4,
  • "current_penetration": 4,
  • "current_maturity": 1,
  • "current_trust": 1,
  • "residual_dependency": 4,
  • "residual_penetration": 4,
  • "residual_maturity": 1,
  • "residual_trust": 1,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "applied_controls": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "current_criticality": 0,
  • "residual_criticality": 0,
  • "is_published": true,
  • "current_dependency": 4,
  • "current_penetration": 4,
  • "current_maturity": 1,
  • "current_trust": 1,
  • "residual_dependency": 4,
  • "residual_penetration": 4,
  • "residual_maturity": 1,
  • "residual_trust": 1,
  • "is_selected": true,
  • "justification": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "entity": "01deb6b6-4a1d-47db-89a2-ffb77f46ad2a",
  • "category": "86d23d13-9dbb-46f3-82d0-25253c7750c3",
  • "applied_controls": [
    ]
}

ebios_rm_stakeholders_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Stakeholder.

Responses

ebios_rm_stakeholders_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Stakeholder.

Responses

ebios_rm_stakeholders_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Stakeholder.

Responses

ebios_rm_stakeholders_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

ebios_rm_stakeholders_category_retrieve

Authorizations:
knoxApiToken

Responses

ebios_rm_stakeholders_chart_data_retrieve

Authorizations:
knoxApiToken

Responses

strategic-scenarios

ebios_rm_strategic_scenarios_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
attack_paths
Array of strings <uuid> [ items <uuid > ]
attack_paths__isnull
boolean
ebios_rm_study
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

ebios_rm_strategic_scenarios_create

Authorizations:
knoxApiToken
Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
folder
string <uuid>
ebios_rm_study
required
string <uuid>
ro_to_couple
required
string <uuid> (RO/TO couple)

RO/TO couple from which the attach path is derived

focused_feared_event
string or null <uuid>

Override gravity with this specific feared event's gravity

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "ro_to_couple": "5c186dd5-a27c-4adf-b88a-6ec7d9e18c5e",
  • "focused_feared_event": "2e073f9d-ac35-488c-ae80-4e4033506164"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "ro_to_couple": "5c186dd5-a27c-4adf-b88a-6ec7d9e18c5e",
  • "focused_feared_event": "2e073f9d-ac35-488c-ae80-4e4033506164"
}

ebios_rm_strategic_scenarios_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Strategic Scenario.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "ebios_rm_study": "string",
  • "folder": "string",
  • "ro_to_couple": "string",
  • "focused_feared_event": "string",
  • "gravity": null,
  • "attack_paths": [
    ],
  • "feared_events": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string"
}

ebios_rm_strategic_scenarios_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Strategic Scenario.

Request Body schema:
required
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
folder
string <uuid>
ebios_rm_study
required
string <uuid>
ro_to_couple
required
string <uuid> (RO/TO couple)

RO/TO couple from which the attach path is derived

focused_feared_event
string or null <uuid>

Override gravity with this specific feared event's gravity

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "ro_to_couple": "5c186dd5-a27c-4adf-b88a-6ec7d9e18c5e",
  • "focused_feared_event": "2e073f9d-ac35-488c-ae80-4e4033506164"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "ro_to_couple": "5c186dd5-a27c-4adf-b88a-6ec7d9e18c5e",
  • "focused_feared_event": "2e073f9d-ac35-488c-ae80-4e4033506164"
}

ebios_rm_strategic_scenarios_partial_update

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Strategic Scenario.

Request Body schema:
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
ref_id
string <= 100 characters
folder
string <uuid>
ebios_rm_study
string <uuid>
ro_to_couple
string <uuid> (RO/TO couple)

RO/TO couple from which the attach path is derived

focused_feared_event
string or null <uuid>

Override gravity with this specific feared event's gravity

Responses

Request samples

Content type
{
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "ro_to_couple": "5c186dd5-a27c-4adf-b88a-6ec7d9e18c5e",
  • "focused_feared_event": "2e073f9d-ac35-488c-ae80-4e4033506164"
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "ref_id": "string",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "ebios_rm_study": "019f9149-9ac5-4691-aa4e-bfcac1d85213",
  • "ro_to_couple": "5c186dd5-a27c-4adf-b88a-6ec7d9e18c5e",
  • "focused_feared_event": "2e073f9d-ac35-488c-ae80-4e4033506164"
}

ebios_rm_strategic_scenarios_destroy

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Strategic Scenario.

Responses

ebios_rm_strategic_scenarios_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Strategic Scenario.

Responses

ebios_rm_strategic_scenarios_object_retrieve

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Strategic Scenario.

Responses

ebios_rm_strategic_scenarios_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

studies

ebios_rm_studies_list

Override the list method to inject optimized data into the serializer context.

Authorizations:
knoxApiToken
query Parameters
folder
Array of strings <uuid> [ items <uuid > ]
genericcollection
Array of strings <uuid> [ items <uuid > ]
id
Array of strings <uuid> [ items <uuid > ]

Multiple values may be separated by commas.

limit
integer

Number of results to return per page.

offset
integer

The initial index from which to return the results.

ordering
string

Which field to use when ordering the results.

search
string

A search term.

Responses

Response samples

Content type
application/json
{
  • "count": 123,
  • "next": "http://api.example.org/accounts/?offset=400&limit=100",
  • "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  • "results": [
    ]
}

ebios_rm_studies_create

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
Request Body schema:
required
risk_matrix
string <uuid>
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
eta
string or null <date>
due_date
string or null <date>
ref_id
string <= 100 characters
version
string or null <= 100 characters

Version of the Ebios RM study (eg. 1.0, 2.0, etc.)

(Status6d9Enum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
observation
string or null
meta
any (Metadata)
quotation_method
string
Enum: "manual" "express"

Method used to quote the study: 'manual' for manual likelihood assessment, 'express' for automatic propagation from operating modes

  • manual - Manual
  • express - Express
folder
string <uuid>
reference_entity
string <uuid>

Entity that is the focus of the study

assets
Array of strings <uuid> [ items <uuid > ]

Assets that are pertinent to the study

compliance_assessments
Array of strings <uuid> [ items <uuid > ]

Compliance assessments established as security baseline during workshop 1.4

reviewers
Array of strings <uuid> [ items <uuid > ]
authors
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "ref_id": "string",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "meta": null,
  • "quotation_method": "manual",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "reference_entity": "14f000c2-7acb-4f59-b5e9-bff3720596b0",
  • "assets": [
    ],
  • "compliance_assessments": [
    ],
  • "reviewers": [
    ],
  • "authors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "ref_id": "string",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "meta": null,
  • "quotation_method": "manual",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "reference_entity": "14f000c2-7acb-4f59-b5e9-bff3720596b0",
  • "assets": [
    ],
  • "compliance_assessments": [
    ],
  • "reviewers": [
    ],
  • "authors": [
    ]
}

ebios_rm_studies_retrieve

Return a single object with unauthorized related fields masked.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "str": "string",
  • "perimeter": "string",
  • "folder": "string",
  • "risk_matrix": "string",
  • "reference_entity": "string",
  • "assets": [
    ],
  • "compliance_assessments": [
    ],
  • "risk_assessments": [
    ],
  • "authors": [
    ],
  • "reviewers": [
    ],
  • "roto_count": 0,
  • "selected_roto_count": 0,
  • "selected_attack_path_count": 0,
  • "operational_scenario_count": 0,
  • "applied_control_count": 0,
  • "last_risk_assessment": "string",
  • "counters": "string",
  • "validation_flows": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "ref_id": "string",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "meta": null,
  • "quotation_method": "manual"
}

ebios_rm_studies_update

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Request Body schema:
required
risk_matrix
string <uuid>
is_published
boolean (Published)
name
required
string <= 200 characters
description
string or null
eta
string or null <date>
due_date
string or null <date>
ref_id
string <= 100 characters
version
string or null <= 100 characters

Version of the Ebios RM study (eg. 1.0, 2.0, etc.)

(Status6d9Enum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
observation
string or null
meta
any (Metadata)
quotation_method
string
Enum: "manual" "express"

Method used to quote the study: 'manual' for manual likelihood assessment, 'express' for automatic propagation from operating modes

  • manual - Manual
  • express - Express
folder
string <uuid>
reference_entity
string <uuid>

Entity that is the focus of the study

assets
Array of strings <uuid> [ items <uuid > ]

Assets that are pertinent to the study

compliance_assessments
Array of strings <uuid> [ items <uuid > ]

Compliance assessments established as security baseline during workshop 1.4

reviewers
Array of strings <uuid> [ items <uuid > ]
authors
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "ref_id": "string",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "meta": null,
  • "quotation_method": "manual",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "reference_entity": "14f000c2-7acb-4f59-b5e9-bff3720596b0",
  • "assets": [
    ],
  • "compliance_assessments": [
    ],
  • "reviewers": [
    ],
  • "authors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "ref_id": "string",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "meta": null,
  • "quotation_method": "manual",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "reference_entity": "14f000c2-7acb-4f59-b5e9-bff3720596b0",
  • "assets": [
    ],
  • "compliance_assessments": [
    ],
  • "reviewers": [
    ],
  • "authors": [
    ]
}

ebios_rm_studies_partial_update

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Request Body schema:
risk_matrix
string <uuid>
is_published
boolean (Published)
name
string <= 200 characters
description
string or null
eta
string or null <date>
due_date
string or null <date>
ref_id
string <= 100 characters
version
string or null <= 100 characters

Version of the Ebios RM study (eg. 1.0, 2.0, etc.)

(Status6d9Enum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null))
observation
string or null
meta
any (Metadata)
quotation_method
string
Enum: "manual" "express"

Method used to quote the study: 'manual' for manual likelihood assessment, 'express' for automatic propagation from operating modes

  • manual - Manual
  • express - Express
folder
string <uuid>
reference_entity
string <uuid>

Entity that is the focus of the study

assets
Array of strings <uuid> [ items <uuid > ]

Assets that are pertinent to the study

compliance_assessments
Array of strings <uuid> [ items <uuid > ]

Compliance assessments established as security baseline during workshop 1.4

reviewers
Array of strings <uuid> [ items <uuid > ]
authors
Array of strings <uuid> [ items <uuid > ]

Responses

Request samples

Content type
{
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "ref_id": "string",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "meta": null,
  • "quotation_method": "manual",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "reference_entity": "14f000c2-7acb-4f59-b5e9-bff3720596b0",
  • "assets": [
    ],
  • "compliance_assessments": [
    ],
  • "reviewers": [
    ],
  • "authors": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "risk_matrix": "d6be139d-8169-4642-9d1a-53f73ea1eead",
  • "is_published": true,
  • "name": "string",
  • "description": "string",
  • "eta": "2019-08-24",
  • "due_date": "2019-08-24",
  • "ref_id": "string",
  • "version": "string",
  • "status": "planned",
  • "observation": "string",
  • "meta": null,
  • "quotation_method": "manual",
  • "folder": "ca579eb8-24ac-44d0-a8b9-a42c500083f5",
  • "reference_entity": "14f000c2-7acb-4f59-b5e9-bff3720596b0",
  • "assets": [
    ],
  • "compliance_assessments": [
    ],
  • "reviewers": [
    ],
  • "authors": [
    ]
}

ebios_rm_studies_destroy

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

ebios_rm_studies_cascade_info_retrieve

Cascade preview:

  • deleted: objects actually deleted by cascade
  • affected: objects not deleted but whose relationships will be removed (through rows, SET_NULL, local links)
Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

ebios_rm_studies_ecosystem_chart_data_retrieve

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

ebios_rm_studies_ecosystem_circular_chart_data_retrieve

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

ebios_rm_studies_export_xlsx_retrieve

Export EBIOS RM study data to Excel with multiple sheets.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

ebios_rm_studies_gravity_retrieve

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

ebios_rm_studies_likelihood_retrieve

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

ebios_rm_studies_object_retrieve

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

ebios_rm_studies_report_data_retrieve

Endpoint to prepare comprehensive report data for an EBIOS RM study. Returns all study attributes and associated objects in a structured format.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

ebios_rm_studies_risk_matrix_retrieve

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

ebios_rm_studies_visual_analysis_retrieve

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

Responses

ebios_rm_studies_workshop_step_partial_update

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken
path Parameters
id
required
string <uuid>

A UUID string identifying this Ebios RM Study.

step
required
string^[0-5]$
workshop
required
string^[1-5]$

Responses

ebios_rm_studies_batch_action_create

Perform a batch action on multiple objects. Uses the IAM-filtered queryset and serializers to respect permissions and validation, mirroring the standard partial_update / destroy flows.

Payload: { "action": "delete"|"change_field"|"change_m2m"|"change_folder", "ids": [...], "field": "", "value": ... }

Authorizations:
knoxApiToken

Responses

ebios_rm_studies_quotation_method_retrieve

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken

Responses

ebios_rm_studies_status_retrieve

API endpoint that allows ebios rm studies to be viewed or edited.

Authorizations:
knoxApiToken

Responses