@@ -100982,6 +100982,15 @@ paths:
100982100982 requestBody:
100983100983 content:
100984100984 application/json:
100985+ examples:
100986+ default:
100987+ value:
100988+ data:
100989+ attributes:
100990+ description: Queue for annotating customer support traces
100991+ name: My annotation queue
100992+ project_id: a33671aa-24fd-4dcd-9b33-a8ec7dde7751
100993+ type: queues
100985100994 schema:
100986100995 $ref: "#/components/schemas/LLMObsAnnotationQueueRequest"
100987100996 description: Create annotation queue payload.
@@ -101069,6 +101078,14 @@ paths:
101069101078 requestBody:
101070101079 content:
101071101080 application/json:
101081+ examples:
101082+ default:
101083+ value:
101084+ data:
101085+ attributes:
101086+ description: Updated description
101087+ name: Updated queue name
101088+ type: queues
101072101089 schema:
101073101090 $ref: "#/components/schemas/LLMObsAnnotationQueueUpdateRequest"
101074101091 description: Update annotation queue payload.
@@ -101174,6 +101191,15 @@ paths:
101174101191 requestBody:
101175101192 content:
101176101193 application/json:
101194+ examples:
101195+ default:
101196+ value:
101197+ data:
101198+ attributes:
101199+ interactions:
101200+ - content_id: trace-abc-123
101201+ type: trace
101202+ type: interactions
101177101203 schema:
101178101204 $ref: "#/components/schemas/LLMObsAnnotationQueueInteractionsRequest"
101179101205 description: Add interactions payload.
@@ -101229,6 +101255,15 @@ paths:
101229101255 requestBody:
101230101256 content:
101231101257 application/json:
101258+ examples:
101259+ default:
101260+ value:
101261+ data:
101262+ attributes:
101263+ interaction_ids:
101264+ - 00000000-0000-0000-0000-000000000000
101265+ - 00000000-0000-0000-0000-000000000001
101266+ type: interactions
101232101267 schema:
101233101268 $ref: "#/components/schemas/LLMObsDeleteAnnotationQueueInteractionsRequest"
101234101269 description: Delete interactions payload.
@@ -109559,6 +109594,17 @@ paths:
109559109594 requestBody:
109560109595 content:
109561109596 application/json:
109597+ examples:
109598+ default:
109599+ value:
109600+ data:
109601+ attributes:
109602+ name: Updated Personal Access Token
109603+ scopes:
109604+ - dashboards_read
109605+ - dashboards_write
109606+ id: 00112233-4455-6677-8899-aabbccddeeff
109607+ type: personal_access_tokens
109562109608 schema:
109563109609 $ref: "#/components/schemas/PersonalAccessTokenUpdateRequest"
109564109610 required: true
@@ -118858,6 +118904,37 @@ paths:
118858118904 requestBody:
118859118905 content:
118860118906 "application/json":
118907+ examples:
118908+ default:
118909+ value:
118910+ cases:
118911+ - condition: "a > 0"
118912+ name: ""
118913+ notifications: []
118914+ status: info
118915+ filters: []
118916+ hasExtendedTitle: true
118917+ isEnabled: true
118918+ message: Test rule
118919+ name: My security monitoring rule.
118920+ options:
118921+ evaluationWindow: 900
118922+ keepAlive: 3600
118923+ maxSignalDuration: 86400
118924+ queries:
118925+ - aggregation: count
118926+ distinctFields: []
118927+ groupByFields: []
118928+ metric: ""
118929+ query: "@test:true"
118930+ referenceTables:
118931+ - checkPresence: true
118932+ columnName: value
118933+ logFieldPath: testtag
118934+ ruleQueryName: a
118935+ tableName: synthetics_test_reference_table_dont_delete
118936+ tags: []
118937+ type: log_detection
118861118938 schema:
118862118939 $ref: "#/components/schemas/SecurityMonitoringRuleCreatePayload"
118863118940 required: true
@@ -119306,6 +119383,29 @@ paths:
119306119383 requestBody:
119307119384 content:
119308119385 "application/json":
119386+ examples:
119387+ default:
119388+ value:
119389+ cases:
119390+ - condition: "a > 0"
119391+ name: ""
119392+ notifications: []
119393+ status: info
119394+ filters: []
119395+ isEnabled: true
119396+ message: Test rule
119397+ name: My security monitoring rule.
119398+ options:
119399+ evaluationWindow: 900
119400+ keepAlive: 3600
119401+ maxSignalDuration: 86400
119402+ queries:
119403+ - aggregation: count
119404+ distinctFields: []
119405+ groupByFields: []
119406+ metrics: []
119407+ query: "@test:true"
119408+ tags: []
119309119409 schema:
119310119410 $ref: "#/components/schemas/SecurityMonitoringRuleUpdatePayload"
119311119411 required: true
@@ -119387,6 +119487,47 @@ paths:
119387119487 requestBody:
119388119488 content:
119389119489 "application/json":
119490+ examples:
119491+ default:
119492+ value:
119493+ rule:
119494+ cases:
119495+ - condition: "a > 0"
119496+ name: ""
119497+ notifications: []
119498+ status: info
119499+ hasExtendedTitle: true
119500+ isEnabled: true
119501+ message: My security monitoring rule message.
119502+ name: My security monitoring rule.
119503+ options:
119504+ decreaseCriticalityBasedOnEnv: false
119505+ detectionMethod: threshold
119506+ evaluationWindow: 0
119507+ keepAlive: 0
119508+ maxSignalDuration: 0
119509+ queries:
119510+ - aggregation: count
119511+ distinctFields: []
119512+ groupByFields:
119513+ - "@userIdentity.assumed_role"
119514+ name: ""
119515+ query: "source:source_here"
119516+ tags:
119517+ - "env:prod"
119518+ - "team:security"
119519+ type: log_detection
119520+ ruleQueryPayloads:
119521+ - expectedResult: true
119522+ index: 0
119523+ payload:
119524+ ddsource: source_here
119525+ ddtags: "env:staging,version:5.1"
119526+ hostname: i-012345678
119527+ message: "2019-11-19T14:37:58,995 INFO [process.name][20081] Hello World"
119528+ service: payment
119529+ userIdentity:
119530+ assumed_role: fake assumed_role
119390119531 schema:
119391119532 $ref: "#/components/schemas/SecurityMonitoringRuleTestRequest"
119392119533 required: true
@@ -120024,6 +120165,14 @@ paths:
120024120165 requestBody:
120025120166 content:
120026120167 application/json:
120168+ examples:
120169+ default:
120170+ value:
120171+ data:
120172+ attributes:
120173+ resource_ids:
120174+ - abc-123-def
120175+ type: bulk_export_resources
120027120176 schema:
120028120177 $ref: "#/components/schemas/SecurityMonitoringTerraformBulkExportRequest"
120029120178 description: The resource IDs to export.
@@ -120073,6 +120222,18 @@ paths:
120073120222 requestBody:
120074120223 content:
120075120224 application/json:
120225+ examples:
120226+ default:
120227+ value:
120228+ data:
120229+ attributes:
120230+ resource_json:
120231+ enabled: true
120232+ name: Example-Security-Monitoring
120233+ rule_query: "source:cloudtrail"
120234+ suppression_query: "env:test"
120235+ id: abc-123
120236+ type: convert_resource
120076120237 schema:
120077120238 $ref: "#/components/schemas/SecurityMonitoringTerraformConvertRequest"
120078120239 description: The resource JSON to convert.
@@ -120845,6 +121006,16 @@ paths:
120845121006 requestBody:
120846121007 content:
120847121008 application/json:
121009+ examples:
121010+ default:
121011+ value:
121012+ data:
121013+ attributes:
121014+ name: Service Account Access Token
121015+ scopes:
121016+ - dashboards_read
121017+ - dashboards_write
121018+ type: personal_access_tokens
120848121019 schema:
120849121020 $ref: "#/components/schemas/ServiceAccountAccessTokenCreateRequest"
120850121021 required: true
@@ -120957,6 +121128,17 @@ paths:
120957121128 requestBody:
120958121129 content:
120959121130 application/json:
121131+ examples:
121132+ default:
121133+ value:
121134+ data:
121135+ attributes:
121136+ name: Updated Personal Access Token
121137+ scopes:
121138+ - dashboards_read
121139+ - dashboards_write
121140+ id: 00112233-4455-6677-8899-aabbccddeeff
121141+ type: personal_access_tokens
120960121142 schema:
120961121143 $ref: "#/components/schemas/PersonalAccessTokenUpdateRequest"
120962121144 required: true
@@ -121681,6 +121863,16 @@ paths:
121681121863 requestBody:
121682121864 content:
121683121865 "application/json":
121866+ examples:
121867+ default:
121868+ value:
121869+ filter:
121870+ from: "2019-01-02T09:42:36.320Z"
121871+ query: "security:attack status:high"
121872+ to: "2019-01-03T09:42:36.320Z"
121873+ page:
121874+ limit: 25
121875+ sort: timestamp
121684121876 schema:
121685121877 $ref: "#/components/schemas/SecurityMonitoringSignalListRequest"
121686121878 required: false
@@ -121798,6 +121990,34 @@ paths:
121798121990 requestBody:
121799121991 content:
121800121992 "application/json":
121993+ examples:
121994+ default:
121995+ value:
121996+ data:
121997+ attributes:
121998+ jobDefinition:
121999+ cases:
122000+ - condition: "a > 1"
122001+ name: Condition 1
122002+ notifications: []
122003+ status: info
122004+ from: 1730387522611
122005+ index: main
122006+ message: "A large number of failed login attempts."
122007+ name: "Excessive number of failed attempts."
122008+ options:
122009+ evaluationWindow: 900
122010+ keepAlive: 3600
122011+ maxSignalDuration: 86400
122012+ queries:
122013+ - aggregation: count
122014+ distinctFields: []
122015+ groupByFields: []
122016+ query: "source:non_existing_src_weekend"
122017+ tags: []
122018+ to: 1730391122611
122019+ type: log_detection
122020+ type: historicalDetectionsJobCreate
121801122021 schema:
121802122022 $ref: "#/components/schemas/RunHistoricalJobRequest"
121803122023 required: true
@@ -121841,6 +122061,18 @@ paths:
121841122061 requestBody:
121842122062 content:
121843122063 "application/json":
122064+ examples:
122065+ default:
122066+ value:
122067+ data:
122068+ attributes:
122069+ jobResultIds:
122070+ - ""
122071+ notifications:
122072+ - ""
122073+ signalMessage: A large number of failed login attempts.
122074+ signalSeverity: critical
122075+ type: historicalDetectionsJobResultSignalConversion
121844122076 schema:
121845122077 $ref: "#/components/schemas/ConvertJobResultsToSignalsRequest"
121846122078 required: true
0 commit comments