Documentation Index

Fetch the complete documentation index at: https://developers.torq.io/llms.txt

Use this file to discover all available pages before exploring further.

Update guidance

Prev Next
Patch
/v1/triage/guidance/{id}

Applies a partial update to a guidance entry. Only fields listed in update_mask are modified; all others are left unchanged.

Security
HTTP
Type bearer
Path parameters
id
stringRequired

The ID of the guidance entry to update. This property is required.

Body parameters
Expand All
object
update_mask
string

The fields to update. For example, "name", "description", "enabled". Fields not listed are left unchanged. This property is required.

name
string

The guidance name. Maximum 200 characters.

Min length1
Max length200
description
string

An optional description of the guidance. Maximum 2,000 characters.

Max length2000
guidance
string

The guidance text provided to Auto Triage during alert triage. Maximum 2,000 characters.

Min length1
Max length2000
enabled
boolean

Indicates whether the guidance is active.

apply
object (torq.public.triage.v1.Apply)

Defines which alerts this applies to.

type
string

The scope of alerts this applies to. Accepted values: "always", "by_source", "by_categories".

Valid values[ "always", "by_source", "by_categories" ]
categories
Array of string

The security categories to match. Required when type is "by_categories".

string
integration_type_ids
Array of string

The alert source type IDs to match. Required when type is "by_source".

string
Responses
200

A successful response.

Expand All
object
guidance
object (torq.public.triage.v1.Guidance)

Guidance provides business context that informs Auto Triage reasoning during alert triage. Each entry defines instructions or policies scoped to specific alerts, helping Auto Triage produce more accurate triage verdicts.

id
string

The unique identifier of the guidance entry.

name
string

The guidance name. Maximum 200 characters.

description
string

An optional description of the guidance.

guidance
string

The instruction text provided to Auto Triage during alert triage.

enabled
boolean

Whether the guidance is currently active.

apply
object (torq.public.triage.v1.Apply)

Defines which alerts this applies to.

type
string

The scope of alerts this applies to. Accepted values: "always", "by_source", "by_categories".

Valid values[ "always", "by_source", "by_categories" ]
categories
Array of string

The security categories to match. Required when type is "by_categories".

string
integration_type_ids
Array of string

The alert source type IDs to match. Required when type is "by_source".

string
created_at
string (date-time)

The timestamp when the guidance was created.

updated_at
string (date-time)

The timestamp when the guidance was last updated.

401

Invalid bearer token. If you receive this message more than once try creating a new Client ID/Client Secret or generating a new bearer token.

object
403

You don't have permission to access this resource.

object