@binalyze/air-sdk 5.23.0 → 5.25.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/sdk/typescript-axios/sdk.gen.d.ts +2797 -1078
- package/dist/sdk/typescript-axios/sdk.gen.js +7988 -265
- package/dist/sdk/typescript-axios/sdk.gen.js.map +1 -1
- package/dist/sdk/typescript-axios/types.gen.d.ts +30619 -6198
- package/dist/sdk/typescript-axios-v2/sdk.gen.d.ts +149 -134
- package/dist/sdk/typescript-axios-v2/sdk.gen.js +207 -136
- package/dist/sdk/typescript-axios-v2/sdk.gen.js.map +1 -1
- package/dist/sdk/typescript-axios-v2/types.gen.d.ts +7461 -1793
- package/dist/types/investigation.d.ts +4 -4
- package/package.json +3 -3
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
// @ts-nocheck
|
|
3
3
|
// This file is auto-generated by @hey-api/openapi-ts
|
|
4
4
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
5
|
-
exports.
|
|
6
|
-
exports.
|
|
7
|
-
exports.diskImageAcquisitionLibraryApiControllerUpdate = exports.diskImageAcquisitionLibraryApiControllerGet = exports.diskImageAcquisitionLibraryApiControllerDelete = exports.diskImageAcquisitionLibraryApiControllerBulkDelete = exports.diskImageAcquisitionLibraryApiControllerCreate = exports.diskImageAcquisitionLibraryApiControllerList = exports.cloudAcquisitionLibraryApiControllerUpdate = exports.cloudAcquisitionLibraryApiControllerGet = exports.cloudAcquisitionLibraryApiControllerDelete = exports.cloudAcquisitionLibraryApiControllerBulkDelete = exports.cloudAcquisitionLibraryApiControllerCreate = exports.cloudAcquisitionLibraryApiControllerList = exports.assetInteractMessageV2ApiControllerGetSessionReport = exports.assetInteractMessageV2ApiControllerDownloadMessageOutput = exports.assetInteractMessageV2ApiControllerGetMessage = exports.assetInteractMessageV2ApiControllerListSessionsForAsset = exports.assetAcquisitionV2ApiControllerFilterAcquisitionTasks = exports.assetAcquisitionV2ApiControllerDeleteAcquisitionAssignment = exports.assetAcquisitionV2ApiControllerCancelAcquisition = exports.assetAcquisitionV2ApiControllerAcquire = exports.assetTriageV2ApiControllerDeleteTriageAssignment = exports.assetTriageV2ApiControllerCancelTriage = exports.assetTriageV2ApiControllerRunTriage = exports.assetTriageV2ApiControllerFilterTriageTasks = exports.assetV2ApiControllerUpdateLabel = exports.assetV2ApiControllerReplaceTags = exports.assetV2ApiControllerGetAsset = exports.assetV2ApiControllerDeleteAsset = exports.assetV2ApiControllerFilterAssets = exports.assetV2ApiControllerExportAssets = exports.assetV2ApiControllerGetStats = exports.assetInteractV2ApiControllerCloseSession = exports.assetInteractV2ApiControllerCancelCommand = exports.assetInteractV2ApiControllerRunCommand = exports.assetInteractMessageV2ApiControllerListForAsset = exports.assetBulkTriageV2ApiControllerRunTriage = void 0;
|
|
5
|
+
exports.caseV2ApiControllerCreateCase = exports.caseV2ApiControllerFilterCases = exports.caseActionV2ApiControllerRemoveAssets = exports.caseActionV2ApiControllerArchive = exports.caseActionV2ApiControllerReopen = exports.caseActionV2ApiControllerClose = exports.caseTaskAssignmentV2ApiControllerRemoveTaskAssignment = exports.caseTaskAssignmentV2ApiControllerImportTaskAssignments = exports.caseTaskAssignmentV2ApiControllerFilterTaskAssignments = exports.caseNoteV2ApiControllerUpdateNote = exports.caseNoteV2ApiControllerDeleteNote = exports.caseNoteV2ApiControllerCreateNote = exports.caseNoteV2ApiControllerFilterNotes = exports.caseTaskV2ApiControllerFilterTasks = exports.caseUserV2ApiControllerFilterUsers = exports.caseAssetV2ApiControllerFilterAssets = exports.caseBulkActionV2ApiControllerArchive = exports.caseBulkActionV2ApiControllerClose = exports.caseExportV2ApiControllerExportCases = exports.caseActivityV2ApiControllerFilterCaseActivities = exports.caseActivityV2ApiControllerFilterGlobalActivities = exports.organizationV2ApiControllerGetOrganizationByIdOrName = exports.organizationV2ApiControllerListOrganizations = exports.organizationUserV2ApiControllerListOrganizationUsers = exports.triageLibraryExportV2ApiControllerDownload = exports.triageLibraryExportV2ApiControllerExport = exports.triageLibraryV2ApiControllerUpdate = exports.triageLibraryV2ApiControllerGet = exports.triageLibraryV2ApiControllerDelete = exports.triageLibraryV2ApiControllerValidate = exports.triageLibraryV2ApiControllerBulkDelete = exports.triageLibraryV2ApiControllerCreate = exports.triageLibraryV2ApiControllerList = exports.acquisitionLibraryDeviceV2ApiControllerUpdate = exports.acquisitionLibraryDeviceV2ApiControllerGet = exports.acquisitionLibraryDeviceV2ApiControllerDelete = exports.acquisitionLibraryDeviceV2ApiControllerBulkDelete = exports.acquisitionLibraryDeviceV2ApiControllerCreate = exports.acquisitionLibraryDeviceV2ApiControllerList = exports.tasksTriageV2ApiControllerDeleteOne = exports.tasksTriageV2ApiControllerCancelOne = exports.tasksTriageV2ApiControllerDelete = exports.tasksTriageV2ApiControllerCancel = exports.tasksTriageV2ApiControllerListHuntTasks = exports.tasksV2ApiControllerListTaskAssignments = exports.tasksV2ApiControllerListTaskAssets = exports.tasksV2ApiControllerUpdateTask = exports.tasksV2ApiControllerGetTaskById = exports.openApiAliasV2ApiControllerGet = exports.capabilitiesV2ApiControllerGet = void 0;
|
|
6
|
+
exports.assetBulkMetadataV2ApiControllerSetConnectionRoute = exports.assetBulkMetadataV2ApiControllerSetUpdateExclusion = exports.assetBulkMetadataV2ApiControllerRemoveTags = exports.assetBulkMetadataV2ApiControllerAddTags = exports.assetBulkActionV2ApiControllerDisableMaintenance = exports.assetBulkActionV2ApiControllerEnableMaintenance = exports.assetBulkActionV2ApiControllerVersionUpdate = exports.assetBulkActionV2ApiControllerRetrieveLogs = exports.assetBulkActionV2ApiControllerUnisolate = exports.assetBulkActionV2ApiControllerIsolate = exports.assetBulkActionV2ApiControllerShutdown = exports.assetBulkActionV2ApiControllerReboot = exports.assetActionV2ApiControllerImportPpcToExistingAsset = exports.assetActionV2ApiControllerDisableMaintenance = exports.assetActionV2ApiControllerEnableMaintenance = exports.assetActionV2ApiControllerVersionUpdate = exports.assetActionV2ApiControllerRetrieveLogs = exports.assetActionV2ApiControllerUnisolate = exports.assetActionV2ApiControllerIsolate = exports.assetActionV2ApiControllerShutdown = exports.assetActionV2ApiControllerReboot = exports.investigationSqlV2ApiControllerExecuteSqlQuery = exports.investigationSqlV2ApiControllerGetSchema = exports.investigationEvidenceFlagV2ApiControllerUnflagEvidence = exports.investigationEvidenceFlagV2ApiControllerFlagEvidence = exports.flagsLibraryV2ApiControllerUpdate = exports.flagsLibraryV2ApiControllerGet = exports.flagsLibraryV2ApiControllerDelete = exports.flagsLibraryV2ApiControllerCreate = exports.flagsLibraryV2ApiControllerList = exports.interactCommandV2ApiControllerList = exports.interactLibraryFileV2ApiControllerDownload = exports.interactLibraryFileV2ApiControllerDelete = exports.interactLibraryFileV2ApiControllerBulkDelete = exports.interactLibraryFileV2ApiControllerUpload = exports.interactLibraryFileV2ApiControllerList = exports.interactLibraryTagV2ApiControllerUpdate = exports.interactLibraryTagV2ApiControllerGet = exports.interactLibraryTagV2ApiControllerDelete = exports.interactLibraryTagV2ApiControllerBulkDelete = exports.interactLibraryTagV2ApiControllerCreate = exports.interactLibraryTagV2ApiControllerList = exports.interactLibrarySnippetV2ApiControllerUpdate = exports.interactLibrarySnippetV2ApiControllerGet = exports.interactLibrarySnippetV2ApiControllerDelete = exports.interactLibrarySnippetV2ApiControllerBulkDelete = exports.interactLibrarySnippetV2ApiControllerCreate = exports.interactLibrarySnippetV2ApiControllerList = exports.caseV2ApiControllerUpdateCase = exports.caseV2ApiControllerGetCaseByIdOrName = void 0;
|
|
7
|
+
exports.diskImageAcquisitionLibraryApiControllerUpdate = exports.diskImageAcquisitionLibraryApiControllerGet = exports.diskImageAcquisitionLibraryApiControllerDelete = exports.diskImageAcquisitionLibraryApiControllerBulkDelete = exports.diskImageAcquisitionLibraryApiControllerCreate = exports.diskImageAcquisitionLibraryApiControllerList = exports.cloudAcquisitionLibraryApiControllerUpdate = exports.cloudAcquisitionLibraryApiControllerGet = exports.cloudAcquisitionLibraryApiControllerDelete = exports.cloudAcquisitionLibraryApiControllerBulkDelete = exports.cloudAcquisitionLibraryApiControllerCreate = exports.cloudAcquisitionLibraryApiControllerList = exports.assetInteractMessageV2ApiControllerGetSessionReport = exports.assetInteractMessageV2ApiControllerDownloadMessageOutput = exports.assetInteractMessageV2ApiControllerGetMessage = exports.assetInteractMessageV2ApiControllerListSessionsForAsset = exports.assetAcquisitionV2ApiControllerFilterAcquisitionTasks = exports.assetAcquisitionV2ApiControllerDeleteAcquisitionAssignment = exports.assetAcquisitionV2ApiControllerCancelAcquisition = exports.assetAcquisitionV2ApiControllerAcquire = exports.assetTriageV2ApiControllerDeleteTriageAssignment = exports.assetTriageV2ApiControllerCancelTriage = exports.assetTriageV2ApiControllerRunTriage = exports.assetTriageV2ApiControllerFilterTriageTasks = exports.assetV2ApiControllerUpdateLabel = exports.assetV2ApiControllerReplaceTags = exports.assetV2ApiControllerGetAsset = exports.assetV2ApiControllerDeleteAsset = exports.assetV2ApiControllerFilterAssets = exports.assetV2ApiControllerExportAssets = exports.assetV2ApiControllerGetStats = exports.assetInteractV2ApiControllerCloseSession = exports.assetInteractV2ApiControllerCancelCommand = exports.assetInteractV2ApiControllerRunCommand = exports.assetInteractMessageV2ApiControllerListForAsset = exports.assetBulkTriageV2ApiControllerRunTriage = exports.assetBulkMetadataV2ApiControllerImportOffNetworkPpc = exports.assetBulkMetadataV2ApiControllerDeleteAssets = exports.assetBulkMetadataV2ApiControllerSetMitreDatabaseVersion = void 0;
|
|
8
8
|
const client_1 = require("./client");
|
|
9
9
|
const client_gen_1 = require("./client.gen");
|
|
10
10
|
/**
|
|
@@ -36,6 +36,7 @@ exports.capabilitiesV2ApiControllerGet = capabilitiesV2ApiControllerGet;
|
|
|
36
36
|
*/
|
|
37
37
|
const openApiAliasV2ApiControllerGet = (options) => {
|
|
38
38
|
return (options?.client ?? client_gen_1.client).get({
|
|
39
|
+
responseType: 'json',
|
|
39
40
|
security: [
|
|
40
41
|
{
|
|
41
42
|
scheme: 'bearer',
|
|
@@ -54,7 +55,7 @@ const openApiAliasV2ApiControllerGet = (options) => {
|
|
|
54
55
|
exports.openApiAliasV2ApiControllerGet = openApiAliasV2ApiControllerGet;
|
|
55
56
|
/**
|
|
56
57
|
* Get task by id
|
|
57
|
-
*
|
|
58
|
+
* Fetches one task by UUID, regardless of task type (triage, acquisition, interactShell, ...). Returns the task in `result.entities[0]` with status counts, owning organizations, linked cases, schedule and the type-specific domain block.
|
|
58
59
|
*/
|
|
59
60
|
const tasksV2ApiControllerGetTaskById = (options) => {
|
|
60
61
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -77,7 +78,7 @@ const tasksV2ApiControllerGetTaskById = (options) => {
|
|
|
77
78
|
exports.tasksV2ApiControllerGetTaskById = tasksV2ApiControllerGetTaskById;
|
|
78
79
|
/**
|
|
79
80
|
* Update a task (rename + schedule; dryRun query preview)
|
|
80
|
-
*
|
|
81
|
+
* Updates one task; send only the fields to change. Tasks in `scheduled` status accept the full field set (name, case link, schedule and execution config); tasks in any other status accept only `taskName` and `caseIdOrName`, and other fields are skipped and reported in the errors list. Returns the updated task in `result.entities[0]`.
|
|
81
82
|
*/
|
|
82
83
|
const tasksV2ApiControllerUpdateTask = (options) => {
|
|
83
84
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -104,7 +105,7 @@ const tasksV2ApiControllerUpdateTask = (options) => {
|
|
|
104
105
|
exports.tasksV2ApiControllerUpdateTask = tasksV2ApiControllerUpdateTask;
|
|
105
106
|
/**
|
|
106
107
|
* List a task assets
|
|
107
|
-
*
|
|
108
|
+
* Lists the assets targeted by one task. Supports offset pagination and the same `filter[field]` querying as GET /api/v2/assets; entities use the asset shape from that endpoint. Per-asset assignment status lives on the task-assignments endpoint instead.
|
|
108
109
|
*/
|
|
109
110
|
const tasksV2ApiControllerListTaskAssets = (options) => {
|
|
110
111
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -127,7 +128,7 @@ const tasksV2ApiControllerListTaskAssets = (options) => {
|
|
|
127
128
|
exports.tasksV2ApiControllerListTaskAssets = tasksV2ApiControllerListTaskAssets;
|
|
128
129
|
/**
|
|
129
130
|
* List a task assignments
|
|
130
|
-
*
|
|
131
|
+
* Lists the per-endpoint task assignments of one task. Supports offset pagination and `filter[field]` querying; each entity carries the assignment status, progress, durations, endpoint reference, organizations and linked cases.
|
|
131
132
|
*/
|
|
132
133
|
const tasksV2ApiControllerListTaskAssignments = (options) => {
|
|
133
134
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -150,7 +151,7 @@ const tasksV2ApiControllerListTaskAssignments = (options) => {
|
|
|
150
151
|
exports.tasksV2ApiControllerListTaskAssignments = tasksV2ApiControllerListTaskAssignments;
|
|
151
152
|
/**
|
|
152
153
|
* List hunt (triage) tasks
|
|
153
|
-
*
|
|
154
|
+
* Lists hunt (triage) tasks — IOC/YARA/Sigma scans — as a task-centric paginated list scoped by `organizations`. Each entry carries the task status, enriched rules, match totals, assignment counters, schedule and timestamps. Supports offset pagination, `filter[field]` querying and whitelisted sorting; task ids from this list feed the single-task cancel and delete endpoints.
|
|
154
155
|
*/
|
|
155
156
|
const tasksTriageV2ApiControllerListHuntTasks = (options) => {
|
|
156
157
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -173,7 +174,7 @@ const tasksTriageV2ApiControllerListHuntTasks = (options) => {
|
|
|
173
174
|
exports.tasksTriageV2ApiControllerListHuntTasks = tasksTriageV2ApiControllerListHuntTasks;
|
|
174
175
|
/**
|
|
175
176
|
* Bulk cancel hunt (triage) tasks (body dryRun preview)
|
|
176
|
-
*
|
|
177
|
+
* Cancels one or more hunt (triage) tasks by id, or every active hunt task in the given organization scope when `all=true`. Cancellation is queued asynchronously across all assigned assets; task records and downloaded data are kept. Set `dryRun=true` to preview the affected tasks and assignment counts without cancelling anything.
|
|
177
178
|
*/
|
|
178
179
|
const tasksTriageV2ApiControllerCancel = (options) => {
|
|
179
180
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -200,7 +201,7 @@ const tasksTriageV2ApiControllerCancel = (options) => {
|
|
|
200
201
|
exports.tasksTriageV2ApiControllerCancel = tasksTriageV2ApiControllerCancel;
|
|
201
202
|
/**
|
|
202
203
|
* Bulk delete hunt (triage) tasks (body dryRun preview)
|
|
203
|
-
*
|
|
204
|
+
* Deletes one or more hunt (triage) tasks by id, or every hunt task in the given organization scope when `all=true`. Deletion is irreversible: task records, all assignments and downloaded artifacts are removed, and active tasks are cancelled on the agents. Set `dryRun=true` to preview the affected tasks and assets without deleting anything.
|
|
204
205
|
*/
|
|
205
206
|
const tasksTriageV2ApiControllerDelete = (options) => {
|
|
206
207
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -227,7 +228,7 @@ const tasksTriageV2ApiControllerDelete = (options) => {
|
|
|
227
228
|
exports.tasksTriageV2ApiControllerDelete = tasksTriageV2ApiControllerDelete;
|
|
228
229
|
/**
|
|
229
230
|
* Cancel a single hunt (triage) task (dryRun query preview)
|
|
230
|
-
*
|
|
231
|
+
* Cancels a single hunt (triage) task, stopping all of its active assignments across assets; cancellation is queued asynchronously. The task record and downloaded data are kept. Set `dryRun=true` to preview the effect without cancelling.
|
|
231
232
|
*/
|
|
232
233
|
const tasksTriageV2ApiControllerCancelOne = (options) => {
|
|
233
234
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -250,7 +251,7 @@ const tasksTriageV2ApiControllerCancelOne = (options) => {
|
|
|
250
251
|
exports.tasksTriageV2ApiControllerCancelOne = tasksTriageV2ApiControllerCancelOne;
|
|
251
252
|
/**
|
|
252
253
|
* Delete a single hunt (triage) task (dryRun query preview)
|
|
253
|
-
*
|
|
254
|
+
* Deletes a single hunt (triage) task, irreversibly removing its record, all of its assignments and any downloaded artifacts; an active task is also cancelled on the agents. Set `dryRun=true` to preview the affected assignments and assets without deleting anything.
|
|
254
255
|
*/
|
|
255
256
|
const tasksTriageV2ApiControllerDeleteOne = (options) => {
|
|
256
257
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -273,7 +274,7 @@ const tasksTriageV2ApiControllerDeleteOne = (options) => {
|
|
|
273
274
|
exports.tasksTriageV2ApiControllerDeleteOne = tasksTriageV2ApiControllerDeleteOne;
|
|
274
275
|
/**
|
|
275
276
|
* List device acquisition profiles
|
|
276
|
-
*
|
|
277
|
+
* Lists device (evidence) acquisition profiles as paginated summary rows scoped by `organizations`, with `filter[field]` querying and sorting by name, createdBy, createdAt, lastUsedAt or lastUsedBy. Each row carries id, name, organizations, usage metadata and a detailsUrl; per-OS configs are returned by the single-profile endpoint.
|
|
277
278
|
*/
|
|
278
279
|
const acquisitionLibraryDeviceV2ApiControllerList = (options) => {
|
|
279
280
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -296,7 +297,7 @@ const acquisitionLibraryDeviceV2ApiControllerList = (options) => {
|
|
|
296
297
|
exports.acquisitionLibraryDeviceV2ApiControllerList = acquisitionLibraryDeviceV2ApiControllerList;
|
|
297
298
|
/**
|
|
298
299
|
* Create device acquisition profile
|
|
299
|
-
*
|
|
300
|
+
* Creates a device (evidence) acquisition profile from a required `name` plus at least one config block: windows, linux, macos, aix or eDiscovery. Body `organizationIds` controls which organizations own the profile. With dryRun=true (the default) the request is only validated and the would-be profile is returned without persisting; a real create returns the profile detail in entities[0].
|
|
300
301
|
*/
|
|
301
302
|
const acquisitionLibraryDeviceV2ApiControllerCreate = (options) => {
|
|
302
303
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -323,7 +324,7 @@ const acquisitionLibraryDeviceV2ApiControllerCreate = (options) => {
|
|
|
323
324
|
exports.acquisitionLibraryDeviceV2ApiControllerCreate = acquisitionLibraryDeviceV2ApiControllerCreate;
|
|
324
325
|
/**
|
|
325
326
|
* Bulk delete device acquisition profiles
|
|
326
|
-
*
|
|
327
|
+
* Deletes several device (evidence) acquisition profiles in one request, resolving each item by UUID or exact name. Unknown, ambiguous, in-use or system profiles are skipped and reported in warnings[] instead of failing the batch. With dryRun=true (the default) the response previews what would be deleted; a real delete returns deletedCount plus warnings[].
|
|
327
328
|
*/
|
|
328
329
|
const acquisitionLibraryDeviceV2ApiControllerBulkDelete = (options) => {
|
|
329
330
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -350,7 +351,7 @@ const acquisitionLibraryDeviceV2ApiControllerBulkDelete = (options) => {
|
|
|
350
351
|
exports.acquisitionLibraryDeviceV2ApiControllerBulkDelete = acquisitionLibraryDeviceV2ApiControllerBulkDelete;
|
|
351
352
|
/**
|
|
352
353
|
* Delete device acquisition profile
|
|
353
|
-
*
|
|
354
|
+
* Deletes one device (evidence) acquisition profile by UUID or exact name. Profiles referenced by running or scheduled acquisition tasks are protected (400 PROFILE_IN_USE), and system profiles cannot be deleted (406 SYSTEM_PROFILE_IMMUTABLE). With dryRun=true (the default) the response shows what would be deleted without removing anything.
|
|
354
355
|
*/
|
|
355
356
|
const acquisitionLibraryDeviceV2ApiControllerDelete = (options) => {
|
|
356
357
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -373,7 +374,7 @@ const acquisitionLibraryDeviceV2ApiControllerDelete = (options) => {
|
|
|
373
374
|
exports.acquisitionLibraryDeviceV2ApiControllerDelete = acquisitionLibraryDeviceV2ApiControllerDelete;
|
|
374
375
|
/**
|
|
375
376
|
* Get device acquisition profile by id or name
|
|
376
|
-
*
|
|
377
|
+
* Fetches one device (evidence) acquisition profile by UUID or exact name, returning the full detail in entities[0]: per-OS configs (windows, linux, macos, aix), eDiscovery patterns, organizations and timestamps. A name matching several profiles returns 400 AMBIGUOUS_NAME with candidates; an unknown identifier returns 404 with suggestions.
|
|
377
378
|
*/
|
|
378
379
|
const acquisitionLibraryDeviceV2ApiControllerGet = (options) => {
|
|
379
380
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -396,7 +397,7 @@ const acquisitionLibraryDeviceV2ApiControllerGet = (options) => {
|
|
|
396
397
|
exports.acquisitionLibraryDeviceV2ApiControllerGet = acquisitionLibraryDeviceV2ApiControllerGet;
|
|
397
398
|
/**
|
|
398
399
|
* Update device acquisition profile
|
|
399
|
-
*
|
|
400
|
+
* Partially updates one device (evidence) acquisition profile: only the provided fields (name, organizationIds, windows, linux, macos, aix, eDiscovery) change, and passing null removes an OS block. The merged profile must keep at least one config block, and system profiles cannot be updated. With dryRun=true (the default) the merged profile is previewed without persisting.
|
|
400
401
|
*/
|
|
401
402
|
const acquisitionLibraryDeviceV2ApiControllerUpdate = (options) => {
|
|
402
403
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -423,7 +424,7 @@ const acquisitionLibraryDeviceV2ApiControllerUpdate = (options) => {
|
|
|
423
424
|
exports.acquisitionLibraryDeviceV2ApiControllerUpdate = acquisitionLibraryDeviceV2ApiControllerUpdate;
|
|
424
425
|
/**
|
|
425
426
|
* List triage rules
|
|
426
|
-
*
|
|
427
|
+
* Lists triage rules (YARA, Sigma and osquery) from the triage library, scoped by `organizations`. Supports offset pagination, whitelisted sorting and `filter[field]` querying. Each entry is a rule summary without the rule body.
|
|
427
428
|
*/
|
|
428
429
|
const triageLibraryV2ApiControllerList = (options) => {
|
|
429
430
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -446,7 +447,7 @@ const triageLibraryV2ApiControllerList = (options) => {
|
|
|
446
447
|
exports.triageLibraryV2ApiControllerList = triageLibraryV2ApiControllerList;
|
|
447
448
|
/**
|
|
448
449
|
* Create triage rule
|
|
449
|
-
*
|
|
450
|
+
* Creates a triage rule from the submitted rule content; the content is validated by its engine before saving, and name and engine are auto-detected when omitted. Supports a dry-run preview that returns the would-be rule without persisting it. Returns the created rule detail plus any warnings, such as name adjustments after a collision.
|
|
450
451
|
*/
|
|
451
452
|
const triageLibraryV2ApiControllerCreate = (options) => {
|
|
452
453
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -473,7 +474,7 @@ const triageLibraryV2ApiControllerCreate = (options) => {
|
|
|
473
474
|
exports.triageLibraryV2ApiControllerCreate = triageLibraryV2ApiControllerCreate;
|
|
474
475
|
/**
|
|
475
476
|
* Bulk delete triage rules
|
|
476
|
-
*
|
|
477
|
+
* Deletes several triage rules in one request, identified by UUID or exact name in the `rules` body field. Rules that cannot be resolved are skipped and reported as warnings, and a dry-run preview lists what would be deleted. Returns the number of deleted rules.
|
|
477
478
|
*/
|
|
478
479
|
const triageLibraryV2ApiControllerBulkDelete = (options) => {
|
|
479
480
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -500,7 +501,7 @@ const triageLibraryV2ApiControllerBulkDelete = (options) => {
|
|
|
500
501
|
exports.triageLibraryV2ApiControllerBulkDelete = triageLibraryV2ApiControllerBulkDelete;
|
|
501
502
|
/**
|
|
502
503
|
* Validate triage rule
|
|
503
|
-
*
|
|
504
|
+
* Validates triage rule content (YARA, Sigma or osquery) without persisting anything. The engine is auto-detected when omitted; a valid rule returns the detected engine and any advisories, while an invalid rule fails with a 400 error describing the problem.
|
|
504
505
|
*/
|
|
505
506
|
const triageLibraryV2ApiControllerValidate = (options) => {
|
|
506
507
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -527,7 +528,7 @@ const triageLibraryV2ApiControllerValidate = (options) => {
|
|
|
527
528
|
exports.triageLibraryV2ApiControllerValidate = triageLibraryV2ApiControllerValidate;
|
|
528
529
|
/**
|
|
529
530
|
* Delete triage rule
|
|
530
|
-
*
|
|
531
|
+
* Deletes one triage rule identified by UUID or exact name, removing the rule and its stored content from the triage library. A dry-run preview returns what would be deleted without removing anything; a real deletion returns the id and name of the deleted rule.
|
|
531
532
|
*/
|
|
532
533
|
const triageLibraryV2ApiControllerDelete = (options) => {
|
|
533
534
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -550,7 +551,7 @@ const triageLibraryV2ApiControllerDelete = (options) => {
|
|
|
550
551
|
exports.triageLibraryV2ApiControllerDelete = triageLibraryV2ApiControllerDelete;
|
|
551
552
|
/**
|
|
552
553
|
* Get triage rule by id or name
|
|
553
|
-
*
|
|
554
|
+
* Fetches one triage rule by UUID or exact name, including the rule content, engine, searchIn flags, organizations, tags and timestamps. A rule outside the caller's organization scope returns 404, possibly with a did-you-mean suggestion.
|
|
554
555
|
*/
|
|
555
556
|
const triageLibraryV2ApiControllerGet = (options) => {
|
|
556
557
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -573,7 +574,7 @@ const triageLibraryV2ApiControllerGet = (options) => {
|
|
|
573
574
|
exports.triageLibraryV2ApiControllerGet = triageLibraryV2ApiControllerGet;
|
|
574
575
|
/**
|
|
575
576
|
* Update triage rule
|
|
576
|
-
*
|
|
577
|
+
* Applies a partial update to one triage rule identified by UUID or exact name: only the submitted fields change, `tags` replaces the whole tag set, and the engine cannot be modified. A changed rule body is re-validated before saving, and a dry-run preview of the resulting rule is supported. Returns the updated rule detail plus any warnings.
|
|
577
578
|
*/
|
|
578
579
|
const triageLibraryV2ApiControllerUpdate = (options) => {
|
|
579
580
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -600,7 +601,7 @@ const triageLibraryV2ApiControllerUpdate = (options) => {
|
|
|
600
601
|
exports.triageLibraryV2ApiControllerUpdate = triageLibraryV2ApiControllerUpdate;
|
|
601
602
|
/**
|
|
602
603
|
* Export triage rules to an off-network package
|
|
603
|
-
*
|
|
604
|
+
* Bundles the selected triage rules into an off-network package for offline triage of air-gapped endpoints. Rules are resolved strictly, so any rule that cannot be found fails the request; with dryRun=true (the default) the response previews what would be exported instead of generating a package. A real export returns the generated file name, its download URL and the available agent binary options.
|
|
604
605
|
*/
|
|
605
606
|
const triageLibraryExportV2ApiControllerExport = (options) => {
|
|
606
607
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -627,10 +628,11 @@ const triageLibraryExportV2ApiControllerExport = (options) => {
|
|
|
627
628
|
exports.triageLibraryExportV2ApiControllerExport = triageLibraryExportV2ApiControllerExport;
|
|
628
629
|
/**
|
|
629
630
|
* Download an exported off-network package
|
|
630
|
-
*
|
|
631
|
+
* Streams a previously exported off-network triage package as a zip download. The fileName query parameter identifies the package generated by the export endpoint; agent binaries for selected platforms and MITRE ATT&CK rules can optionally be embedded into the package.
|
|
631
632
|
*/
|
|
632
633
|
const triageLibraryExportV2ApiControllerDownload = (options) => {
|
|
633
634
|
return (options.client ?? client_gen_1.client).get({
|
|
635
|
+
responseType: 'blob',
|
|
634
636
|
security: [
|
|
635
637
|
{
|
|
636
638
|
in: 'cookie',
|
|
@@ -647,9 +649,78 @@ const triageLibraryExportV2ApiControllerDownload = (options) => {
|
|
|
647
649
|
});
|
|
648
650
|
};
|
|
649
651
|
exports.triageLibraryExportV2ApiControllerDownload = triageLibraryExportV2ApiControllerDownload;
|
|
652
|
+
/**
|
|
653
|
+
* List users of an organization
|
|
654
|
+
* Lists users assigned to one caller-visible organization selected by numeric id or case-insensitive exact name. The result uses the canonical v2 user shape, including role privilege metadata, authentication posture, last-login and online-presence fields. Organization references on each user are clipped to organizations the caller can access, preventing membership disclosure across organization boundaries. Use filter[searchTerm] to search username and email; the response is classified as PII on agent-facing surfaces.
|
|
655
|
+
*/
|
|
656
|
+
const organizationUserV2ApiControllerListOrganizationUsers = (options) => {
|
|
657
|
+
return (options.client ?? client_gen_1.client).get({
|
|
658
|
+
responseType: 'json',
|
|
659
|
+
security: [
|
|
660
|
+
{
|
|
661
|
+
in: 'cookie',
|
|
662
|
+
name: 'Authentication',
|
|
663
|
+
type: 'apiKey'
|
|
664
|
+
},
|
|
665
|
+
{
|
|
666
|
+
scheme: 'bearer',
|
|
667
|
+
type: 'http'
|
|
668
|
+
}
|
|
669
|
+
],
|
|
670
|
+
url: '/api/v2/organizations/{idOrName}/users',
|
|
671
|
+
...options
|
|
672
|
+
});
|
|
673
|
+
};
|
|
674
|
+
exports.organizationUserV2ApiControllerListOrganizationUsers = organizationUserV2ApiControllerListOrganizationUsers;
|
|
675
|
+
/**
|
|
676
|
+
* List organizations
|
|
677
|
+
* Lists the organizations visible to the caller using offset pagination. Use organizations to narrow the caller-accessible scope by numeric id or exact name; omitting it selects all accessible organizations. Each result maps the internal _id to id, excludes the deployment credential, and includes totalEndpoints for inventory sizing. filter[name] performs a case-insensitive name contains match, while filter[searchTerm] searches name, owner, and an exact numeric id.
|
|
678
|
+
*/
|
|
679
|
+
const organizationV2ApiControllerListOrganizations = (options) => {
|
|
680
|
+
return (options?.client ?? client_gen_1.client).get({
|
|
681
|
+
responseType: 'json',
|
|
682
|
+
security: [
|
|
683
|
+
{
|
|
684
|
+
in: 'cookie',
|
|
685
|
+
name: 'Authentication',
|
|
686
|
+
type: 'apiKey'
|
|
687
|
+
},
|
|
688
|
+
{
|
|
689
|
+
scheme: 'bearer',
|
|
690
|
+
type: 'http'
|
|
691
|
+
}
|
|
692
|
+
],
|
|
693
|
+
url: '/api/v2/organizations',
|
|
694
|
+
...options
|
|
695
|
+
});
|
|
696
|
+
};
|
|
697
|
+
exports.organizationV2ApiControllerListOrganizations = organizationV2ApiControllerListOrganizations;
|
|
698
|
+
/**
|
|
699
|
+
* Get organization by id or name
|
|
700
|
+
* Returns one caller-visible organization selected by numeric id or case-insensitive exact name. The response excludes the deployment credential and reports endpoint totals plus total, open, closed, and archived case counts. An inaccessible organization is returned as a leak-safe 404. A numeric miss has no suggestions; a name miss may include ranked suggestions drawn only from organizations visible to the caller.
|
|
701
|
+
*/
|
|
702
|
+
const organizationV2ApiControllerGetOrganizationByIdOrName = (options) => {
|
|
703
|
+
return (options.client ?? client_gen_1.client).get({
|
|
704
|
+
responseType: 'json',
|
|
705
|
+
security: [
|
|
706
|
+
{
|
|
707
|
+
in: 'cookie',
|
|
708
|
+
name: 'Authentication',
|
|
709
|
+
type: 'apiKey'
|
|
710
|
+
},
|
|
711
|
+
{
|
|
712
|
+
scheme: 'bearer',
|
|
713
|
+
type: 'http'
|
|
714
|
+
}
|
|
715
|
+
],
|
|
716
|
+
url: '/api/v2/organizations/{idOrName}',
|
|
717
|
+
...options
|
|
718
|
+
});
|
|
719
|
+
};
|
|
720
|
+
exports.organizationV2ApiControllerGetOrganizationByIdOrName = organizationV2ApiControllerGetOrganizationByIdOrName;
|
|
650
721
|
/**
|
|
651
722
|
* List case activities across visible cases
|
|
652
|
-
*
|
|
723
|
+
* Lists the global audit activity feed across all cases visible to the caller, with offset pagination and optional filters over case, type, performer, time window and free text. Each row carries the activity type, the user who performed it, the raw event payload and a computed description. Set format=csv to stream the feed as CSV.
|
|
653
724
|
*/
|
|
654
725
|
const caseActivityV2ApiControllerFilterGlobalActivities = (options) => {
|
|
655
726
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -672,7 +743,7 @@ const caseActivityV2ApiControllerFilterGlobalActivities = (options) => {
|
|
|
672
743
|
exports.caseActivityV2ApiControllerFilterGlobalActivities = caseActivityV2ApiControllerFilterGlobalActivities;
|
|
673
744
|
/**
|
|
674
745
|
* List activities for case
|
|
675
|
-
*
|
|
746
|
+
* Lists the audit activity feed of one case identified by UUID or exact name, with offset pagination and optional filters over type, performer, time window and free text. Each row carries the activity type, the user who performed it, the raw event payload and a computed description.
|
|
676
747
|
*/
|
|
677
748
|
const caseActivityV2ApiControllerFilterCaseActivities = (options) => {
|
|
678
749
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -695,7 +766,7 @@ const caseActivityV2ApiControllerFilterCaseActivities = (options) => {
|
|
|
695
766
|
exports.caseActivityV2ApiControllerFilterCaseActivities = caseActivityV2ApiControllerFilterCaseActivities;
|
|
696
767
|
/**
|
|
697
768
|
* Export cases
|
|
698
|
-
*
|
|
769
|
+
* Exports the cases matching the filter as a downloadable file. format=csv (default) streams a text/csv file; format=json streams an application/zip archive containing cases.json with up to the newest 10000 matching cases. The filter model matches GET /api/v2/cases.
|
|
699
770
|
*/
|
|
700
771
|
const caseExportV2ApiControllerExportCases = (options) => {
|
|
701
772
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -718,7 +789,7 @@ const caseExportV2ApiControllerExportCases = (options) => {
|
|
|
718
789
|
exports.caseExportV2ApiControllerExportCases = caseExportV2ApiControllerExportCases;
|
|
719
790
|
/**
|
|
720
791
|
* Close cases in bulk
|
|
721
|
-
*
|
|
792
|
+
* Closes multiple cases in one request, targeted by ids or names in cases[] or by cases="all" within an organization scope. Eligible cases are closed and skipped ones are reported in warnings[] (partial success); a dryRun preview of the affected cases is supported.
|
|
722
793
|
*/
|
|
723
794
|
const caseBulkActionV2ApiControllerClose = (options) => {
|
|
724
795
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -745,7 +816,7 @@ const caseBulkActionV2ApiControllerClose = (options) => {
|
|
|
745
816
|
exports.caseBulkActionV2ApiControllerClose = caseBulkActionV2ApiControllerClose;
|
|
746
817
|
/**
|
|
747
818
|
* Archive cases in bulk
|
|
748
|
-
*
|
|
819
|
+
* Archives multiple closed cases in one request, targeted by ids or names in cases[] or by cases="all" within an organization scope. Only closed cases are eligible; skipped cases are reported in warnings[] (partial success) and a dryRun preview is supported. Archiving cannot be undone.
|
|
749
820
|
*/
|
|
750
821
|
const caseBulkActionV2ApiControllerArchive = (options) => {
|
|
751
822
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -772,7 +843,7 @@ const caseBulkActionV2ApiControllerArchive = (options) => {
|
|
|
772
843
|
exports.caseBulkActionV2ApiControllerArchive = caseBulkActionV2ApiControllerArchive;
|
|
773
844
|
/**
|
|
774
845
|
* List assets linked to case
|
|
775
|
-
*
|
|
846
|
+
* Lists the assets linked to one case identified by UUID or exact name, returning full v2 asset entities with offset pagination and an optional endpoint filter. Set format=csv to stream the linked assets as CSV instead of JSON.
|
|
776
847
|
*/
|
|
777
848
|
const caseAssetV2ApiControllerFilterAssets = (options) => {
|
|
778
849
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -795,7 +866,7 @@ const caseAssetV2ApiControllerFilterAssets = (options) => {
|
|
|
795
866
|
exports.caseAssetV2ApiControllerFilterAssets = caseAssetV2ApiControllerFilterAssets;
|
|
796
867
|
/**
|
|
797
868
|
* List users for case
|
|
798
|
-
*
|
|
869
|
+
* Lists the users who can participate in one case identified by UUID or exact name, with offset pagination and a searchTerm filter over username and email. Each entity carries roles with privileges, organization references, admin flags and login and presence details; the organization scope derives from the case itself.
|
|
799
870
|
*/
|
|
800
871
|
const caseUserV2ApiControllerFilterUsers = (options) => {
|
|
801
872
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -818,7 +889,7 @@ const caseUserV2ApiControllerFilterUsers = (options) => {
|
|
|
818
889
|
exports.caseUserV2ApiControllerFilterUsers = caseUserV2ApiControllerFilterUsers;
|
|
819
890
|
/**
|
|
820
891
|
* List task assignments for case
|
|
821
|
-
*
|
|
892
|
+
* Lists the tasks of one case identified by UUID or exact name as assignment-centric rows: a task assigned to N assets yields N rows with per-asset status and endpoint fields. The paginated result also carries a metadata.creators summary of the unique task creators across the case.
|
|
822
893
|
*/
|
|
823
894
|
const caseTaskV2ApiControllerFilterTasks = (options) => {
|
|
824
895
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -841,7 +912,7 @@ const caseTaskV2ApiControllerFilterTasks = (options) => {
|
|
|
841
912
|
exports.caseTaskV2ApiControllerFilterTasks = caseTaskV2ApiControllerFilterTasks;
|
|
842
913
|
/**
|
|
843
914
|
* List case notes
|
|
844
|
-
*
|
|
915
|
+
* Lists the notes of a case identified by UUID or exact case name. Read-only and paginated; supports filtering by writer and free-text search over the note body. Each note carries its id, text, writer details and timestamps.
|
|
845
916
|
*/
|
|
846
917
|
const caseNoteV2ApiControllerFilterNotes = (options) => {
|
|
847
918
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -864,7 +935,7 @@ const caseNoteV2ApiControllerFilterNotes = (options) => {
|
|
|
864
935
|
exports.caseNoteV2ApiControllerFilterNotes = caseNoteV2ApiControllerFilterNotes;
|
|
865
936
|
/**
|
|
866
937
|
* Create case note
|
|
867
|
-
*
|
|
938
|
+
* Adds a note to an open case identified by UUID or exact case name; the note text is limited to 10000 characters. With dryRun=true the response is a would-create preview and nothing is persisted; otherwise the created note is returned in `result.entities[0]`.
|
|
868
939
|
*/
|
|
869
940
|
const caseNoteV2ApiControllerCreateNote = (options) => {
|
|
870
941
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -891,7 +962,7 @@ const caseNoteV2ApiControllerCreateNote = (options) => {
|
|
|
891
962
|
exports.caseNoteV2ApiControllerCreateNote = caseNoteV2ApiControllerCreateNote;
|
|
892
963
|
/**
|
|
893
964
|
* Delete case note
|
|
894
|
-
*
|
|
965
|
+
* Deletes one note from an open case; deletion is restricted to the note's author or an authorized manager and is irreversible once executed. With dryRun=true the response is a would-delete preview and nothing is removed; otherwise a deletion receipt is returned in `result.entities[0]`.
|
|
895
966
|
*/
|
|
896
967
|
const caseNoteV2ApiControllerDeleteNote = (options) => {
|
|
897
968
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -914,7 +985,7 @@ const caseNoteV2ApiControllerDeleteNote = (options) => {
|
|
|
914
985
|
exports.caseNoteV2ApiControllerDeleteNote = caseNoteV2ApiControllerDeleteNote;
|
|
915
986
|
/**
|
|
916
987
|
* Update case note
|
|
917
|
-
*
|
|
988
|
+
* Replaces the text of one note on an open case; only the note's author or an authorized manager may edit it. With dryRun=true the response is a would-update preview and nothing is persisted; otherwise the updated note is returned in `result.entities[0]`.
|
|
918
989
|
*/
|
|
919
990
|
const caseNoteV2ApiControllerUpdateNote = (options) => {
|
|
920
991
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -941,7 +1012,7 @@ const caseNoteV2ApiControllerUpdateNote = (options) => {
|
|
|
941
1012
|
exports.caseNoteV2ApiControllerUpdateNote = caseNoteV2ApiControllerUpdateNote;
|
|
942
1013
|
/**
|
|
943
1014
|
* List task assignments for case
|
|
944
|
-
*
|
|
1015
|
+
* Lists the task assignments attached to one case identified by UUID or exact name, with offset pagination and filters over status, type, assets and data import state. Each entity carries the task reference, per-asset status, the targeted asset and timestamps.
|
|
945
1016
|
*/
|
|
946
1017
|
const caseTaskAssignmentV2ApiControllerFilterTaskAssignments = (options) => {
|
|
947
1018
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -964,7 +1035,7 @@ const caseTaskAssignmentV2ApiControllerFilterTaskAssignments = (options) => {
|
|
|
964
1035
|
exports.caseTaskAssignmentV2ApiControllerFilterTaskAssignments = caseTaskAssignmentV2ApiControllerFilterTaskAssignments;
|
|
965
1036
|
/**
|
|
966
1037
|
* Import task assignments into case
|
|
967
|
-
*
|
|
1038
|
+
* Imports task assignments into an open case from either a task id or an explicit list of assignment ids, optionally restricted to specific assets. Eligible assignments are attached and ineligible ones are reported in warnings[] (partial success); a dryRun preview is supported.
|
|
968
1039
|
*/
|
|
969
1040
|
const caseTaskAssignmentV2ApiControllerImportTaskAssignments = (options) => {
|
|
970
1041
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -991,7 +1062,7 @@ const caseTaskAssignmentV2ApiControllerImportTaskAssignments = (options) => {
|
|
|
991
1062
|
exports.caseTaskAssignmentV2ApiControllerImportTaskAssignments = caseTaskAssignmentV2ApiControllerImportTaskAssignments;
|
|
992
1063
|
/**
|
|
993
1064
|
* Detach a task assignment from case
|
|
994
|
-
*
|
|
1065
|
+
* Detaches one task assignment from an open case without deleting the assignment or its task data. The operation is idempotent and supports a dryRun preview; detaching an assignment that is not attached returns deletedCount 0 with a skipped warning.
|
|
995
1066
|
*/
|
|
996
1067
|
const caseTaskAssignmentV2ApiControllerRemoveTaskAssignment = (options) => {
|
|
997
1068
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -1014,7 +1085,7 @@ const caseTaskAssignmentV2ApiControllerRemoveTaskAssignment = (options) => {
|
|
|
1014
1085
|
exports.caseTaskAssignmentV2ApiControllerRemoveTaskAssignment = caseTaskAssignmentV2ApiControllerRemoveTaskAssignment;
|
|
1015
1086
|
/**
|
|
1016
1087
|
* Close a case
|
|
1017
|
-
*
|
|
1088
|
+
* Closes an open case identified by id or name. Requires a closure `reason` (resolved, false-positive, duplicate, other); the optional summary fields feed the closure report. Returns the closed case, including a closure report URL, in `result.entities[0]`; with `dryRun` a would-close preview is returned instead.
|
|
1018
1089
|
*/
|
|
1019
1090
|
const caseActionV2ApiControllerClose = (options) => {
|
|
1020
1091
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1041,7 +1112,7 @@ const caseActionV2ApiControllerClose = (options) => {
|
|
|
1041
1112
|
exports.caseActionV2ApiControllerClose = caseActionV2ApiControllerClose;
|
|
1042
1113
|
/**
|
|
1043
1114
|
* Reopen a case
|
|
1044
|
-
*
|
|
1115
|
+
* Reopens a closed case identified by id or name; open and archived cases are rejected with a lifecycle error. Returns the reopened case in `result.entities[0]`; with `dryRun` a would-open preview is returned instead.
|
|
1045
1116
|
*/
|
|
1046
1117
|
const caseActionV2ApiControllerReopen = (options) => {
|
|
1047
1118
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1064,7 +1135,7 @@ const caseActionV2ApiControllerReopen = (options) => {
|
|
|
1064
1135
|
exports.caseActionV2ApiControllerReopen = caseActionV2ApiControllerReopen;
|
|
1065
1136
|
/**
|
|
1066
1137
|
* Archive a case
|
|
1067
|
-
*
|
|
1138
|
+
* Archives a closed case identified by id or name. Archiving is the final lifecycle step (open, closed, archived) and cannot be undone; only a closed case can be archived. Returns the archived case in `result.entities[0]`; with `dryRun` a would-archive preview is returned instead.
|
|
1068
1139
|
*/
|
|
1069
1140
|
const caseActionV2ApiControllerArchive = (options) => {
|
|
1070
1141
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1087,7 +1158,7 @@ const caseActionV2ApiControllerArchive = (options) => {
|
|
|
1087
1158
|
exports.caseActionV2ApiControllerArchive = caseActionV2ApiControllerArchive;
|
|
1088
1159
|
/**
|
|
1089
1160
|
* Unlink assets from a case
|
|
1090
|
-
*
|
|
1161
|
+
* Unlinks assets from an open case without deleting the assets themselves. Target assets by id or name in `assets[]` (takes precedence) or with a `filter` object matched against the assets linked to the case; unmatched targets are skipped with a warning. Returns the number of removed case-asset relations in `deletedCount`; with `dryRun` the assets that would be unlinked are previewed instead.
|
|
1091
1162
|
*/
|
|
1092
1163
|
const caseActionV2ApiControllerRemoveAssets = (options) => {
|
|
1093
1164
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1114,7 +1185,7 @@ const caseActionV2ApiControllerRemoveAssets = (options) => {
|
|
|
1114
1185
|
exports.caseActionV2ApiControllerRemoveAssets = caseActionV2ApiControllerRemoveAssets;
|
|
1115
1186
|
/**
|
|
1116
1187
|
* List cases
|
|
1117
|
-
*
|
|
1188
|
+
* Lists cases visible to the caller, scoped by `organizations`. Supports offset pagination, whitelisted sorting and `filter[field]` querying over name, status, owner, assigned user, visibility, category, tags, date ranges and a free-text search term. Start here to discover case ids for the single-case endpoints.
|
|
1118
1189
|
*/
|
|
1119
1190
|
const caseV2ApiControllerFilterCases = (options) => {
|
|
1120
1191
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -1137,7 +1208,7 @@ const caseV2ApiControllerFilterCases = (options) => {
|
|
|
1137
1208
|
exports.caseV2ApiControllerFilterCases = caseV2ApiControllerFilterCases;
|
|
1138
1209
|
/**
|
|
1139
1210
|
* Create a case
|
|
1140
|
-
*
|
|
1211
|
+
* Creates a case. Reference fields (owner, organization, category, tags, assignedUsers) accept a UUID or an exact name and are resolved before creation; the case name is auto-suffixed on a conflict. With dryRun=true the response is a would-create preview and nothing is persisted; otherwise the created case is returned in `result.entities[0]`.
|
|
1141
1212
|
*/
|
|
1142
1213
|
const caseV2ApiControllerCreateCase = (options) => {
|
|
1143
1214
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1164,7 +1235,7 @@ const caseV2ApiControllerCreateCase = (options) => {
|
|
|
1164
1235
|
exports.caseV2ApiControllerCreateCase = caseV2ApiControllerCreateCase;
|
|
1165
1236
|
/**
|
|
1166
1237
|
* Get case by id or name
|
|
1167
|
-
*
|
|
1238
|
+
* Fetches one case by UUID or exact case name, returned in `result.entities[0]`. The entity carries object references (owner, organizations, category, tags, assigned users) plus task counts and asset/task-assignment summaries. Cases outside the caller's organizations answer with 404.
|
|
1168
1239
|
*/
|
|
1169
1240
|
const caseV2ApiControllerGetCaseByIdOrName = (options) => {
|
|
1170
1241
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -1187,7 +1258,7 @@ const caseV2ApiControllerGetCaseByIdOrName = (options) => {
|
|
|
1187
1258
|
exports.caseV2ApiControllerGetCaseByIdOrName = caseV2ApiControllerGetCaseByIdOrName;
|
|
1188
1259
|
/**
|
|
1189
1260
|
* Update a case
|
|
1190
|
-
* Partially
|
|
1261
|
+
* Partially updates an open case: only supplied fields change, tags and metadata are replaced wholesale, removeCategory=true clears the category, and owner changes go through this endpoint. With dryRun=true the response is a would-update preview; a no-op update answers with a NOTHING_CHANGED error envelope.
|
|
1191
1262
|
*/
|
|
1192
1263
|
const caseV2ApiControllerUpdateCase = (options) => {
|
|
1193
1264
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -1214,7 +1285,7 @@ const caseV2ApiControllerUpdateCase = (options) => {
|
|
|
1214
1285
|
exports.caseV2ApiControllerUpdateCase = caseV2ApiControllerUpdateCase;
|
|
1215
1286
|
/**
|
|
1216
1287
|
* List InterAct command snippets
|
|
1217
|
-
*
|
|
1288
|
+
* Lists InterAct command snippets (reusable shell scripts) visible to the caller, scoped by `organizations`. Supports offset pagination, `filter[field]` querying and sorting by name, createdAt or updatedAt. Each entity carries the snippet's script, platforms, tags, organizations and origin.
|
|
1218
1289
|
*/
|
|
1219
1290
|
const interactLibrarySnippetV2ApiControllerList = (options) => {
|
|
1220
1291
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -1237,7 +1308,7 @@ const interactLibrarySnippetV2ApiControllerList = (options) => {
|
|
|
1237
1308
|
exports.interactLibrarySnippetV2ApiControllerList = interactLibrarySnippetV2ApiControllerList;
|
|
1238
1309
|
/**
|
|
1239
1310
|
* Create InterAct command snippet
|
|
1240
|
-
*
|
|
1311
|
+
* Creates a reusable InterAct command snippet from a `name` and `script`, with optional description, platforms, tags and organization scope. Name collisions are resolved by auto-suffixing and reported in `warnings[]`. Supports `dryRun` previews and returns the created snippet in `entities[0]`.
|
|
1241
1312
|
*/
|
|
1242
1313
|
const interactLibrarySnippetV2ApiControllerCreate = (options) => {
|
|
1243
1314
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1264,7 +1335,7 @@ const interactLibrarySnippetV2ApiControllerCreate = (options) => {
|
|
|
1264
1335
|
exports.interactLibrarySnippetV2ApiControllerCreate = interactLibrarySnippetV2ApiControllerCreate;
|
|
1265
1336
|
/**
|
|
1266
1337
|
* Bulk delete InterAct command snippets
|
|
1267
|
-
*
|
|
1338
|
+
* Deletes several InterAct command snippets in one call, targeted by UUID or exact name. Unknown or predefined (system) targets are skipped and reported in `warnings[]`. Supports `dryRun` previews and returns the number of deleted snippets in `deletedCount`.
|
|
1268
1339
|
*/
|
|
1269
1340
|
const interactLibrarySnippetV2ApiControllerBulkDelete = (options) => {
|
|
1270
1341
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1291,7 +1362,7 @@ const interactLibrarySnippetV2ApiControllerBulkDelete = (options) => {
|
|
|
1291
1362
|
exports.interactLibrarySnippetV2ApiControllerBulkDelete = interactLibrarySnippetV2ApiControllerBulkDelete;
|
|
1292
1363
|
/**
|
|
1293
1364
|
* Delete InterAct command snippet
|
|
1294
|
-
*
|
|
1365
|
+
* Deletes one InterAct command snippet identified by UUID or exact name, removing the snippet record and its tag relations. Predefined (system) snippets cannot be deleted. Supports `dryRun` previews and returns the deleted snippet's id and name in `entities[0]`.
|
|
1295
1366
|
*/
|
|
1296
1367
|
const interactLibrarySnippetV2ApiControllerDelete = (options) => {
|
|
1297
1368
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -1314,7 +1385,7 @@ const interactLibrarySnippetV2ApiControllerDelete = (options) => {
|
|
|
1314
1385
|
exports.interactLibrarySnippetV2ApiControllerDelete = interactLibrarySnippetV2ApiControllerDelete;
|
|
1315
1386
|
/**
|
|
1316
1387
|
* Get InterAct command snippet by id or name
|
|
1317
|
-
*
|
|
1388
|
+
* Fetches one InterAct command snippet by UUID or exact name, returned in `entities[0]` with the snippet's script, platforms, tags, organizations and origin. An unknown id or name returns 404.
|
|
1318
1389
|
*/
|
|
1319
1390
|
const interactLibrarySnippetV2ApiControllerGet = (options) => {
|
|
1320
1391
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -1337,7 +1408,7 @@ const interactLibrarySnippetV2ApiControllerGet = (options) => {
|
|
|
1337
1408
|
exports.interactLibrarySnippetV2ApiControllerGet = interactLibrarySnippetV2ApiControllerGet;
|
|
1338
1409
|
/**
|
|
1339
1410
|
* Update InterAct command snippet
|
|
1340
|
-
*
|
|
1411
|
+
* Applies a partial update to one InterAct command snippet identified by UUID or exact name; only the provided fields (name, script, description, platforms, tags, organizations) change. Predefined (system) snippets cannot be modified. Supports `dryRun` previews and returns the updated snippet in `entities[0]`.
|
|
1341
1412
|
*/
|
|
1342
1413
|
const interactLibrarySnippetV2ApiControllerUpdate = (options) => {
|
|
1343
1414
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -1364,7 +1435,7 @@ const interactLibrarySnippetV2ApiControllerUpdate = (options) => {
|
|
|
1364
1435
|
exports.interactLibrarySnippetV2ApiControllerUpdate = interactLibrarySnippetV2ApiControllerUpdate;
|
|
1365
1436
|
/**
|
|
1366
1437
|
* List InterAct command snippet tags
|
|
1367
|
-
*
|
|
1438
|
+
* Lists InterAct snippet tags (the shared tag store of the InterAct library) visible to the caller, scoped by `organizations`. Supports offset pagination, `filter[field]` querying and sorting by name, createdAt or updatedAt. Each entity carries the tag name, organizations and, with `filter[withCount]=true`, its snippet usage count.
|
|
1368
1439
|
*/
|
|
1369
1440
|
const interactLibraryTagV2ApiControllerList = (options) => {
|
|
1370
1441
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -1387,7 +1458,7 @@ const interactLibraryTagV2ApiControllerList = (options) => {
|
|
|
1387
1458
|
exports.interactLibraryTagV2ApiControllerList = interactLibraryTagV2ApiControllerList;
|
|
1388
1459
|
/**
|
|
1389
1460
|
* Create InterAct command snippet tag
|
|
1390
|
-
*
|
|
1461
|
+
* Creates an InterAct snippet tag in the shared tag store of the InterAct library from a `name`, with an optional organization scope. Name collisions are resolved by auto-suffixing and reported in `warnings[]`. Supports `dryRun` previews and returns the created tag in `entities[0]`.
|
|
1391
1462
|
*/
|
|
1392
1463
|
const interactLibraryTagV2ApiControllerCreate = (options) => {
|
|
1393
1464
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1414,7 +1485,7 @@ const interactLibraryTagV2ApiControllerCreate = (options) => {
|
|
|
1414
1485
|
exports.interactLibraryTagV2ApiControllerCreate = interactLibraryTagV2ApiControllerCreate;
|
|
1415
1486
|
/**
|
|
1416
1487
|
* Bulk delete InterAct command snippet tags
|
|
1417
|
-
*
|
|
1488
|
+
* Deletes several InterAct snippet tags in one call, targeted by UUID or exact name. Deleting a tag removes its snippet-tag relations while keeping the snippets. Unknown or system targets are skipped and reported in `warnings[]`. Supports `dryRun` previews and returns the number of deleted tags in `deletedCount`.
|
|
1418
1489
|
*/
|
|
1419
1490
|
const interactLibraryTagV2ApiControllerBulkDelete = (options) => {
|
|
1420
1491
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1441,7 +1512,7 @@ const interactLibraryTagV2ApiControllerBulkDelete = (options) => {
|
|
|
1441
1512
|
exports.interactLibraryTagV2ApiControllerBulkDelete = interactLibraryTagV2ApiControllerBulkDelete;
|
|
1442
1513
|
/**
|
|
1443
1514
|
* Delete InterAct command snippet tag
|
|
1444
|
-
*
|
|
1515
|
+
* Deletes one InterAct snippet tag identified by UUID or exact name, removing its snippet-tag relations while keeping the snippets. System tags cannot be deleted. Supports `dryRun` previews and returns the deleted tag identity in `entities[0]`.
|
|
1445
1516
|
*/
|
|
1446
1517
|
const interactLibraryTagV2ApiControllerDelete = (options) => {
|
|
1447
1518
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -1464,7 +1535,7 @@ const interactLibraryTagV2ApiControllerDelete = (options) => {
|
|
|
1464
1535
|
exports.interactLibraryTagV2ApiControllerDelete = interactLibraryTagV2ApiControllerDelete;
|
|
1465
1536
|
/**
|
|
1466
1537
|
* Get InterAct command snippet tag by id or name
|
|
1467
|
-
*
|
|
1538
|
+
* Fetches one InterAct snippet tag by UUID or exact name, returned in `entities[0]` with the tag's name, organizations and snippet usage count. An unknown id or name returns 404.
|
|
1468
1539
|
*/
|
|
1469
1540
|
const interactLibraryTagV2ApiControllerGet = (options) => {
|
|
1470
1541
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -1487,7 +1558,7 @@ const interactLibraryTagV2ApiControllerGet = (options) => {
|
|
|
1487
1558
|
exports.interactLibraryTagV2ApiControllerGet = interactLibraryTagV2ApiControllerGet;
|
|
1488
1559
|
/**
|
|
1489
1560
|
* Update InterAct command snippet tag
|
|
1490
|
-
*
|
|
1561
|
+
* Applies a partial update to one InterAct snippet tag identified by UUID or exact name; only the provided fields (name, organizations) change. System tags cannot be modified. Supports `dryRun` previews and returns the updated tag in `entities[0]`.
|
|
1491
1562
|
*/
|
|
1492
1563
|
const interactLibraryTagV2ApiControllerUpdate = (options) => {
|
|
1493
1564
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -1514,7 +1585,7 @@ const interactLibraryTagV2ApiControllerUpdate = (options) => {
|
|
|
1514
1585
|
exports.interactLibraryTagV2ApiControllerUpdate = interactLibraryTagV2ApiControllerUpdate;
|
|
1515
1586
|
/**
|
|
1516
1587
|
* List InterAct library files
|
|
1517
|
-
*
|
|
1588
|
+
* Lists InterAct library files (binaries and scripts responders can download during a shell session) visible to the caller, scoped by `organizations`. Supports offset pagination, `filter[field]` querying and sorting by name, size, uploadedAt, uploadedBy, lastUsedAt or lastUsedBy. Each entity carries the file's metadata (name, size, sha256, organizations, upload and last-use details); the file content itself is not included.
|
|
1518
1589
|
*/
|
|
1519
1590
|
const interactLibraryFileV2ApiControllerList = (options) => {
|
|
1520
1591
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -1537,7 +1608,7 @@ const interactLibraryFileV2ApiControllerList = (options) => {
|
|
|
1537
1608
|
exports.interactLibraryFileV2ApiControllerList = interactLibraryFileV2ApiControllerList;
|
|
1538
1609
|
/**
|
|
1539
1610
|
* Upload InterAct library file
|
|
1540
|
-
*
|
|
1611
|
+
* Uploads a file into the InterAct library via a multipart request (field `file`) so responders can download it during shell sessions. Uploads are limited to 4 GB per file and 20 GB total library size; name collisions are resolved by auto-suffixing and reported in `warnings[]`. Supports `dryRun` previews and returns the stored file's metadata in `entities[0]` plus a Location header pointing at the new resource.
|
|
1541
1612
|
*/
|
|
1542
1613
|
const interactLibraryFileV2ApiControllerUpload = (options) => {
|
|
1543
1614
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1565,7 +1636,7 @@ const interactLibraryFileV2ApiControllerUpload = (options) => {
|
|
|
1565
1636
|
exports.interactLibraryFileV2ApiControllerUpload = interactLibraryFileV2ApiControllerUpload;
|
|
1566
1637
|
/**
|
|
1567
1638
|
* Bulk delete InterAct library files
|
|
1568
|
-
*
|
|
1639
|
+
* Deletes several InterAct library files in one call, targeted by UUID or exact name. Unknown targets are skipped and reported in `warnings[]`; the delete itself is all-or-nothing over the resolved targets. Supports `dryRun` previews and returns the number of deleted files in `deletedCount`.
|
|
1569
1640
|
*/
|
|
1570
1641
|
const interactLibraryFileV2ApiControllerBulkDelete = (options) => {
|
|
1571
1642
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1592,7 +1663,7 @@ const interactLibraryFileV2ApiControllerBulkDelete = (options) => {
|
|
|
1592
1663
|
exports.interactLibraryFileV2ApiControllerBulkDelete = interactLibraryFileV2ApiControllerBulkDelete;
|
|
1593
1664
|
/**
|
|
1594
1665
|
* Delete InterAct library file
|
|
1595
|
-
*
|
|
1666
|
+
* Deletes one InterAct library file, targeted by UUID or exact name, removing the file record and its stored content. Supports `dryRun` previews and returns the deleted file's id and name in `entities[0]`. An unknown id or name returns 404.
|
|
1596
1667
|
*/
|
|
1597
1668
|
const interactLibraryFileV2ApiControllerDelete = (options) => {
|
|
1598
1669
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -1615,7 +1686,7 @@ const interactLibraryFileV2ApiControllerDelete = (options) => {
|
|
|
1615
1686
|
exports.interactLibraryFileV2ApiControllerDelete = interactLibraryFileV2ApiControllerDelete;
|
|
1616
1687
|
/**
|
|
1617
1688
|
* Download InterAct library file by id or name
|
|
1618
|
-
*
|
|
1689
|
+
* Downloads the content of one InterAct library file, resolved by UUID or exact name and streamed as an `application/octet-stream` attachment rather than a JSON envelope. An unknown id or name returns 404.
|
|
1619
1690
|
*/
|
|
1620
1691
|
const interactLibraryFileV2ApiControllerDownload = (options) => {
|
|
1621
1692
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -1638,7 +1709,7 @@ const interactLibraryFileV2ApiControllerDownload = (options) => {
|
|
|
1638
1709
|
exports.interactLibraryFileV2ApiControllerDownload = interactLibraryFileV2ApiControllerDownload;
|
|
1639
1710
|
/**
|
|
1640
1711
|
* List native InterAct shell commands
|
|
1641
|
-
*
|
|
1712
|
+
* Lists the native InterAct shell commands built into the AIR agent, including their aliases, descriptions, and usage lines. An optional searchTerm narrows the list with a case-insensitive substring match on command names and aliases.
|
|
1642
1713
|
*/
|
|
1643
1714
|
const interactCommandV2ApiControllerList = (options) => {
|
|
1644
1715
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -1661,7 +1732,7 @@ const interactCommandV2ApiControllerList = (options) => {
|
|
|
1661
1732
|
exports.interactCommandV2ApiControllerList = interactCommandV2ApiControllerList;
|
|
1662
1733
|
/**
|
|
1663
1734
|
* List investigation flags
|
|
1664
|
-
*
|
|
1735
|
+
* Lists the shared investigation flag library, scoped by `organizations`. Supports offset pagination, a case-insensitive `filter[name]` contains match and sorting by name, createdAt or updatedAt (default name ascending). Each entry carries the flag's id, name, color, description and owning organization.
|
|
1665
1736
|
*/
|
|
1666
1737
|
const flagsLibraryV2ApiControllerList = (options) => {
|
|
1667
1738
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -1684,7 +1755,7 @@ const flagsLibraryV2ApiControllerList = (options) => {
|
|
|
1684
1755
|
exports.flagsLibraryV2ApiControllerList = flagsLibraryV2ApiControllerList;
|
|
1685
1756
|
/**
|
|
1686
1757
|
* Create investigation flag
|
|
1687
|
-
*
|
|
1758
|
+
* Creates an investigation flag from a required name plus optional color, description and owning organization (color defaults to #4A4D55). A name collision within the organization is auto-suffixed and reported as a NAME_ADJUSTED warning. Returns the created flag in entities[0].
|
|
1688
1759
|
*/
|
|
1689
1760
|
const flagsLibraryV2ApiControllerCreate = (options) => {
|
|
1690
1761
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1711,7 +1782,7 @@ const flagsLibraryV2ApiControllerCreate = (options) => {
|
|
|
1711
1782
|
exports.flagsLibraryV2ApiControllerCreate = flagsLibraryV2ApiControllerCreate;
|
|
1712
1783
|
/**
|
|
1713
1784
|
* Delete investigation flag
|
|
1714
|
-
*
|
|
1785
|
+
* Deletes one investigation flag identified by numeric id or exact name. System-created flags cannot be deleted and return 406. Returns the id and name of the deleted flag in entities[0].
|
|
1715
1786
|
*/
|
|
1716
1787
|
const flagsLibraryV2ApiControllerDelete = (options) => {
|
|
1717
1788
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -1734,7 +1805,7 @@ const flagsLibraryV2ApiControllerDelete = (options) => {
|
|
|
1734
1805
|
exports.flagsLibraryV2ApiControllerDelete = flagsLibraryV2ApiControllerDelete;
|
|
1735
1806
|
/**
|
|
1736
1807
|
* Get investigation flag by id or name
|
|
1737
|
-
*
|
|
1808
|
+
* Fetches one investigation flag by numeric id or exact name and returns its detail in entities[0]. An unknown name returns 404 with near-miss suggestions in errors[0].details.suggestions; a name shared across organizations returns 400 AMBIGUOUS_NAME with candidates in errors[0].details.matches.
|
|
1738
1809
|
*/
|
|
1739
1810
|
const flagsLibraryV2ApiControllerGet = (options) => {
|
|
1740
1811
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -1757,7 +1828,7 @@ const flagsLibraryV2ApiControllerGet = (options) => {
|
|
|
1757
1828
|
exports.flagsLibraryV2ApiControllerGet = flagsLibraryV2ApiControllerGet;
|
|
1758
1829
|
/**
|
|
1759
1830
|
* Update investigation flag
|
|
1760
|
-
*
|
|
1831
|
+
* Applies a partial update (name, color and/or description) to one investigation flag identified by numeric id or exact name; omitted or null fields stay unchanged. A rename collision is auto-suffixed and reported as a NAME_ADJUSTED warning. Returns the updated flag in entities[0].
|
|
1761
1832
|
*/
|
|
1762
1833
|
const flagsLibraryV2ApiControllerUpdate = (options) => {
|
|
1763
1834
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -1784,7 +1855,7 @@ const flagsLibraryV2ApiControllerUpdate = (options) => {
|
|
|
1784
1855
|
exports.flagsLibraryV2ApiControllerUpdate = flagsLibraryV2ApiControllerUpdate;
|
|
1785
1856
|
/**
|
|
1786
1857
|
* Flag evidence rows in an investigation
|
|
1787
|
-
*
|
|
1858
|
+
* Marks evidence, finding or timeline rows of one investigation with a flag from the flags library, identified by numeric id or exact name; a flag name that does not exist yet is auto-created in the investigation's organization. Each row is addressed by its evidence table or section name, objectId and taskAssignmentId, and `source` selects the surface (EVIDENCE, FINDING or TIMELINE). Returns a receipt with the resolved flag and the number of rows flagged, plus warnings for skipped rows and flag auto-creation; `dryRun` previews the outcome without changing anything.
|
|
1788
1859
|
*/
|
|
1789
1860
|
const investigationEvidenceFlagV2ApiControllerFlagEvidence = (options) => {
|
|
1790
1861
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1811,7 +1882,7 @@ const investigationEvidenceFlagV2ApiControllerFlagEvidence = (options) => {
|
|
|
1811
1882
|
exports.investigationEvidenceFlagV2ApiControllerFlagEvidence = investigationEvidenceFlagV2ApiControllerFlagEvidence;
|
|
1812
1883
|
/**
|
|
1813
1884
|
* Remove a flag from evidence rows in an investigation
|
|
1814
|
-
*
|
|
1885
|
+
* Removes one flag from evidence, finding or timeline rows of one investigation. The body follows the same contract as the flag endpoint (flag by numeric id or exact existing name, rows addressed by evidence, objectId and taskAssignmentId on the chosen source surface); rows that do not carry the flag are ignored. Returns a receipt with the resolved flag and the number of rows processed, plus warnings for skipped rows; `dryRun` previews the outcome without changing anything.
|
|
1815
1886
|
*/
|
|
1816
1887
|
const investigationEvidenceFlagV2ApiControllerUnflagEvidence = (options) => {
|
|
1817
1888
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1865,7 +1936,7 @@ const investigationSqlV2ApiControllerGetSchema = (options) => {
|
|
|
1865
1936
|
exports.investigationSqlV2ApiControllerGetSchema = investigationSqlV2ApiControllerGetSchema;
|
|
1866
1937
|
/**
|
|
1867
1938
|
* Run a read-only SQL query on an investigation
|
|
1868
|
-
* Execute one read-only SELECT statement inside the investigation schema via POST /api/v2/investigations/{idOrName}/sql-query. Returns a paginated result (pageNumber/pageSize in the body; totalEntityCount, totalPageCount, nextPage/previousPage in the envelope). Trailing semicolons, end-of-query -- comments, and trailing LIMIT/OFFSET in sqlQuery are stripped so request paging owns the page slice. Write statements, multiple statements and cross-schema references are rejected. Fixed tables: air_investigation_activities, air_investigation_activity_user_reads, air_investigation_comments, air_investigation_evidence_metadata, air_investigation_evidence_relations, air_investigation_evidence_transformer_versions, air_investigation_external_section_import_error, air_investigation_external_section_import_status, air_investigation_finding_timeline, air_investigation_flags, air_investigation_full_text_search, air_investigation_metadata, air_investigation_notes, air_investigation_reports, air_investigation_report_history, air_investigation_task_assignments, air_investigation_task_execution_logs, air_investigation_timeline, air_investigation_timeline_event_range, air_investigation_timeline_hourly, air_investigation_user_findings, drone_findings. Views: air_all_findings_view, air_excluded_findings_view, air_findings_view, air_timeline_findings_view. Evidence tables are named <platform>_<section> (e.g. windows_triage_file, linux_triage_file, windows_event_records) and vary per investigation. POST the schema endpoint with an empty body to list the populated tables of this investigation with row counts; POST { "table": "<name>" } for column details.
|
|
1939
|
+
* Execute one read-only SELECT statement inside the investigation schema via POST /api/v2/investigations/{idOrName}/sql-query. Returns a paginated result (pageNumber/pageSize in the body; totalEntityCount, totalPageCount, nextPage/previousPage in the envelope). Trailing semicolons, end-of-query -- comments, and trailing LIMIT/OFFSET in sqlQuery are stripped so request paging owns the page slice. Write statements, multiple statements and cross-schema references are rejected. Every result-producing branch must be anchored to at least one relation in the selected investigation. Functions are admitted through PostgreSQL catalog capability checks; volatile, dangerous, user-schema and object-reference functions are rejected. Use the schema endpoint to discover the selected investigation tables and columns; PostgreSQL catalog, object-reference, and cross-schema introspection are rejected. Fixed tables: air_investigation_activities, air_investigation_activity_user_reads, air_investigation_comments, air_investigation_evidence_metadata, air_investigation_evidence_relations, air_investigation_evidence_transformer_versions, air_investigation_external_section_import_error, air_investigation_external_section_import_status, air_investigation_finding_timeline, air_investigation_flags, air_investigation_full_text_search, air_investigation_metadata, air_investigation_notes, air_investigation_reports, air_investigation_report_history, air_investigation_task_assignments, air_investigation_task_execution_logs, air_investigation_timeline, air_investigation_timeline_event_range, air_investigation_timeline_hourly, air_investigation_user_findings, drone_findings. Views: air_all_findings_view, air_excluded_findings_view, air_findings_view, air_timeline_findings_view. Evidence tables are named <platform>_<section> (e.g. windows_triage_file, linux_triage_file, windows_event_records) and vary per investigation. POST the schema endpoint with an empty body to list the populated tables of this investigation with row counts; POST { "table": "<name>" } for column details. Documented row-analysis functions (94): abs, age, array_agg, array_cat, array_length, array_position, array_remove, array_to_string, ascii, avg, bit_length, bool_and, bool_or, btrim, cardinality, ceil, ceiling, char_length, chr, concat, concat_ws, corr, count, date_part, date_trunc, dense_rank, div, first_value, floor, initcap, json_array_length, json_typeof, jsonb_array_elements, jsonb_array_elements_text, jsonb_array_length, jsonb_path_exists, jsonb_typeof, lag, last_value, lead, left, length, lower, lpad, ltrim, max, md5, min, mod, mode, now, nth_value, ntile, octet_length, percentile_cont, percentile_disc, plainto_tsquery, position, power, rank, regexp_matches, regexp_replace, regexp_split_to_array, repeat, replace, reverse, right, round, row_number, rpad, rtrim, split_part, sqrt, starts_with, stddev, stddev_pop, string_agg, string_to_array, strpos, substr, substring, sum, to_char, to_date, to_timestamp, to_tsquery, to_tsvector, translate, trim, trunc, unnest, upper, var_pop, variance. Allowed cast types: bigint, boolean, character, character varying, date, double precision, integer, interval, json, jsonb, numeric, real, smallint, text, time, time with time zone, time without time zone, timestamp with time zone, timestamp without time zone, uuid (plus the usual aliases such as int, varchar, timestamptz). Additional functions are admitted only when PostgreSQL catalog metadata proves they are safe, non-volatile built-ins; unknown, extension, user-schema and dangerous functions are rejected. Object-reference (regclass/oid), catalog, session, filesystem, network and *_to_xml* capabilities are rejected. Safe set-returning functions may expand rows in SELECT, FROM or LATERAL. GROUP BY accepts ROLLUP and GROUPING SETS; CUBE is not supported because the name doubles as an extension function. Execution-context expressions (current_user, current_schema, current_catalog) are rejected.
|
|
1869
1940
|
*/
|
|
1870
1941
|
const investigationSqlV2ApiControllerExecuteSqlQuery = (options) => {
|
|
1871
1942
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1892,7 +1963,7 @@ const investigationSqlV2ApiControllerExecuteSqlQuery = (options) => {
|
|
|
1892
1963
|
exports.investigationSqlV2ApiControllerExecuteSqlQuery = investigationSqlV2ApiControllerExecuteSqlQuery;
|
|
1893
1964
|
/**
|
|
1894
1965
|
* Reboot a single asset
|
|
1895
|
-
*
|
|
1966
|
+
* Sends a reboot signal to one asset, identified by UUID or exact name. Returns the created task assignment; dryRun=true returns a same-shape preview without dispatching anything.
|
|
1896
1967
|
*/
|
|
1897
1968
|
const assetActionV2ApiControllerReboot = (options) => {
|
|
1898
1969
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1919,7 +1990,7 @@ const assetActionV2ApiControllerReboot = (options) => {
|
|
|
1919
1990
|
exports.assetActionV2ApiControllerReboot = assetActionV2ApiControllerReboot;
|
|
1920
1991
|
/**
|
|
1921
1992
|
* Shut down a single asset
|
|
1922
|
-
*
|
|
1993
|
+
* Sends a shutdown signal to one asset, identified by UUID or exact name. Returns the created task assignment; dryRun=true returns a same-shape preview without dispatching anything.
|
|
1923
1994
|
*/
|
|
1924
1995
|
const assetActionV2ApiControllerShutdown = (options) => {
|
|
1925
1996
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1946,7 +2017,7 @@ const assetActionV2ApiControllerShutdown = (options) => {
|
|
|
1946
2017
|
exports.assetActionV2ApiControllerShutdown = assetActionV2ApiControllerShutdown;
|
|
1947
2018
|
/**
|
|
1948
2019
|
* Isolate a single asset
|
|
1949
|
-
* Network-
|
|
2020
|
+
* Network-isolates one asset, identified by UUID or exact name. Requires the Isolation feature; returns the created isolation task with the target `isolationStatus`, and dryRun=true returns a same-shape preview without dispatching anything.
|
|
1950
2021
|
*/
|
|
1951
2022
|
const assetActionV2ApiControllerIsolate = (options) => {
|
|
1952
2023
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -1973,7 +2044,7 @@ const assetActionV2ApiControllerIsolate = (options) => {
|
|
|
1973
2044
|
exports.assetActionV2ApiControllerIsolate = assetActionV2ApiControllerIsolate;
|
|
1974
2045
|
/**
|
|
1975
2046
|
* Unisolate a single asset
|
|
1976
|
-
*
|
|
2047
|
+
* Removes network isolation from one asset, identified by UUID or exact name. Requires the Isolation feature; returns the created unisolation task with the target `isolationStatus`, and dryRun=true returns a same-shape preview without dispatching anything.
|
|
1977
2048
|
*/
|
|
1978
2049
|
const assetActionV2ApiControllerUnisolate = (options) => {
|
|
1979
2050
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2000,7 +2071,7 @@ const assetActionV2ApiControllerUnisolate = (options) => {
|
|
|
2000
2071
|
exports.assetActionV2ApiControllerUnisolate = assetActionV2ApiControllerUnisolate;
|
|
2001
2072
|
/**
|
|
2002
2073
|
* Retrieve the agent logs of a single asset
|
|
2003
|
-
*
|
|
2074
|
+
* Assigns a log-retrieval task that collects the agent logs from one asset, identified by UUID or exact name. Returns the created task assignment; dryRun=true returns a same-shape preview without dispatching anything.
|
|
2004
2075
|
*/
|
|
2005
2076
|
const assetActionV2ApiControllerRetrieveLogs = (options) => {
|
|
2006
2077
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2027,7 +2098,7 @@ const assetActionV2ApiControllerRetrieveLogs = (options) => {
|
|
|
2027
2098
|
exports.assetActionV2ApiControllerRetrieveLogs = assetActionV2ApiControllerRetrieveLogs;
|
|
2028
2099
|
/**
|
|
2029
2100
|
* Update the agent version on a single asset
|
|
2030
|
-
*
|
|
2101
|
+
* Assigns a one-time task that updates the agent on one asset to the console's current supported version; no specific version can be targeted. Returns the created task assignment; dryRun=true returns a same-shape preview without dispatching anything.
|
|
2031
2102
|
*/
|
|
2032
2103
|
const assetActionV2ApiControllerVersionUpdate = (options) => {
|
|
2033
2104
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2054,7 +2125,7 @@ const assetActionV2ApiControllerVersionUpdate = (options) => {
|
|
|
2054
2125
|
exports.assetActionV2ApiControllerVersionUpdate = assetActionV2ApiControllerVersionUpdate;
|
|
2055
2126
|
/**
|
|
2056
2127
|
* Enable maintenance mode on a single asset
|
|
2057
|
-
*
|
|
2128
|
+
* Enables maintenance mode on one asset, identified by UUID or exact name. The change is applied synchronously without creating a task; an asset already in maintenance mode returns HTTP 200 with a NO_OP entry in errors[], and dryRun=true returns a same-shape preview.
|
|
2058
2129
|
*/
|
|
2059
2130
|
const assetActionV2ApiControllerEnableMaintenance = (options) => {
|
|
2060
2131
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2081,7 +2152,7 @@ const assetActionV2ApiControllerEnableMaintenance = (options) => {
|
|
|
2081
2152
|
exports.assetActionV2ApiControllerEnableMaintenance = assetActionV2ApiControllerEnableMaintenance;
|
|
2082
2153
|
/**
|
|
2083
2154
|
* Disable maintenance mode on a single asset
|
|
2084
|
-
*
|
|
2155
|
+
* Disables maintenance mode on one asset, identified by UUID or exact name. The change is applied synchronously without creating a task; an asset not in maintenance mode returns HTTP 200 with a NO_OP entry in errors[], and dryRun=true returns a same-shape preview.
|
|
2085
2156
|
*/
|
|
2086
2157
|
const assetActionV2ApiControllerDisableMaintenance = (options) => {
|
|
2087
2158
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2108,7 +2179,7 @@ const assetActionV2ApiControllerDisableMaintenance = (options) => {
|
|
|
2108
2179
|
exports.assetActionV2ApiControllerDisableMaintenance = assetActionV2ApiControllerDisableMaintenance;
|
|
2109
2180
|
/**
|
|
2110
2181
|
* Import a PPC file into an existing asset
|
|
2111
|
-
*
|
|
2182
|
+
* Imports an uploaded PPC evidence file (multipart field `ppcFile`, max 4 GB) into an existing asset identified by UUID or exact name, optionally attaching it to a case via `caseIdOrName`. Returns the asset identity together with the imported file name and import time.
|
|
2112
2183
|
*/
|
|
2113
2184
|
const assetActionV2ApiControllerImportPpcToExistingAsset = (options) => {
|
|
2114
2185
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2136,7 +2207,7 @@ const assetActionV2ApiControllerImportPpcToExistingAsset = (options) => {
|
|
|
2136
2207
|
exports.assetActionV2ApiControllerImportPpcToExistingAsset = assetActionV2ApiControllerImportPpcToExistingAsset;
|
|
2137
2208
|
/**
|
|
2138
2209
|
* Reboot multiple assets
|
|
2139
|
-
*
|
|
2210
|
+
* Sends a reboot signal to multiple assets, listed by id or name in `assets[]` and optionally scoped by `organizations`. Supports dryRun previews and the `failIfNumberOfAssetsGreaterThan` safety cap; returns per-asset task entries plus warnings for skipped assets.
|
|
2140
2211
|
*/
|
|
2141
2212
|
const assetBulkActionV2ApiControllerReboot = (options) => {
|
|
2142
2213
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2163,7 +2234,7 @@ const assetBulkActionV2ApiControllerReboot = (options) => {
|
|
|
2163
2234
|
exports.assetBulkActionV2ApiControllerReboot = assetBulkActionV2ApiControllerReboot;
|
|
2164
2235
|
/**
|
|
2165
2236
|
* Shut down multiple assets
|
|
2166
|
-
*
|
|
2237
|
+
* Sends a shutdown signal to multiple assets, listed by id or name in `assets[]` and optionally scoped by `organizations`. Supports dryRun previews and the `failIfNumberOfAssetsGreaterThan` safety cap; returns per-asset task entries plus warnings for skipped assets.
|
|
2167
2238
|
*/
|
|
2168
2239
|
const assetBulkActionV2ApiControllerShutdown = (options) => {
|
|
2169
2240
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2190,7 +2261,7 @@ const assetBulkActionV2ApiControllerShutdown = (options) => {
|
|
|
2190
2261
|
exports.assetBulkActionV2ApiControllerShutdown = assetBulkActionV2ApiControllerShutdown;
|
|
2191
2262
|
/**
|
|
2192
2263
|
* Isolate multiple assets
|
|
2193
|
-
* Network-
|
|
2264
|
+
* Network-isolates multiple assets, listed by id or name in `assets[]` and optionally scoped by `organizations`. Requires the Isolation feature; supports dryRun previews and the `failIfNumberOfAssetsGreaterThan` safety cap. Returns per-asset task entries plus warnings for skipped assets.
|
|
2194
2265
|
*/
|
|
2195
2266
|
const assetBulkActionV2ApiControllerIsolate = (options) => {
|
|
2196
2267
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2217,7 +2288,7 @@ const assetBulkActionV2ApiControllerIsolate = (options) => {
|
|
|
2217
2288
|
exports.assetBulkActionV2ApiControllerIsolate = assetBulkActionV2ApiControllerIsolate;
|
|
2218
2289
|
/**
|
|
2219
2290
|
* Unisolate multiple assets
|
|
2220
|
-
*
|
|
2291
|
+
* Removes network isolation from multiple assets, listed by id or name in `assets[]` and optionally scoped by `organizations`. Requires the Isolation feature; supports dryRun previews and the `failIfNumberOfAssetsGreaterThan` safety cap. Returns per-asset task entries plus warnings for skipped assets.
|
|
2221
2292
|
*/
|
|
2222
2293
|
const assetBulkActionV2ApiControllerUnisolate = (options) => {
|
|
2223
2294
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2244,7 +2315,7 @@ const assetBulkActionV2ApiControllerUnisolate = (options) => {
|
|
|
2244
2315
|
exports.assetBulkActionV2ApiControllerUnisolate = assetBulkActionV2ApiControllerUnisolate;
|
|
2245
2316
|
/**
|
|
2246
2317
|
* Retrieve the agent logs of multiple assets
|
|
2247
|
-
*
|
|
2318
|
+
* Assigns a log-retrieval task to multiple assets, listed by id or name in `assets[]` and optionally scoped by `organizations`. Supports dryRun previews and the `failIfNumberOfAssetsGreaterThan` safety cap; returns per-asset task entries plus warnings for skipped assets.
|
|
2248
2319
|
*/
|
|
2249
2320
|
const assetBulkActionV2ApiControllerRetrieveLogs = (options) => {
|
|
2250
2321
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2271,7 +2342,7 @@ const assetBulkActionV2ApiControllerRetrieveLogs = (options) => {
|
|
|
2271
2342
|
exports.assetBulkActionV2ApiControllerRetrieveLogs = assetBulkActionV2ApiControllerRetrieveLogs;
|
|
2272
2343
|
/**
|
|
2273
2344
|
* Update the agent version on multiple assets
|
|
2274
|
-
*
|
|
2345
|
+
* Assigns an immediate one-time agent version update task to multiple assets, listed by id or name in `assets[]` and optionally scoped by `organizations`. Agents update to the console's current supported version; there is no version targeting. Supports dryRun previews and the `failIfNumberOfAssetsGreaterThan` safety cap; returns per-asset task entries plus warnings for skipped assets.
|
|
2275
2346
|
*/
|
|
2276
2347
|
const assetBulkActionV2ApiControllerVersionUpdate = (options) => {
|
|
2277
2348
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2298,7 +2369,7 @@ const assetBulkActionV2ApiControllerVersionUpdate = (options) => {
|
|
|
2298
2369
|
exports.assetBulkActionV2ApiControllerVersionUpdate = assetBulkActionV2ApiControllerVersionUpdate;
|
|
2299
2370
|
/**
|
|
2300
2371
|
* Enable maintenance mode on multiple assets
|
|
2301
|
-
*
|
|
2372
|
+
* Enables maintenance mode on multiple assets, listed by id or name in `assets[]` and optionally scoped by `organizations`. The change is applied synchronously without creating tasks; supports dryRun previews and returns per-asset entries plus warnings for assets already in maintenance mode or otherwise skipped.
|
|
2302
2373
|
*/
|
|
2303
2374
|
const assetBulkActionV2ApiControllerEnableMaintenance = (options) => {
|
|
2304
2375
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2325,7 +2396,7 @@ const assetBulkActionV2ApiControllerEnableMaintenance = (options) => {
|
|
|
2325
2396
|
exports.assetBulkActionV2ApiControllerEnableMaintenance = assetBulkActionV2ApiControllerEnableMaintenance;
|
|
2326
2397
|
/**
|
|
2327
2398
|
* Disable maintenance mode on multiple assets
|
|
2328
|
-
*
|
|
2399
|
+
* Disables maintenance mode on multiple assets, listed by id or name in `assets[]` and optionally scoped by `organizations`. The change is applied synchronously without creating tasks; supports dryRun previews and returns per-asset entries plus warnings for assets not in maintenance mode or otherwise skipped.
|
|
2329
2400
|
*/
|
|
2330
2401
|
const assetBulkActionV2ApiControllerDisableMaintenance = (options) => {
|
|
2331
2402
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2352,7 +2423,7 @@ const assetBulkActionV2ApiControllerDisableMaintenance = (options) => {
|
|
|
2352
2423
|
exports.assetBulkActionV2ApiControllerDisableMaintenance = assetBulkActionV2ApiControllerDisableMaintenance;
|
|
2353
2424
|
/**
|
|
2354
2425
|
* Add tag(s) to multiple assets
|
|
2355
|
-
*
|
|
2426
|
+
* Appends the given `tags` to every asset listed in `assets[]` in a single call. Existing tags are kept; assets that already carry a tag are unchanged but still reported. Returns per-asset results in `entities[]` and skipped inputs in `warnings[]`.
|
|
2356
2427
|
*/
|
|
2357
2428
|
const assetBulkMetadataV2ApiControllerAddTags = (options) => {
|
|
2358
2429
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2379,7 +2450,7 @@ const assetBulkMetadataV2ApiControllerAddTags = (options) => {
|
|
|
2379
2450
|
exports.assetBulkMetadataV2ApiControllerAddTags = assetBulkMetadataV2ApiControllerAddTags;
|
|
2380
2451
|
/**
|
|
2381
2452
|
* Remove tag(s) from multiple assets
|
|
2382
|
-
*
|
|
2453
|
+
* Removes the given `tags` from every asset listed in `assets[]` in a single call. Only the listed tags are removed; other tags and the tag catalog itself are untouched. Supports a `dryRun` preview. Returns per-asset results in `entities[]` and skipped inputs in `warnings[]`.
|
|
2383
2454
|
*/
|
|
2384
2455
|
const assetBulkMetadataV2ApiControllerRemoveTags = (options) => {
|
|
2385
2456
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2406,7 +2477,7 @@ const assetBulkMetadataV2ApiControllerRemoveTags = (options) => {
|
|
|
2406
2477
|
exports.assetBulkMetadataV2ApiControllerRemoveTags = assetBulkMetadataV2ApiControllerRemoveTags;
|
|
2407
2478
|
/**
|
|
2408
2479
|
* Set the update-exclusion flag on multiple assets
|
|
2409
|
-
*
|
|
2480
|
+
* Sets or clears the "excluded from automatic agent updates" flag on every asset listed in `assets[]`. `excludedFromUpdates=true` excludes the assets from auto-updates; `false` re-includes them. Returns the changed assets in `entities[]`; assets with an unsupported OS are skipped and reported in `warnings[]`.
|
|
2410
2481
|
*/
|
|
2411
2482
|
const assetBulkMetadataV2ApiControllerSetUpdateExclusion = (options) => {
|
|
2412
2483
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -2433,7 +2504,7 @@ const assetBulkMetadataV2ApiControllerSetUpdateExclusion = (options) => {
|
|
|
2433
2504
|
exports.assetBulkMetadataV2ApiControllerSetUpdateExclusion = assetBulkMetadataV2ApiControllerSetUpdateExclusion;
|
|
2434
2505
|
/**
|
|
2435
2506
|
* Set or clear the relay connection route on multiple assets
|
|
2436
|
-
*
|
|
2507
|
+
* Sets or clears the relay-server connection route of every asset listed in `assets[]`. `relayServerId` is the numeric relay server to route through; `null` clears the route (direct connection). The relay server's organization must match the assets' organization. Returns per-asset results in `entities[]` and skipped inputs in `warnings[]`.
|
|
2437
2508
|
*/
|
|
2438
2509
|
const assetBulkMetadataV2ApiControllerSetConnectionRoute = (options) => {
|
|
2439
2510
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -2460,7 +2531,7 @@ const assetBulkMetadataV2ApiControllerSetConnectionRoute = (options) => {
|
|
|
2460
2531
|
exports.assetBulkMetadataV2ApiControllerSetConnectionRoute = assetBulkMetadataV2ApiControllerSetConnectionRoute;
|
|
2461
2532
|
/**
|
|
2462
2533
|
* Set the demanded MITRE ATT&CK Database version on multiple assets
|
|
2463
|
-
*
|
|
2534
|
+
* Sets the demanded MITRE ATT&CK database version on every asset listed in `assets[]`. Requires MITRE auto-update to be disabled and `version` to be one available in the system. Returns the updated assets in `entities[]`; ineligible assets are skipped and reported in `warnings[]`.
|
|
2464
2535
|
*/
|
|
2465
2536
|
const assetBulkMetadataV2ApiControllerSetMitreDatabaseVersion = (options) => {
|
|
2466
2537
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -2487,7 +2558,7 @@ const assetBulkMetadataV2ApiControllerSetMitreDatabaseVersion = (options) => {
|
|
|
2487
2558
|
exports.assetBulkMetadataV2ApiControllerSetMitreDatabaseVersion = assetBulkMetadataV2ApiControllerSetMitreDatabaseVersion;
|
|
2488
2559
|
/**
|
|
2489
2560
|
* Bulk delete assets (purge / uninstall / purge-and-uninstall)
|
|
2490
|
-
*
|
|
2561
|
+
* Deletes or decommissions every asset listed in `assets[]`. `mode` selects the action: `purge` (remove console records and evidence files), `uninstall` (uninstall the agent), or `purge-and-uninstall` (both). A `dryRun` preview returns the per-asset effects; the real delete returns `deletedCount` plus any `warnings[]`.
|
|
2491
2562
|
*/
|
|
2492
2563
|
const assetBulkMetadataV2ApiControllerDeleteAssets = (options) => {
|
|
2493
2564
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2514,7 +2585,7 @@ const assetBulkMetadataV2ApiControllerDeleteAssets = (options) => {
|
|
|
2514
2585
|
exports.assetBulkMetadataV2ApiControllerDeleteAssets = assetBulkMetadataV2ApiControllerDeleteAssets;
|
|
2515
2586
|
/**
|
|
2516
2587
|
* Import an off-network PPC (find-or-create asset + offline task)
|
|
2517
|
-
*
|
|
2588
|
+
* Imports an off-network Task.dat (multipart upload; field `ppcFile`) and creates an offline task. The asset itself is resolved later, when the evidence collection zip is imported into the task. `organizations` must resolve to exactly one organization; `caseIdOrName` optionally attaches the task to a case. Requires the Off-Network Responder feature. Returns the created task summary.
|
|
2518
2589
|
*/
|
|
2519
2590
|
const assetBulkMetadataV2ApiControllerImportOffNetworkPpc = (options) => {
|
|
2520
2591
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2542,7 +2613,7 @@ const assetBulkMetadataV2ApiControllerImportOffNetworkPpc = (options) => {
|
|
|
2542
2613
|
exports.assetBulkMetadataV2ApiControllerImportOffNetworkPpc = assetBulkMetadataV2ApiControllerImportOffNetworkPpc;
|
|
2543
2614
|
/**
|
|
2544
2615
|
* Run triage rule(s) on multiple assets
|
|
2545
|
-
*
|
|
2616
|
+
* Runs one or more triage (hunt) rules across multiple assets, creating a single task that covers every runnable asset. Assets and rules are referenced by id or exact name; inputs that cannot be resolved are reported per input in `result.errors[]` instead of failing the call. Returns the created task entity with its asset rollup, organizations and rules.
|
|
2546
2617
|
*/
|
|
2547
2618
|
const assetBulkTriageV2ApiControllerRunTriage = (options) => {
|
|
2548
2619
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2569,7 +2640,7 @@ const assetBulkTriageV2ApiControllerRunTriage = (options) => {
|
|
|
2569
2640
|
exports.assetBulkTriageV2ApiControllerRunTriage = assetBulkTriageV2ApiControllerRunTriage;
|
|
2570
2641
|
/**
|
|
2571
2642
|
* List InterAct messages for an asset
|
|
2572
|
-
*
|
|
2643
|
+
* Lists the InterAct shell messages recorded for one asset, identified by UUID or exact name, across all of its sessions. Supports offset pagination, sorting, and filtering by session and creation date range. Each entry carries the command, its status, and the output inline or via outputUrl.
|
|
2573
2644
|
*/
|
|
2574
2645
|
const assetInteractMessageV2ApiControllerListForAsset = (options) => {
|
|
2575
2646
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -2592,7 +2663,7 @@ const assetInteractMessageV2ApiControllerListForAsset = (options) => {
|
|
|
2592
2663
|
exports.assetInteractMessageV2ApiControllerListForAsset = assetInteractMessageV2ApiControllerListForAsset;
|
|
2593
2664
|
/**
|
|
2594
2665
|
* Run an InterAct command on an asset
|
|
2595
|
-
*
|
|
2666
|
+
* Runs an InterAct shell command on one asset, identified by UUID or exact name. In synchronous mode (default) the call waits for the result and returns the completed message with its output; when the command is still running after the sync timeout, or when async=true, it returns HTTP 202 with a running message handle to poll.
|
|
2596
2667
|
*/
|
|
2597
2668
|
const assetInteractV2ApiControllerRunCommand = (options) => {
|
|
2598
2669
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2619,7 +2690,7 @@ const assetInteractV2ApiControllerRunCommand = (options) => {
|
|
|
2619
2690
|
exports.assetInteractV2ApiControllerRunCommand = assetInteractV2ApiControllerRunCommand;
|
|
2620
2691
|
/**
|
|
2621
2692
|
* Cancel the running InterAct command on an asset
|
|
2622
|
-
*
|
|
2693
|
+
* Sends a best-effort interrupt to a running InterAct shell command on one asset; the session stays open. With no body it targets the running command of the caller's active session; pass messageId or sessionId to target a specific command or session. Returns the affected message entity.
|
|
2623
2694
|
*/
|
|
2624
2695
|
const assetInteractV2ApiControllerCancelCommand = (options) => {
|
|
2625
2696
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2646,7 +2717,7 @@ const assetInteractV2ApiControllerCancelCommand = (options) => {
|
|
|
2646
2717
|
exports.assetInteractV2ApiControllerCancelCommand = assetInteractV2ApiControllerCancelCommand;
|
|
2647
2718
|
/**
|
|
2648
2719
|
* Close the InterAct session on an asset
|
|
2649
|
-
*
|
|
2720
|
+
* Closes an InterAct shell session on one asset. With no body it closes the caller's active session; pass sessionId to target a specific session and force=true to cancel any running commands first. Returns the session id, the close timestamp, and the ids of cancelled messages.
|
|
2650
2721
|
*/
|
|
2651
2722
|
const assetInteractV2ApiControllerCloseSession = (options) => {
|
|
2652
2723
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2673,7 +2744,7 @@ const assetInteractV2ApiControllerCloseSession = (options) => {
|
|
|
2673
2744
|
exports.assetInteractV2ApiControllerCloseSession = assetInteractV2ApiControllerCloseSession;
|
|
2674
2745
|
/**
|
|
2675
2746
|
* Get asset issue/actionability stats
|
|
2676
|
-
*
|
|
2747
|
+
* Returns aggregate statistics over the assets visible to the caller, grouped into version, connectivity, deployment, assignment and isolation domains. Accepts the same `filter` and `organizations` query parameters as the asset list endpoint.
|
|
2677
2748
|
*/
|
|
2678
2749
|
const assetV2ApiControllerGetStats = (options) => {
|
|
2679
2750
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -2696,7 +2767,7 @@ const assetV2ApiControllerGetStats = (options) => {
|
|
|
2696
2767
|
exports.assetV2ApiControllerGetStats = assetV2ApiControllerGetStats;
|
|
2697
2768
|
/**
|
|
2698
2769
|
* Export assets as CSV
|
|
2699
|
-
*
|
|
2770
|
+
* Exports the assets matching the given filter as a CSV file stream. Supports the same `filter` and `organizations` parameters as the asset list endpoint, except that tag filtering (tagIds) is not applied on export; `columnsOrder` controls the leading column order of the CSV.
|
|
2700
2771
|
*/
|
|
2701
2772
|
const assetV2ApiControllerExportAssets = (options) => {
|
|
2702
2773
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -2719,7 +2790,7 @@ const assetV2ApiControllerExportAssets = (options) => {
|
|
|
2719
2790
|
exports.assetV2ApiControllerExportAssets = assetV2ApiControllerExportAssets;
|
|
2720
2791
|
/**
|
|
2721
2792
|
* List assets
|
|
2722
|
-
*
|
|
2793
|
+
* Lists assets visible to the caller, scoped by `organizations`. Supports offset pagination, whitelisted sorting and `filter[field]` querying. Start here to discover asset ids for the single-asset endpoints.
|
|
2723
2794
|
*/
|
|
2724
2795
|
const assetV2ApiControllerFilterAssets = (options) => {
|
|
2725
2796
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -2742,7 +2813,7 @@ const assetV2ApiControllerFilterAssets = (options) => {
|
|
|
2742
2813
|
exports.assetV2ApiControllerFilterAssets = assetV2ApiControllerFilterAssets;
|
|
2743
2814
|
/**
|
|
2744
2815
|
* Delete an asset by id or name
|
|
2745
|
-
*
|
|
2816
|
+
* Deletes an asset. `mode` picks the blast radius (purge, uninstall, or purge-and-uninstall). Send dryRun=true first: it returns the exact effects without dispatching anything.
|
|
2746
2817
|
*/
|
|
2747
2818
|
const assetV2ApiControllerDeleteAsset = (options) => {
|
|
2748
2819
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -2765,7 +2836,7 @@ const assetV2ApiControllerDeleteAsset = (options) => {
|
|
|
2765
2836
|
exports.assetV2ApiControllerDeleteAsset = assetV2ApiControllerDeleteAsset;
|
|
2766
2837
|
/**
|
|
2767
2838
|
* Get asset by id or name
|
|
2768
|
-
*
|
|
2839
|
+
* Fetches one asset by UUID or by exact name. Prefer the UUID: names can collide. A name matching several assets returns 400 AMBIGUOUS_NAME with candidates in errors[0].details.matches; a near-miss name returns 404 with errors[0].details.suggestions.
|
|
2769
2840
|
*/
|
|
2770
2841
|
const assetV2ApiControllerGetAsset = (options) => {
|
|
2771
2842
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -2788,7 +2859,7 @@ const assetV2ApiControllerGetAsset = (options) => {
|
|
|
2788
2859
|
exports.assetV2ApiControllerGetAsset = assetV2ApiControllerGetAsset;
|
|
2789
2860
|
/**
|
|
2790
2861
|
* Replace asset tags
|
|
2791
|
-
*
|
|
2862
|
+
* Replaces the complete tag set of a single asset, identified by UUID or exact name; this is a full replacement, not an append, and an empty array clears all tags. Supports `dryRun` to preview the change before applying it. Returns the updated asset.
|
|
2792
2863
|
*/
|
|
2793
2864
|
const assetV2ApiControllerReplaceTags = (options) => {
|
|
2794
2865
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -2815,7 +2886,7 @@ const assetV2ApiControllerReplaceTags = (options) => {
|
|
|
2815
2886
|
exports.assetV2ApiControllerReplaceTags = assetV2ApiControllerReplaceTags;
|
|
2816
2887
|
/**
|
|
2817
2888
|
* Update asset label
|
|
2818
|
-
*
|
|
2889
|
+
* Sets or clears the label of a single asset, identified by UUID or exact name. Pass a string in `label` to set the label or null to clear it. Supports `dryRun` to preview the change before applying it. Returns the updated asset.
|
|
2819
2890
|
*/
|
|
2820
2891
|
const assetV2ApiControllerUpdateLabel = (options) => {
|
|
2821
2892
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -2842,7 +2913,7 @@ const assetV2ApiControllerUpdateLabel = (options) => {
|
|
|
2842
2913
|
exports.assetV2ApiControllerUpdateLabel = assetV2ApiControllerUpdateLabel;
|
|
2843
2914
|
/**
|
|
2844
2915
|
* List the hunt task history of a single asset
|
|
2845
|
-
*
|
|
2916
|
+
* Lists the triage (hunt) task history of a single asset, identified by UUID or exact name. Supports offset pagination, whitelisted sorting and `filter[field]` querying over status and search term. Returns a paginated envelope of the triage tasks previously run on the asset.
|
|
2846
2917
|
*/
|
|
2847
2918
|
const assetTriageV2ApiControllerFilterTriageTasks = (options) => {
|
|
2848
2919
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -2865,7 +2936,7 @@ const assetTriageV2ApiControllerFilterTriageTasks = (options) => {
|
|
|
2865
2936
|
exports.assetTriageV2ApiControllerFilterTriageTasks = assetTriageV2ApiControllerFilterTriageTasks;
|
|
2866
2937
|
/**
|
|
2867
2938
|
* Run triage rule(s) on a single asset
|
|
2868
|
-
*
|
|
2939
|
+
* Runs one or more triage (hunt) rules on a single asset, identified by UUID or exact name. Rules are referenced by id or exact name, and an optional `schedule` defers or repeats the run, which otherwise starts immediately. Returns the created task entity with its rules and owning organizations.
|
|
2869
2940
|
*/
|
|
2870
2941
|
const assetTriageV2ApiControllerRunTriage = (options) => {
|
|
2871
2942
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2892,7 +2963,7 @@ const assetTriageV2ApiControllerRunTriage = (options) => {
|
|
|
2892
2963
|
exports.assetTriageV2ApiControllerRunTriage = assetTriageV2ApiControllerRunTriage;
|
|
2893
2964
|
/**
|
|
2894
2965
|
* Cancel triage tasks on a single asset
|
|
2895
|
-
*
|
|
2966
|
+
* Cancels triage (hunt) tasks on a single asset, identified by UUID or exact name. `tasks` selects the parent task ids to cancel, or the literal 'all' for every cancellable triage task of the asset; only this asset's assignments are cancelled. Returns per-task entries with cancelled and skipped assignment counts.
|
|
2896
2967
|
*/
|
|
2897
2968
|
const assetTriageV2ApiControllerCancelTriage = (options) => {
|
|
2898
2969
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2919,7 +2990,7 @@ const assetTriageV2ApiControllerCancelTriage = (options) => {
|
|
|
2919
2990
|
exports.assetTriageV2ApiControllerCancelTriage = assetTriageV2ApiControllerCancelTriage;
|
|
2920
2991
|
/**
|
|
2921
2992
|
* Delete one asset's triage task assignment
|
|
2922
|
-
*
|
|
2993
|
+
* Deletes a single asset's assignment of the given parent triage task, including the results collected for that asset; other assets' assignments of the same task are unaffected. Supports `dryRun` to preview the deletion before executing it. Returns the deleted (or previewed) assignment row.
|
|
2923
2994
|
*/
|
|
2924
2995
|
const assetTriageV2ApiControllerDeleteTriageAssignment = (options) => {
|
|
2925
2996
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -2942,7 +3013,7 @@ const assetTriageV2ApiControllerDeleteTriageAssignment = (options) => {
|
|
|
2942
3013
|
exports.assetTriageV2ApiControllerDeleteTriageAssignment = assetTriageV2ApiControllerDeleteTriageAssignment;
|
|
2943
3014
|
/**
|
|
2944
3015
|
* Start an evidence or image acquisition on a single asset
|
|
2945
|
-
*
|
|
3016
|
+
* Starts an evidence or disk-image acquisition on one asset. `type` selects the branch: 'evidence' (default) requires `profileIdOrName`; 'image' requires `imageType` and at least one volume. `caseIdOrName` attaches the task to a case. The call starts a real task immediately (or a scheduled one when `schedule` is set); the Idempotency-Key header makes retries safe. Returns the created task assignment.
|
|
2946
3017
|
*/
|
|
2947
3018
|
const assetAcquisitionV2ApiControllerAcquire = (options) => {
|
|
2948
3019
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2969,7 +3040,7 @@ const assetAcquisitionV2ApiControllerAcquire = (options) => {
|
|
|
2969
3040
|
exports.assetAcquisitionV2ApiControllerAcquire = assetAcquisitionV2ApiControllerAcquire;
|
|
2970
3041
|
/**
|
|
2971
3042
|
* Cancel acquisition tasks on a single asset
|
|
2972
|
-
*
|
|
3043
|
+
* Cancels evidence/image acquisition tasks on a single asset, identified by UUID or exact name. `tasks` selects the parent task ids to cancel, or the literal 'all' for every cancellable acquisition task of the asset; only this asset's assignments are cancelled. Returns an asset-level summary of the cancelled tasks.
|
|
2973
3044
|
*/
|
|
2974
3045
|
const assetAcquisitionV2ApiControllerCancelAcquisition = (options) => {
|
|
2975
3046
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -2996,7 +3067,7 @@ const assetAcquisitionV2ApiControllerCancelAcquisition = (options) => {
|
|
|
2996
3067
|
exports.assetAcquisitionV2ApiControllerCancelAcquisition = assetAcquisitionV2ApiControllerCancelAcquisition;
|
|
2997
3068
|
/**
|
|
2998
3069
|
* Delete one asset's acquisition task assignment
|
|
2999
|
-
*
|
|
3070
|
+
* Deletes a single asset's assignment of the given parent acquisition task, including the evidence collected for that asset; other assets' assignments of the same task are unaffected. Supports `dryRun` to preview the deletion before executing it. Returns the deleted (or previewed) assignment row.
|
|
3000
3071
|
*/
|
|
3001
3072
|
const assetAcquisitionV2ApiControllerDeleteAcquisitionAssignment = (options) => {
|
|
3002
3073
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -3019,7 +3090,7 @@ const assetAcquisitionV2ApiControllerDeleteAcquisitionAssignment = (options) =>
|
|
|
3019
3090
|
exports.assetAcquisitionV2ApiControllerDeleteAcquisitionAssignment = assetAcquisitionV2ApiControllerDeleteAcquisitionAssignment;
|
|
3020
3091
|
/**
|
|
3021
3092
|
* List the acquisition task history of a single asset
|
|
3022
|
-
*
|
|
3093
|
+
* Lists the acquisition (evidence/image) task history of a single asset, identified by UUID or exact name. Supports offset pagination, whitelisted sorting and `filter[field]` querying over status, type and search term. Returns a paginated envelope of the acquisition tasks previously started on the asset.
|
|
3023
3094
|
*/
|
|
3024
3095
|
const assetAcquisitionV2ApiControllerFilterAcquisitionTasks = (options) => {
|
|
3025
3096
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -3042,7 +3113,7 @@ const assetAcquisitionV2ApiControllerFilterAcquisitionTasks = (options) => {
|
|
|
3042
3113
|
exports.assetAcquisitionV2ApiControllerFilterAcquisitionTasks = assetAcquisitionV2ApiControllerFilterAcquisitionTasks;
|
|
3043
3114
|
/**
|
|
3044
3115
|
* List InterAct sessions for an asset
|
|
3045
|
-
*
|
|
3116
|
+
* Lists the InterAct shell sessions recorded for one asset, identified by UUID or exact name. Supports offset pagination, sorting, and filtering by session, creator, and creation date range. Each entry includes the derived activity state, message count, and related task and case references.
|
|
3046
3117
|
*/
|
|
3047
3118
|
const assetInteractMessageV2ApiControllerListSessionsForAsset = (options) => {
|
|
3048
3119
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -3065,7 +3136,7 @@ const assetInteractMessageV2ApiControllerListSessionsForAsset = (options) => {
|
|
|
3065
3136
|
exports.assetInteractMessageV2ApiControllerListSessionsForAsset = assetInteractMessageV2ApiControllerListSessionsForAsset;
|
|
3066
3137
|
/**
|
|
3067
3138
|
* Get an InterAct message scoped to an asset
|
|
3068
|
-
*
|
|
3139
|
+
* Fetches one InterAct shell message of an asset by message UUID. Returns the unified message entity with the command, status, exit code, timestamps, and the output inline or via outputUrl. The message must belong to the asset, otherwise the API returns 404.
|
|
3069
3140
|
*/
|
|
3070
3141
|
const assetInteractMessageV2ApiControllerGetMessage = (options) => {
|
|
3071
3142
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -3088,7 +3159,7 @@ const assetInteractMessageV2ApiControllerGetMessage = (options) => {
|
|
|
3088
3159
|
exports.assetInteractMessageV2ApiControllerGetMessage = assetInteractMessageV2ApiControllerGetMessage;
|
|
3089
3160
|
/**
|
|
3090
3161
|
* Download an InterAct message output
|
|
3091
|
-
*
|
|
3162
|
+
* Streams the stored output of one completed InterAct shell message as a binary attachment, bypassing the JSON envelope. Intended for output too large to inline (outputUrl is set on the message). A still-running message returns 400.
|
|
3092
3163
|
*/
|
|
3093
3164
|
const assetInteractMessageV2ApiControllerDownloadMessageOutput = (options) => {
|
|
3094
3165
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -3111,7 +3182,7 @@ const assetInteractMessageV2ApiControllerDownloadMessageOutput = (options) => {
|
|
|
3111
3182
|
exports.assetInteractMessageV2ApiControllerDownloadMessageOutput = assetInteractMessageV2ApiControllerDownloadMessageOutput;
|
|
3112
3183
|
/**
|
|
3113
3184
|
* Get an InterAct session report scoped to an asset
|
|
3114
|
-
*
|
|
3185
|
+
* Builds a self-contained report for one InterAct shell session of an asset. The default JSON format returns the session, the asset identity, and all messages; format=html returns the rendered HTML report instead. The session must belong to the asset, otherwise the API returns 404.
|
|
3115
3186
|
*/
|
|
3116
3187
|
const assetInteractMessageV2ApiControllerGetSessionReport = (options) => {
|
|
3117
3188
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -3134,7 +3205,7 @@ const assetInteractMessageV2ApiControllerGetSessionReport = (options) => {
|
|
|
3134
3205
|
exports.assetInteractMessageV2ApiControllerGetSessionReport = assetInteractMessageV2ApiControllerGetSessionReport;
|
|
3135
3206
|
/**
|
|
3136
3207
|
* List cloud acquisition profiles
|
|
3137
|
-
*
|
|
3208
|
+
* Lists cloud (M365) acquisition profiles as paginated summary rows scoped by `organizations`, with `filter[field]` querying and sorting by name, createdBy, createdAt, lastUsedAt or lastUsedBy. Each row carries id, name, organizations, usage metadata and a detailsUrl; the M365 evidence selections are returned by the single-profile endpoint.
|
|
3138
3209
|
*/
|
|
3139
3210
|
const cloudAcquisitionLibraryApiControllerList = (options) => {
|
|
3140
3211
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -3157,7 +3228,7 @@ const cloudAcquisitionLibraryApiControllerList = (options) => {
|
|
|
3157
3228
|
exports.cloudAcquisitionLibraryApiControllerList = cloudAcquisitionLibraryApiControllerList;
|
|
3158
3229
|
/**
|
|
3159
3230
|
* Create cloud acquisition profile
|
|
3160
|
-
*
|
|
3231
|
+
* Creates a cloud (M365) acquisition profile from a required `name` plus the m365UserBased and m365TenantWide evidence blocks, with at least one evidence selected across the two. Body `organizationIds` controls which organizations own the profile. With dryRun=true (the default) the request is only validated and the would-be profile is returned without persisting; a real create returns the profile detail in entities[0].
|
|
3161
3232
|
*/
|
|
3162
3233
|
const cloudAcquisitionLibraryApiControllerCreate = (options) => {
|
|
3163
3234
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -3184,7 +3255,7 @@ const cloudAcquisitionLibraryApiControllerCreate = (options) => {
|
|
|
3184
3255
|
exports.cloudAcquisitionLibraryApiControllerCreate = cloudAcquisitionLibraryApiControllerCreate;
|
|
3185
3256
|
/**
|
|
3186
3257
|
* Bulk delete cloud acquisition profiles
|
|
3187
|
-
*
|
|
3258
|
+
* Deletes several cloud (M365) acquisition profiles in one request, resolving each item by UUID or exact name. Unknown, ambiguous or system profiles are skipped and reported in warnings[] instead of failing the batch. With dryRun=true (the default) the response previews what would be deleted; a real delete returns deletedCount plus warnings[].
|
|
3188
3259
|
*/
|
|
3189
3260
|
const cloudAcquisitionLibraryApiControllerBulkDelete = (options) => {
|
|
3190
3261
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -3211,7 +3282,7 @@ const cloudAcquisitionLibraryApiControllerBulkDelete = (options) => {
|
|
|
3211
3282
|
exports.cloudAcquisitionLibraryApiControllerBulkDelete = cloudAcquisitionLibraryApiControllerBulkDelete;
|
|
3212
3283
|
/**
|
|
3213
3284
|
* Delete cloud acquisition profile
|
|
3214
|
-
*
|
|
3285
|
+
* Deletes one cloud (M365) acquisition profile by UUID or exact name. System profiles cannot be deleted (406 SYSTEM_PROFILE_IMMUTABLE). With dryRun=true (the default) the response shows what would be deleted without removing anything.
|
|
3215
3286
|
*/
|
|
3216
3287
|
const cloudAcquisitionLibraryApiControllerDelete = (options) => {
|
|
3217
3288
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -3234,7 +3305,7 @@ const cloudAcquisitionLibraryApiControllerDelete = (options) => {
|
|
|
3234
3305
|
exports.cloudAcquisitionLibraryApiControllerDelete = cloudAcquisitionLibraryApiControllerDelete;
|
|
3235
3306
|
/**
|
|
3236
3307
|
* Get cloud acquisition profile by id or name
|
|
3237
|
-
*
|
|
3308
|
+
* Fetches one cloud (M365) acquisition profile by UUID or exact name, returning the full detail in entities[0]: the m365UserBased and m365TenantWide evidence lists, organizations and timestamps. A name matching several profiles returns 400 AMBIGUOUS_NAME with candidates; an unknown identifier returns 404 with suggestions.
|
|
3238
3309
|
*/
|
|
3239
3310
|
const cloudAcquisitionLibraryApiControllerGet = (options) => {
|
|
3240
3311
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -3257,7 +3328,7 @@ const cloudAcquisitionLibraryApiControllerGet = (options) => {
|
|
|
3257
3328
|
exports.cloudAcquisitionLibraryApiControllerGet = cloudAcquisitionLibraryApiControllerGet;
|
|
3258
3329
|
/**
|
|
3259
3330
|
* Update cloud acquisition profile
|
|
3260
|
-
*
|
|
3331
|
+
* Partially updates one cloud (M365) acquisition profile: only the provided fields (name, organizationIds, m365UserBased, m365TenantWide) change, and a passed evidence block replaces that whole block. The merged profile must keep at least one M365 evidence selected, and system profiles cannot be updated. With dryRun=true (the default) the merged profile is previewed without persisting.
|
|
3261
3332
|
*/
|
|
3262
3333
|
const cloudAcquisitionLibraryApiControllerUpdate = (options) => {
|
|
3263
3334
|
return (options.client ?? client_gen_1.client).patch({
|
|
@@ -3284,7 +3355,7 @@ const cloudAcquisitionLibraryApiControllerUpdate = (options) => {
|
|
|
3284
3355
|
exports.cloudAcquisitionLibraryApiControllerUpdate = cloudAcquisitionLibraryApiControllerUpdate;
|
|
3285
3356
|
/**
|
|
3286
3357
|
* List disk image acquisition profiles
|
|
3287
|
-
*
|
|
3358
|
+
* Lists disk image acquisition profiles as paginated summary rows scoped by `organizations`, with `filter[field]` querying and sorting by name, createdAt, updatedAt, lastUsedAt, createdBy or lastUsedBy. Each row carries id, name, organizations, usage metadata and a detailsUrl; the allFiles/paths/evidence configuration is returned by the single-profile endpoint.
|
|
3288
3359
|
*/
|
|
3289
3360
|
const diskImageAcquisitionLibraryApiControllerList = (options) => {
|
|
3290
3361
|
return (options?.client ?? client_gen_1.client).get({
|
|
@@ -3307,7 +3378,7 @@ const diskImageAcquisitionLibraryApiControllerList = (options) => {
|
|
|
3307
3378
|
exports.diskImageAcquisitionLibraryApiControllerList = diskImageAcquisitionLibraryApiControllerList;
|
|
3308
3379
|
/**
|
|
3309
3380
|
* Create disk image acquisition profile
|
|
3310
|
-
*
|
|
3381
|
+
* Creates a disk image acquisition profile from a required `name` plus an imaging scope: either allFiles=true for a full-disk image or a `paths` list of directories and files, optionally with extra `imageAcquisitionEvidences` collected alongside the image. Body `organizationIds` controls which organizations own the profile. With dryRun=true (the default) the request is only validated and the would-be profile is returned without persisting; a real create returns the profile detail in entities[0].
|
|
3311
3382
|
*/
|
|
3312
3383
|
const diskImageAcquisitionLibraryApiControllerCreate = (options) => {
|
|
3313
3384
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -3334,7 +3405,7 @@ const diskImageAcquisitionLibraryApiControllerCreate = (options) => {
|
|
|
3334
3405
|
exports.diskImageAcquisitionLibraryApiControllerCreate = diskImageAcquisitionLibraryApiControllerCreate;
|
|
3335
3406
|
/**
|
|
3336
3407
|
* Bulk delete disk image acquisition profiles
|
|
3337
|
-
*
|
|
3408
|
+
* Deletes several disk image acquisition profiles in one request, resolving each item by UUID or exact name. Unknown, ambiguous or system profiles are skipped and reported in warnings[] instead of failing the batch. With dryRun=true (the default) the response previews what would be deleted; a real delete returns deletedCount plus warnings[].
|
|
3338
3409
|
*/
|
|
3339
3410
|
const diskImageAcquisitionLibraryApiControllerBulkDelete = (options) => {
|
|
3340
3411
|
return (options.client ?? client_gen_1.client).post({
|
|
@@ -3361,7 +3432,7 @@ const diskImageAcquisitionLibraryApiControllerBulkDelete = (options) => {
|
|
|
3361
3432
|
exports.diskImageAcquisitionLibraryApiControllerBulkDelete = diskImageAcquisitionLibraryApiControllerBulkDelete;
|
|
3362
3433
|
/**
|
|
3363
3434
|
* Delete disk image acquisition profile
|
|
3364
|
-
*
|
|
3435
|
+
* Deletes one disk image acquisition profile by UUID or exact name. System profiles cannot be deleted (406 SYSTEM_PROFILE_IMMUTABLE). With dryRun=true (the default) the response shows what would be deleted without removing anything.
|
|
3365
3436
|
*/
|
|
3366
3437
|
const diskImageAcquisitionLibraryApiControllerDelete = (options) => {
|
|
3367
3438
|
return (options.client ?? client_gen_1.client).delete({
|
|
@@ -3384,7 +3455,7 @@ const diskImageAcquisitionLibraryApiControllerDelete = (options) => {
|
|
|
3384
3455
|
exports.diskImageAcquisitionLibraryApiControllerDelete = diskImageAcquisitionLibraryApiControllerDelete;
|
|
3385
3456
|
/**
|
|
3386
3457
|
* Get disk image acquisition profile by id or name
|
|
3387
|
-
*
|
|
3458
|
+
* Fetches one disk image acquisition profile by UUID or exact name, returning the full detail in entities[0]: the allFiles/paths imaging scope, extra evidence selection, organizations and timestamps. A name matching several profiles returns 400 AMBIGUOUS_NAME with candidates; an unknown identifier returns 404 with suggestions.
|
|
3388
3459
|
*/
|
|
3389
3460
|
const diskImageAcquisitionLibraryApiControllerGet = (options) => {
|
|
3390
3461
|
return (options.client ?? client_gen_1.client).get({
|
|
@@ -3407,7 +3478,7 @@ const diskImageAcquisitionLibraryApiControllerGet = (options) => {
|
|
|
3407
3478
|
exports.diskImageAcquisitionLibraryApiControllerGet = diskImageAcquisitionLibraryApiControllerGet;
|
|
3408
3479
|
/**
|
|
3409
3480
|
* Update disk image acquisition profile
|
|
3410
|
-
*
|
|
3481
|
+
* Partially updates one disk image acquisition profile: only the provided fields (name, organizationIds, allFiles, paths, imageAcquisitionEvidences) change. The merged profile must keep a consistent scope (allFiles=true cannot coexist with a non-empty paths list), and system profiles cannot be updated. With dryRun=true (the default) the merged profile is previewed without persisting.
|
|
3411
3482
|
*/
|
|
3412
3483
|
const diskImageAcquisitionLibraryApiControllerUpdate = (options) => {
|
|
3413
3484
|
return (options.client ?? client_gen_1.client).patch({
|