Custom Strategies

get

List all custom strategies. Use is_protected filter to distinguish between user-created and OOTB strategies.

Authorizations
AuthorizationstringRequired
Query parameters
alert_sourcesstring[]Optional

Filter by alert sources

attack_surfacesstring[]Optional

Filter by attack surfaces

is_archivedbooleanOptional

Filter by archived status

is_enabledbooleanOptional

Filter by enabled status

is_protectedbooleanOptional

Filter by protected status (true=OOTB, false=user-created)

mitre_tacticsstring[]Optional

Filter by MITRE tactics

search_querystringOptional

Search in strategy title and scenario

Responses
chevron-right
200

List of custom strategies

application/json

A serializer for a combined strategy and one of its versions.

alert_sourcesstring[]Optional
attack_surfacesstring[]Optional
created_atstring · date-timeRead-onlyRequired
idintegerRead-onlyRequired
internal_origin_uuidstring · uuidRead-onlyRequired
is_archivedbooleanRead-onlyRequired
is_enabledbooleanRead-onlyRequired
is_latestbooleanRead-onlyRequired
is_protectedbooleanRead-onlyRequired
mitre_tacticsstring[]Optional
scenariostring · nullableOptional
titlestringRead-onlyRequired
total_conclusions_affectedintegerRead-onlyRequired
total_instructions_usedintegerRead-onlyRequired
total_priorities_affectedintegerRead-onlyRequired
updated_atstring · date-timeRead-onlyRequired
version_idintegerRead-onlyRequired
get
/app/api/v1/custom-strategies
post

Create a new custom strategy

Authorizations
AuthorizationstringRequired
Body
alert_sourcesstring[]Optional
attack_surfacesstring[]Optional
instructionsobject[]Optional
is_enabledbooleanOptionalDefault: false
mitre_tacticsstring[]Optional
outcomesobject[]Optional
prioritiesobject[]Optional
scenariostringOptional
titlestringRequired
Responses
post
/app/api/v1/custom-strategies
get

Get a specific custom strategy by ID. Includes both user-created and OOTB (protected) strategies.

Authorizations
AuthorizationstringRequired
Path parameters
strategy_idintegerRequired
Responses
chevron-right
200

Custom strategy details

application/json

A serializer for a combined strategy and one of its versions.

alert_sourcesstring[]Optional
attack_surfacesstring[]Optional
created_atstring · date-timeRead-onlyRequired
idintegerRead-onlyRequired
internal_origin_uuidstring · uuidRead-onlyRequired
is_archivedbooleanRead-onlyRequired
is_enabledbooleanRead-onlyRequired
is_latestbooleanRead-onlyRequired
is_protectedbooleanRead-onlyRequired
mitre_tacticsstring[]Optional
scenariostring · nullableOptional
titlestringRead-onlyRequired
total_conclusions_affectedintegerRead-onlyRequired
total_instructions_usedintegerRead-onlyRequired
total_priorities_affectedintegerRead-onlyRequired
updated_atstring · date-timeRead-onlyRequired
version_idintegerRead-onlyRequired
get
/app/api/v1/custom-strategies/{strategy_id}
put

Update a custom strategy (full replacement - creates new version)

Authorizations
AuthorizationstringRequired
Path parameters
strategy_idstringRequired
Body
alert_sourcesstring[]Optional
attack_surfacesstring[]Optional
instructionsobject[]Optional
is_enabledbooleanOptional
mitre_tacticsstring[]Optional
outcomesobject[]Optional
prioritiesobject[]Optional
scenariostringOptional
titlestringRequired
Responses
chevron-right
200

Strategy updated successfully

application/json

A serializer for a combined strategy and one of its versions.

alert_sourcesstring[]Optional
attack_surfacesstring[]Optional
created_atstring · date-timeRead-onlyRequired
idintegerRead-onlyRequired
internal_origin_uuidstring · uuidRead-onlyRequired
is_archivedbooleanRead-onlyRequired
is_enabledbooleanRead-onlyRequired
is_latestbooleanRead-onlyRequired
is_protectedbooleanRead-onlyRequired
mitre_tacticsstring[]Optional
scenariostring · nullableOptional
titlestringRead-onlyRequired
total_conclusions_affectedintegerRead-onlyRequired
total_instructions_usedintegerRead-onlyRequired
total_priorities_affectedintegerRead-onlyRequired
updated_atstring · date-timeRead-onlyRequired
version_idintegerRead-onlyRequired
put
/app/api/v1/custom-strategies/{strategy_id}
delete

Delete or archive a custom strategy (archives if referenced by investigations)

Authorizations
AuthorizationstringRequired
Path parameters
strategy_idstringRequired
Responses
delete
/app/api/v1/custom-strategies/{strategy_id}

No content

Last updated

Was this helpful?