Skip to main content

Other content tools

The MCP tools that create, update, and delete the remaining content kinds: dashboards, webhooks, skills, HTTP tools, and MCP servers.

Each kind carries a create, update, and delete tool named for the kind. A write with a contentPackId argument can target a content pack instead of a Space. preview-webhook-config renders a webhook configuration against a sample event without sending a request.

Tool names and schemas can change at any time

An agent sees each change the next time it reads tools/list, while a script that hard-codes a tool name or schema breaks when that tool changes.

Each section below is one tool as MCP access registers it: its title, its description, the annotations it sets, and the input and output schemas from tools/list. Field paths use parent.child for a nested object, parent[].child for the items of an array, and parent[Value].child for one variant of a field that takes several shapes.

create-dashboard​

Create a dashboard.

Creates a new dashboard, staging the change in a draft changeset.

Creates the resource in the active chat's space or, when contentPackId is set, in that content pack.

This creates the dashboard SHELL — name, time range, refresh interval. It has no panels field. Add panels afterwards with update-dashboard-panels, a few at a time: each panel is validated on its own, so a query that doesn't compile is reported against the panel that caused it. Add template variables with update-dashboard-variables.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringRequired
refreshIntervalintegerOptionalDefaults to 0.
defaultTimeRangestringOptionalDefaults to -1h.
folderPathstringOptional
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
idstringThe ID of the created dashboard.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

update-dashboard​

Update a dashboard.

Updates an existing dashboard's own fields — name, default time range, refresh interval, folder — staging the change in a draft changeset when change batching is enabled.

Every field is optional: OMIT a field to leave it unchanged. name must be non-empty. To rename a dashboard, send only { "dashboardId": "...", "name": "New name" }.

This tool touches neither panels nor template variables — it has no panels or templateVariables field. Use update-dashboard-panels for panels and update-dashboard-variables for template variables; both address items individually, so you never resend a whole array.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringOptionalMust not be empty. At most 256 characters.
refreshIntervalintegerOptional
defaultTimeRangestringOptional
folderPathstringOptional
baseVersionintegerOptional
dashboardIdstringRequiredThe ID of the dashboard to update. Pattern: ^DSH_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
dashboardobject (two variants)
dashboard[variant 1].namestring
dashboard[variant 1].refreshIntervalinteger
dashboard[variant 1].panelsarray of object (four variants)
dashboard[variant 1].panels[][vega-lite].idstring
dashboard[variant 1].panels[][vega-lite].titleobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 1].panels[][vega-lite].layoutobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 1].panels[][vega-lite].typestringAlways vega-lite.
dashboard[variant 1].panels[][vega-lite].querystring
dashboard[variant 1].panels[][vega-lite].queriesarray of objectNested fields omitted; see the schema in tools/list.
dashboard[variant 1].panels[][vega-lite].specobject
dashboard[variant 1].panels[][vega-lite].timeRangestringDefaults to .
dashboard[variant 1].panels[][markdown].idstring
dashboard[variant 1].panels[][markdown].titleobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 1].panels[][markdown].layoutobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 1].panels[][markdown].typestringAlways markdown.
dashboard[variant 1].panels[][markdown].contentstringDefaults to .
dashboard[variant 1].panels[][title].idstring
dashboard[variant 1].panels[][title].layoutobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 1].panels[][title].typestringAlways title.
dashboard[variant 1].panels[][title].titleobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 1].panels[][title].collapsedbooleanDefaults to false.
dashboard[variant 1].panels[][table].idstring
dashboard[variant 1].panels[][table].titleobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 1].panels[][table].layoutobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 1].panels[][table].typestringAlways table.
dashboard[variant 1].panels[][table].querystring
dashboard[variant 1].panels[][table].timeRangestringDefaults to .
dashboard[variant 1].defaultTimeRangestring
dashboard[variant 1].templateVariablesarray of object (two variants)
dashboard[variant 1].templateVariables[][primitive].idstringMust not be empty.
dashboard[variant 1].templateVariables[][primitive].namestringPattern: ^[a-zA-Z_][a-zA-Z_0-9]*$. Must not be empty. At most 64 characters.
dashboard[variant 1].templateVariables[][primitive].kindstringAlways primitive.
dashboard[variant 1].templateVariables[][primitive].typeenumOne of int, double, boolean, string, interval.
dashboard[variant 1].templateVariables[][primitive].valuesarray of string
dashboard[variant 1].templateVariables[][primitive].defaultValuestringAt most 1024 characters.
dashboard[variant 1].templateVariables[][primitive].descriptionstringAt most 1024 characters.
dashboard[variant 1].templateVariables[][identifier_fragment].idstringMust not be empty.
dashboard[variant 1].templateVariables[][identifier_fragment].namestringPattern: ^[a-zA-Z_][a-zA-Z_0-9]*$. Must not be empty. At most 64 characters.
dashboard[variant 1].templateVariables[][identifier_fragment].kindstringAlways identifier_fragment.
dashboard[variant 1].templateVariables[][identifier_fragment].valuesarray of string
dashboard[variant 1].templateVariables[][identifier_fragment].defaultValuestringPattern: ^[a-zA-Z0-9_]+$. At most 1024 characters.
dashboard[variant 1].templateVariables[][identifier_fragment].descriptionstringAt most 1024 characters.
dashboard[variant 1].idstringPattern: ^DSH_[A-Z0-9]{1,7}$.
dashboard[variant 1].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
dashboard[variant 1].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
dashboard[variant 1].createdByUserIdstringMay be null.
dashboard[variant 1].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
dashboard[variant 1].updatedByUserIdstringMay be null.
dashboard[variant 1].folderIdstringMay be null. Pattern: ^FLD_[A-Z0-9]{1,7}$.
dashboard[variant 1].folderPathstring
dashboard[variant 1].spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
dashboard[variant 1].fromDatasetsarray of object
dashboard[variant 1].fromDatasets[].namestring
dashboard[variant 1].fromDatasets[].resourceNamestring
dashboard[variant 1].fromDatasets[].resourceIdstring
dashboard[variant 1].fromDatasets[].spaceIdstringSpace containing the dependency dataset. Pattern: ^SPC_[A-Z0-9]{1,7}$.
dashboard[variant 1].readOnlyboolean
dashboard[variant 1].installedFromobject (two variants)May be null.
dashboard[variant 1].installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
dashboard[variant 1].installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
dashboard[variant 1].installedFrom[variant 1].templateIdstring
dashboard[variant 1].installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
dashboard[variant 1].installedFrom[variant 2].linkModeenumOne of Copy.
dashboard[variant 1].installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
dashboard[variant 1].versionintegerMay be null. Greater than 0.
dashboard[variant 1].deletedbooleanDefaults to false.
dashboard[variant 1].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
dashboard[variant 1].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
dashboard[variant 1].originKeystringMay be null.
dashboard[variant 2].namestring
dashboard[variant 2].refreshIntervalinteger
dashboard[variant 2].panelsarray of object (four variants)
dashboard[variant 2].panels[][vega-lite].idstring
dashboard[variant 2].panels[][vega-lite].titleobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 2].panels[][vega-lite].layoutobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 2].panels[][vega-lite].typestringAlways vega-lite.
dashboard[variant 2].panels[][vega-lite].querystring
dashboard[variant 2].panels[][vega-lite].queriesarray of objectNested fields omitted; see the schema in tools/list.
dashboard[variant 2].panels[][vega-lite].specobject
dashboard[variant 2].panels[][vega-lite].timeRangestringDefaults to .
dashboard[variant 2].panels[][markdown].idstring
dashboard[variant 2].panels[][markdown].titleobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 2].panels[][markdown].layoutobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 2].panels[][markdown].typestringAlways markdown.
dashboard[variant 2].panels[][markdown].contentstringDefaults to .
dashboard[variant 2].panels[][title].idstring
dashboard[variant 2].panels[][title].layoutobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 2].panels[][title].typestringAlways title.
dashboard[variant 2].panels[][title].titleobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 2].panels[][title].collapsedbooleanDefaults to false.
dashboard[variant 2].panels[][table].idstring
dashboard[variant 2].panels[][table].titleobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 2].panels[][table].layoutobjectNested fields omitted; see the schema in tools/list.
dashboard[variant 2].panels[][table].typestringAlways table.
dashboard[variant 2].panels[][table].querystring
dashboard[variant 2].panels[][table].timeRangestringDefaults to .
dashboard[variant 2].defaultTimeRangestring
dashboard[variant 2].templateVariablesarray of object (two variants)
dashboard[variant 2].templateVariables[][primitive].idstringMust not be empty.
dashboard[variant 2].templateVariables[][primitive].namestringPattern: ^[a-zA-Z_][a-zA-Z_0-9]*$. Must not be empty. At most 64 characters.
dashboard[variant 2].templateVariables[][primitive].kindstringAlways primitive.
dashboard[variant 2].templateVariables[][primitive].typeenumOne of int, double, boolean, string, interval.
dashboard[variant 2].templateVariables[][primitive].valuesarray of string
dashboard[variant 2].templateVariables[][primitive].defaultValuestringAt most 1024 characters.
dashboard[variant 2].templateVariables[][primitive].descriptionstringAt most 1024 characters.
dashboard[variant 2].templateVariables[][identifier_fragment].idstringMust not be empty.
dashboard[variant 2].templateVariables[][identifier_fragment].namestringPattern: ^[a-zA-Z_][a-zA-Z_0-9]*$. Must not be empty. At most 64 characters.
dashboard[variant 2].templateVariables[][identifier_fragment].kindstringAlways identifier_fragment.
dashboard[variant 2].templateVariables[][identifier_fragment].valuesarray of string
dashboard[variant 2].templateVariables[][identifier_fragment].defaultValuestringPattern: ^[a-zA-Z0-9_]+$. At most 1024 characters.
dashboard[variant 2].templateVariables[][identifier_fragment].descriptionstringAt most 1024 characters.
dashboard[variant 2].idstringPattern: ^DSH_[A-Z0-9]{1,7}$.
dashboard[variant 2].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
dashboard[variant 2].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
dashboard[variant 2].createdByUserIdstringMay be null.
dashboard[variant 2].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
dashboard[variant 2].updatedByUserIdstringMay be null.
dashboard[variant 2].folderIdstringMay be null. Pattern: ^FLD_[A-Z0-9]{1,7}$.
dashboard[variant 2].folderPathstring
dashboard[variant 2].readOnlyboolean
dashboard[variant 2].versionintegerMay be null. Greater than 0.
dashboard[variant 2].deletedbooleanDefaults to false.
dashboard[variant 2].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
dashboard[variant 2].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
dashboard[variant 2].originKeystringMay be null.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

update-dashboard-panels​

Change dashboard panels.

Adds, patches, and removes panels on a dashboard, staging the change in a draft changeset. This is the ONLY way to write a dashboard's panels — create-dashboard and update-dashboard have no panels field.

Pass any combination of the three arrays in one call; they apply together as a single change:

  • panelsToAdd — appended to the end of the dashboard.
  • panelsToUpdate — { panelId, patch } pairs. Only the panels you name are touched; you never resend the whole dashboard.
  • panelsToDelete — panel IDs to remove.
  • panelsToMove — move and/or resize existing panels.

Name 2 to 4 panels per call, at most 6 across all four arrays. Each panel is validated on its own, so a query that doesn't compile is reported against the panel that caused it while the rest still apply. Build a dashboard by calling create-dashboard for the shell, then calling this tool a few panels at a time — do NOT try to send every panel at once.

Finding panel ids. Panel ids come from get-resource. On a dashboard with more than a handful of panels, call it with detail: "summary" to list every panel's id, type, and title cheaply, then detail: "fields" with fields: ["panels[<id>]"] to read the one you are about to change. Reading a large dashboard at full detail can exceed the tool-result limit.

Patch semantics: an OMITTED field is left unchanged. To fix one panel's query, send { "panelId": "...", "patch": { "queries": [...] } }. A present-but-EMPTY value is a deliberate wipe — "queries": [] clears the panel's queries — so never send an empty value to mean "leave it alone", omit the field instead.

Where added panels go. By default they are appended below everything, at full width (w 24 on a 24-column grid). To put them somewhere specific, send placement: { "kind": "at", "y": 3 } inserts at grid row 3 and pushes the panels below it down, exactly as dragging one there would. Row 0 is the top.

Several charts on one row. w is a width in columns and x is a starting column; both mean the same thing on an added panel and in panelsToMove, so any two panels share a row when their columns don't overlap — one at "w": 12 and one at "x": 12, "w": 12. Height stays automatic on an add.

Added panels with no x pack left to right across the batch and wrap when the next one does not fit, so two with "w": 12 need no x at all. Set x only to sit beside a panel already on the dashboard, and insert at that panel's row: "x": 12, "w": 12 with placement: { "kind": "at", "y": <row> }. An added panel with no w is full width, so an x always needs a w beside it. Never send a layout object on the panel itself.

Minimum sizes. Each panel type has a smallest width: 3 columns for a chart, 4 for a table, 2 for markdown. A title always spans all 24 columns, so never send w for one. An add below its minimum is rejected.

Moving and resizing existing panels is panelsToMove: { "panelId": "...", "y": 0 } moves a panel to a row, and x, w and h set its column, width and height. Send any combination. Other panels reflow around the change the same way they do when a user drags. The requested row is a target, not a coordinate: gaps close afterwards, so a panel sent to a row far below the last one simply ends up last.

An x and w sent together must fit inside the 24 columns, or the call is rejected. An x sent without w keeps the panel's current width, and the panel slides left if that width would run past column 24, so pair x with w when narrowing a full-width panel. A w or h below the panel type's minimum is raised to it. The result reports where each panel actually landed.

A panel's type cannot be patched. To convert a panel, name it in panelsToDelete and its replacement in panelsToAdd in the same call.

Content-pack dashboards need contentPackId. Pass it when the dashboard belongs to a pack you are authoring. Pack dashboards have no space, so their panel queries are NOT compile-validated — the result reports them as saved but unvalidated.

Prefer the chart intent over a raw spec. Pass chart with just a chartType and the spec is built from the panel's own queries. Send chart OR spec, never both. When you do write a raw spec, its encoding field references must match the query's RESULT column names — the names after any AGG ... BY alias = expr rename, not the source path.

Time range: on chart and table panels, leave timeRange empty ("") so the panel inherits the dashboard's. Only set one when the user explicitly asks. Other panel types have no timeRange field — sending one rejects the whole call.

The result reports validation per panel, plus removedPanelIds and unknownPanelIds (ids that aren't on this dashboard). If a panel's ok is false, fix the reported errors before moving on.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
dashboardIdstringRequiredThe ID of the dashboard to change. Pattern: ^DSH_[A-Z0-9]{1,7}$.
panelsToAddarray of objectOptional
panelsToAdd[].xintegerOptionalMinimum 0. Maximum 23.
panelsToAdd[].wintegerOptionalMinimum 1. Maximum 24.
panelsToAdd[].panelobject (four variants)Required
panelsToAdd[].panel[vega-lite].titleobjectOptionalNested fields omitted; see the schema in tools/list.
panelsToAdd[].panel[vega-lite].typestringRequiredAlways vega-lite.
panelsToAdd[].panel[vega-lite].querystringRequired
panelsToAdd[].panel[vega-lite].queriesarray of objectOptionalNested fields omitted; see the schema in tools/list.
panelsToAdd[].panel[vega-lite].specobjectRequired
panelsToAdd[].panel[vega-lite].timeRangestringOptionalDefaults to .
panelsToAdd[].panel[markdown].titleobjectOptionalNested fields omitted; see the schema in tools/list.
panelsToAdd[].panel[markdown].typestringRequiredAlways markdown.
panelsToAdd[].panel[markdown].contentstringOptionalDefaults to .
panelsToAdd[].panel[title].typestringRequiredAlways title.
panelsToAdd[].panel[title].titleobjectRequiredNested fields omitted; see the schema in tools/list.
panelsToAdd[].panel[title].collapsedbooleanOptionalDefaults to false.
panelsToAdd[].panel[table].titleobjectOptionalNested fields omitted; see the schema in tools/list.
panelsToAdd[].panel[table].typestringRequiredAlways table.
panelsToAdd[].panel[table].querystringRequired
panelsToAdd[].panel[table].timeRangestringOptionalDefaults to .
panelsToAdd[].chartobjectOptional
panelsToAdd[].chart.chartTypeenumRequiredOne of line-chart, area-chart, normalized-area-chart, pie-chart, bar-chart, horizontal-bar-chart, grouped-bar-chart, normalized-bar-chart, histogram, scatter-plot, bubble-plot, heat-map.
panelsToMovearray of objectOptional
panelsToMove[].xintegerOptionalMinimum 0. Maximum 23.
panelsToMove[].wintegerOptionalMinimum 1. Maximum 24.
panelsToMove[].panelIdstringRequiredMust not be empty.
panelsToMove[].yintegerOptionalMinimum 0.
panelsToMove[].hintegerOptionalMinimum 1.
placementobject (two variants)Optional
placement[end].kindstringRequiredAlways end.
placement[at].kindstringRequiredAlways at.
placement[at].yintegerRequiredThe grid row to insert at; 0 is the top of the dashboard. Minimum 0.
panelsToUpdatearray of objectOptional
panelsToUpdate[].panelIdstringRequiredThe ID of the panel to patch. Must not be empty.
panelsToUpdate[].patchobjectRequired
panelsToUpdate[].patch.titleobjectOptionalNested fields omitted; see the schema in tools/list.
panelsToUpdate[].patch.querystringOptional
panelsToUpdate[].patch.queriesarray of objectOptionalNested fields omitted; see the schema in tools/list.
panelsToUpdate[].patch.specobjectOptional
panelsToUpdate[].patch.timeRangestringOptional
panelsToUpdate[].patch.contentstringOptional
panelsToUpdate[].patch.collapsedbooleanOptional
panelsToUpdate[].chartobjectOptional
panelsToUpdate[].chart.chartTypeenumRequiredOne of line-chart, area-chart, normalized-area-chart, pie-chart, bar-chart, horizontal-bar-chart, grouped-bar-chart, normalized-bar-chart, histogram, scatter-plot, bubble-plot, heat-map.
panelsToDeletearray of stringOptional
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
dashboardIdstringPattern: ^DSH_[A-Z0-9]{1,7}$.
panelsarray of object
panels[].panelIdstring
panels[].titlestring
panels[].layoutobject
panels[].layout.xintegerMinimum 0. Maximum 23.
panels[].layout.yintegerMinimum 0.
panels[].layout.wintegerMinimum 1. Maximum 24.
panels[].layout.hintegerMinimum 1.
panels[].validationobject
panels[].validation.okboolean
panels[].validation.errorsarray of objectNested fields omitted; see the schema in tools/list.
panels[].validation.warningsarray of objectNested fields omitted; see the schema in tools/list.
removedPanelIdsarray of string
unknownPanelIdsarray of string
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

update-dashboard-variables​

Change dashboard template variables.

Adds, patches, and removes a dashboard's template variables, staging the change in a draft changeset. This is the only way to change them — create-dashboard and update-dashboard do not accept a templateVariables array, so you never resend the whole list.

Pass any combination of the three arrays in one call, up to six variables total:

  • variablesToAdd — IDs are assigned for you; do not send one.
  • variablesToUpdate — { name, patch } keyed by the variable's CURRENT name.
  • variablesToDelete — names to remove.

Variables are addressed by NAME, not by ID. A query substitutes ${name}, so the name is the identity that matters. Names must be unique on a dashboard; adding one that already exists is rejected and reported in rejected.

Renaming or deleting a variable breaks the queries that use it. The result's orphanedReferences lists every panel whose query still substitutes a name the dashboard no longer defines — those queries will not compile. Follow up with update-dashboard-panels to repair each listed panel's query in the same changeset.

Placeholder syntax: ${name}, with no quotes around it.

  • A primitive (type: "int" | "double" | "boolean" | "string") substitutes as a typed literal. A string variable is rendered as a quoted SQL string for you, so do NOT wrap the placeholder in your own quotes: WHERE labels.action == ${value}, never == '${value}'. A primitive with an empty values list is freeform (a text input); a non-empty list renders as a selector and requires a defaultValue.
  • An identifier_fragment substitutes as raw identifier text, for use where a table name goes: FROM events_ecs.${integration}. It always needs a non-empty values list and a default, and its values may contain only letters, digits, and underscores.

Each variable is validated on its own: one that fails is reported in rejected and skipped, while the rest of the batch still applies.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
dashboardIdstringRequiredThe ID of the dashboard to change. Pattern: ^DSH_[A-Z0-9]{1,7}$.
variablesToAddarray of object (two variants)Optional
variablesToAdd[][primitive].namestringRequiredPattern: ^[a-zA-Z_][a-zA-Z_0-9]*$. Must not be empty. At most 64 characters.
variablesToAdd[][primitive].kindstringRequiredAlways primitive.
variablesToAdd[][primitive].typeenumRequiredOne of int, double, boolean, string, interval.
variablesToAdd[][primitive].valuesarray of stringRequired
variablesToAdd[][primitive].defaultValuestringOptionalAt most 1024 characters.
variablesToAdd[][primitive].descriptionstringOptionalAt most 1024 characters.
variablesToAdd[][identifier_fragment].namestringRequiredPattern: ^[a-zA-Z_][a-zA-Z_0-9]*$. Must not be empty. At most 64 characters.
variablesToAdd[][identifier_fragment].kindstringRequiredAlways identifier_fragment.
variablesToAdd[][identifier_fragment].valuesarray of stringRequired
variablesToAdd[][identifier_fragment].defaultValuestringRequiredPattern: ^[a-zA-Z0-9_]+$. At most 1024 characters.
variablesToAdd[][identifier_fragment].descriptionstringOptionalAt most 1024 characters.
variablesToUpdatearray of objectOptional
variablesToUpdate[].namestringRequiredThe CURRENT name of the variable to patch. Must not be empty.
variablesToUpdate[].patchobjectRequired
variablesToUpdate[].patch.namestringOptional
variablesToUpdate[].patch.kindenumOptionalOne of primitive, identifier_fragment.
variablesToUpdate[].patch.typeenumOptionalOne of int, double, boolean, string, interval.
variablesToUpdate[].patch.valuesarray of stringOptional
variablesToUpdate[].patch.defaultValuestringOptional
variablesToUpdate[].patch.descriptionstringOptional
variablesToDeletearray of stringOptional
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
dashboardIdstringPattern: ^DSH_[A-Z0-9]{1,7}$.
variablesarray of object
variables[].idstring
variables[].namestring
removedNamesarray of string
unknownNamesarray of string
rejectedarray of object
rejected[].namestring
rejected[].messagestring
orphanedReferencesarray of object
orphanedReferences[].namestring
orphanedReferences[].panelIdsarray of string
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

create-http-tool-config​

Create HTTP tool.

Creates a HTTP tool in a draft changeset. Provide contentPackId to create it in a content pack; otherwise use the active space. Use folderPath for placement. Read the result with get-resource.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
methodenumRequiredOne of GET, POST, PUT, PATCH, DELETE.
headersmap of stringOptional
bodystringOptionalMay be null. At most 1000000 characters.
folderPathstringOptional
descriptionstringRequired
inputSchemaobjectRequired
readOnlyHintbooleanRequired
requiresApprovalbooleanRequired
namestringRequired
urlstringRequired
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
idstringThe ID of the created HTTP tool.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

update-http-tool-config​

Update HTTP tool.

Updates an HTTP tool, staging the change in a draft changeset. Read the HTTP tool first with get-resource, and only pass fields that must change. A header value of "[redacted]" is a stored plain-text secret: pass it back unchanged to keep it. Plain-text values on secret headers such as Authorization are rejected; use {{ credential.<name> }}.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
methodenumOptionalOne of GET, POST, PUT, PATCH, DELETE.
headersmap of stringOptional
bodystringOptionalMay be null. At most 1000000 characters.
folderPathstringOptional
descriptionstringOptional
inputSchemaobjectOptional
readOnlyHintbooleanOptional
requiresApprovalbooleanOptional
namestringOptional
urlstringOptional
baseVersionintegerOptional
httpToolConfigIdstringRequiredThe ID of the HTTP tool to update. Pattern: ^HTT_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
httpToolConfigobject (two variants)
httpToolConfig[variant 1].idstringPattern: ^HTT_[A-Z0-9]{1,7}$.
httpToolConfig[variant 1].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
httpToolConfig[variant 1].spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
httpToolConfig[variant 1].namestring
httpToolConfig[variant 1].descriptionstring
httpToolConfig[variant 1].inputSchemaobject
httpToolConfig[variant 1].urlstring
httpToolConfig[variant 1].methodenumOne of GET, POST, PUT, PATCH, DELETE.
httpToolConfig[variant 1].headersmap of string
httpToolConfig[variant 1].bodystringMay be null. At most 1000000 characters.
httpToolConfig[variant 1].readOnlyHintboolean
httpToolConfig[variant 1].requiresApprovalboolean
httpToolConfig[variant 1].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
httpToolConfig[variant 1].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
httpToolConfig[variant 1].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
httpToolConfig[variant 1].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
httpToolConfig[variant 1].folderIdstringMay be null.
httpToolConfig[variant 1].folderPathstring
httpToolConfig[variant 1].readOnlyboolean
httpToolConfig[variant 1].installedFromobject (two variants)May be null.
httpToolConfig[variant 1].installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
httpToolConfig[variant 1].installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
httpToolConfig[variant 1].installedFrom[variant 1].templateIdstring
httpToolConfig[variant 1].installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
httpToolConfig[variant 1].installedFrom[variant 2].linkModeenumOne of Copy.
httpToolConfig[variant 1].installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
httpToolConfig[variant 1].versionintegerMay be null. Greater than 0.
httpToolConfig[variant 1].deletedbooleanDefaults to false.
httpToolConfig[variant 1].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
httpToolConfig[variant 1].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
httpToolConfig[variant 1].originKeystringMay be null.
httpToolConfig[variant 2].idstringPattern: ^HTT_[A-Z0-9]{1,7}$.
httpToolConfig[variant 2].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
httpToolConfig[variant 2].namestring
httpToolConfig[variant 2].descriptionstring
httpToolConfig[variant 2].inputSchemaobject
httpToolConfig[variant 2].urlstring
httpToolConfig[variant 2].methodenumOne of GET, POST, PUT, PATCH, DELETE.
httpToolConfig[variant 2].headersmap of string
httpToolConfig[variant 2].bodystringMay be null. At most 1000000 characters.
httpToolConfig[variant 2].readOnlyHintboolean
httpToolConfig[variant 2].requiresApprovalboolean
httpToolConfig[variant 2].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
httpToolConfig[variant 2].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
httpToolConfig[variant 2].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
httpToolConfig[variant 2].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
httpToolConfig[variant 2].folderIdstringMay be null.
httpToolConfig[variant 2].folderPathstring
httpToolConfig[variant 2].readOnlyboolean
httpToolConfig[variant 2].versionintegerMay be null. Greater than 0.
httpToolConfig[variant 2].deletedbooleanDefaults to false.
httpToolConfig[variant 2].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
httpToolConfig[variant 2].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
httpToolConfig[variant 2].originKeystringMay be null.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

delete-http-tool-config​

Delete HTTP tool.

Deletes a HTTP tool in a draft changeset. Read it with get-resource first and pass its baseVersion. Provide contentPackId for pack-owned content.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
httpToolConfigIdstringRequiredThe ID of the HTTP tool to delete. Pattern: ^HTT_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

preview-http-tool-config​

Preview HTTP tool.

Renders an HTTP tool request from inline config and parameters. Credential values are redacted. Does not send a request or save the config.

Annotations: readOnlyHint true, destructiveHint false, idempotentHint true.

Inputs​

FieldTypeRequiredDescription
configobjectRequired
config.urlstringRequired
config.headersmap of stringOptional
config.methodenumRequiredOne of GET, POST, PUT, PATCH, DELETE.
config.bodystringOptional
parametersobjectRequired

Outputs​

FieldTypeDescription
configobject
config.headersmap of string
config.methodenumOne of GET, POST, PUT, PATCH, DELETE.
config.bodystring
config.urlstringMust not be empty.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

test-http-tool-config​

Test HTTP tool.

Sends a real HTTP request from inline config and parameters using real credentials. This can modify the remote service. Preview with preview-http-tool-config first. Returns the redacted request and HTTP response; does not save the config. Requires approval in Simba.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
configobjectRequired
config.urlstringRequired
config.headersmap of stringOptional
config.methodenumRequiredOne of GET, POST, PUT, PATCH, DELETE.
config.bodystringOptional
parametersobjectRequired

Outputs​

FieldTypeDescription
configobject
config.urlstringFormat: uri.
config.headersmap of string
config.methodenumOne of GET, POST, PUT, PATCH, DELETE.
config.bodystring
responseobject
response.statusnumber
response.statusTextstring
response.headersmap of string
response.bodystring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

create-mcp-config​

Create MCP config.

Creates a MCP config in a draft changeset. Provide contentPackId to create it in a content pack; otherwise use the active space. Use folderPath for placement. Read the result with get-resource.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
headersmap of stringOptional
authenticationobjectOptionalMay be null.
authentication.typestringRequiredAlways oauth.
authentication.credentialIdstringRequiredPattern: ^CRD_[A-Z0-9]{1,7}$.
folderPathstringOptional
discoveredToolsarray of objectOptionalDefaults to [].
discoveredTools[].namestringRequired
discoveredTools[].descriptionstringOptional
discoveredTools[].inputSchemaobjectOptional
discoveredTools[].readOnlyHintbooleanOptional
discoveredTools[].destructiveHintbooleanOptional
discoveredTools[].enabledbooleanOptionalDefaults to true.
discoveredTools[].requiresApprovalOverridebooleanOptional
namestringRequired
urlstringRequired
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
idstringThe ID of the created MCP config.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

update-mcp-config​

Update MCP config.

Updates an MCP config, staging the change in a draft changeset. Read the MCP config first with get-resource, and only pass fields that must change. A header value of "[redacted]" is a stored plain-text secret: pass it back unchanged to keep it. Plain-text values on secret headers such as Authorization are rejected; use {{ credential.<name> }}.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
headersmap of stringOptional
authenticationobjectOptionalMay be null.
authentication.typestringRequiredAlways oauth.
authentication.credentialIdstringRequiredPattern: ^CRD_[A-Z0-9]{1,7}$.
folderPathstringOptional
discoveredToolsarray of objectOptional
discoveredTools[].namestringRequired
discoveredTools[].descriptionstringOptional
discoveredTools[].inputSchemaobjectOptional
discoveredTools[].readOnlyHintbooleanOptional
discoveredTools[].destructiveHintbooleanOptional
discoveredTools[].enabledbooleanOptionalDefaults to true.
discoveredTools[].requiresApprovalOverridebooleanOptional
namestringOptional
urlstringOptional
baseVersionintegerOptional
mcpConfigIdstringRequiredThe ID of the MCP config to update. Pattern: ^MCP_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
mcpConfigobject (two variants)
mcpConfig[variant 1].idstringPattern: ^MCP_[A-Z0-9]{1,7}$.
mcpConfig[variant 1].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
mcpConfig[variant 1].spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
mcpConfig[variant 1].namestring
mcpConfig[variant 1].urlstring
mcpConfig[variant 1].headersmap of string
mcpConfig[variant 1].authenticationobjectMay be null.
mcpConfig[variant 1].authentication.typestringAlways oauth.
mcpConfig[variant 1].authentication.credentialIdstringPattern: ^CRD_[A-Z0-9]{1,7}$.
mcpConfig[variant 1].discoveredToolsarray of object
mcpConfig[variant 1].discoveredTools[].namestring
mcpConfig[variant 1].discoveredTools[].descriptionstring
mcpConfig[variant 1].discoveredTools[].inputSchemaobject
mcpConfig[variant 1].discoveredTools[].readOnlyHintboolean
mcpConfig[variant 1].discoveredTools[].destructiveHintboolean
mcpConfig[variant 1].discoveredTools[].enabledbooleanDefaults to true.
mcpConfig[variant 1].discoveredTools[].requiresApprovalOverrideboolean
mcpConfig[variant 1].lastDiscoveredAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig[variant 1].connectionStatusenumOne of unchecked, authentication_required, connected, error.
mcpConfig[variant 1].connectionErrorCodestringMay be null.
mcpConfig[variant 1].connectionErrorMessagestringMay be null.
mcpConfig[variant 1].lastCheckedAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig[variant 1].lastConnectedAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig[variant 1].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig[variant 1].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
mcpConfig[variant 1].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig[variant 1].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
mcpConfig[variant 1].folderIdstringMay be null.
mcpConfig[variant 1].folderPathstring
mcpConfig[variant 1].readOnlyboolean
mcpConfig[variant 1].installedFromobject (two variants)May be null.
mcpConfig[variant 1].installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
mcpConfig[variant 1].installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
mcpConfig[variant 1].installedFrom[variant 1].templateIdstring
mcpConfig[variant 1].installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
mcpConfig[variant 1].installedFrom[variant 2].linkModeenumOne of Copy.
mcpConfig[variant 1].installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
mcpConfig[variant 1].versionintegerMay be null. Greater than 0.
mcpConfig[variant 1].deletedbooleanDefaults to false.
mcpConfig[variant 1].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
mcpConfig[variant 1].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
mcpConfig[variant 1].originKeystringMay be null.
mcpConfig[variant 2].idstringPattern: ^MCP_[A-Z0-9]{1,7}$.
mcpConfig[variant 2].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
mcpConfig[variant 2].namestring
mcpConfig[variant 2].urlstring
mcpConfig[variant 2].headersmap of string
mcpConfig[variant 2].authenticationobjectMay be null.
mcpConfig[variant 2].authentication.typestringAlways oauth.
mcpConfig[variant 2].authentication.credentialIdstringPattern: ^CRD_[A-Z0-9]{1,7}$.
mcpConfig[variant 2].discoveredToolsarray of object
mcpConfig[variant 2].discoveredTools[].namestring
mcpConfig[variant 2].discoveredTools[].descriptionstring
mcpConfig[variant 2].discoveredTools[].inputSchemaobject
mcpConfig[variant 2].discoveredTools[].readOnlyHintboolean
mcpConfig[variant 2].discoveredTools[].destructiveHintboolean
mcpConfig[variant 2].discoveredTools[].enabledbooleanDefaults to true.
mcpConfig[variant 2].discoveredTools[].requiresApprovalOverrideboolean
mcpConfig[variant 2].lastDiscoveredAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig[variant 2].connectionStatusenumOne of unchecked, authentication_required, connected, error.
mcpConfig[variant 2].connectionErrorCodestringMay be null.
mcpConfig[variant 2].connectionErrorMessagestringMay be null.
mcpConfig[variant 2].lastCheckedAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig[variant 2].lastConnectedAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig[variant 2].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig[variant 2].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
mcpConfig[variant 2].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig[variant 2].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
mcpConfig[variant 2].folderIdstringMay be null.
mcpConfig[variant 2].folderPathstring
mcpConfig[variant 2].readOnlyboolean
mcpConfig[variant 2].versionintegerMay be null. Greater than 0.
mcpConfig[variant 2].deletedbooleanDefaults to false.
mcpConfig[variant 2].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
mcpConfig[variant 2].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
mcpConfig[variant 2].originKeystringMay be null.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

delete-mcp-config​

Delete MCP config.

Deletes a MCP config in a draft changeset. Read it with get-resource first and pass its baseVersion. Provide contentPackId for pack-owned content.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
mcpConfigIdstringRequiredThe ID of the MCP config to delete. Pattern: ^MCP_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

probe-mcp-server​

Probe MCP server.

Checks an MCP endpoint for connectivity, available tools, and OAuth requirements using the active space for credential access. Does not create or modify an MCP config or call any discovered tool. Use rediscover-mcp-tools to refresh a saved config.

Annotations: readOnlyHint true, idempotentHint true.

Inputs​

FieldTypeRequiredDescription
urlstringRequiredFormat: uri.
headersmap of stringOptional
authenticationobjectOptionalMay be null.
authentication.typestringRequiredAlways oauth.
authentication.credentialIdstringRequiredPattern: ^CRD_[A-Z0-9]{1,7}$.
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
connectionobject (four variants)
connection[variant 1].statusstringAlways connected.
connection[variant 1].reasonenumOne of authless, credential_connected.
connection[variant 1].resourceNamestringMay be null.
connection[variant 1].discoveredToolsarray of object
connection[variant 1].discoveredTools[].namestring
connection[variant 1].discoveredTools[].descriptionstring
connection[variant 1].discoveredTools[].inputSchemaobject
connection[variant 1].discoveredTools[].readOnlyHintboolean
connection[variant 1].discoveredTools[].destructiveHintboolean
connection[variant 1].discoveredTools[].enabledbooleanDefaults to true.
connection[variant 1].discoveredTools[].requiresApprovalOverrideboolean
connection[variant 2].statusstringAlways authentication_required.
connection[variant 2].reasonstringAlways oauth_discovered.
connection[variant 2].resourceNamestringMay be null.
connection[variant 2].oauthobject
connection[variant 2].oauth.setupModestringAlways discovered.
connection[variant 2].oauth.resourceUrlstringMay be null. Format: uri.
connection[variant 2].oauth.resourceNamestringMay be null.
connection[variant 2].oauth.authorizationServerIssuerstringFormat: uri.
connection[variant 2].oauth.authorizationUrlstringMay be null. Format: uri.
connection[variant 2].oauth.tokenUrlstringFormat: uri.
connection[variant 2].oauth.registrationUrlstringMay be null. Format: uri.
connection[variant 2].oauth.scopesarray of string
connection[variant 2].oauth.registrationModesarray of enum
connection[variant 2].oauth.recommendedRegistrationModeenumOne of pre_registered, client_id_metadata, dynamic. May be null.
connection[variant 2].oauth.tokenEndpointAuthMethodsarray of enum
connection[variant 2].oauth.recommendedTokenEndpointAuthMethodenumOne of client_secret_basic, client_secret_post, none. May be null.
connection[variant 2].oauth.discoveredAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
connection[variant 3].statusstringAlways authentication_required.
connection[variant 3].reasonenumOne of unsupported_auth, credential_reauthorization_required.
connection[variant 3].resourceNamestringMay be null.
connection[variant 3].errorCodestring
connection[variant 3].errorMessagestring
connection[variant 4].statusstringAlways error.
connection[variant 4].reasonenumOne of unreachable, protocol_error, credential_url_policy_mismatch, credential_invalid.
connection[variant 4].resourceNamestringMay be null.
connection[variant 4].errorCodestring
connection[variant 4].errorMessagestring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

rediscover-mcp-tools​

Rediscover MCP tools.

Reconnects to a saved MCP server and refreshes its tool list and connection status. Preserves enabled and approval overrides for existing tools. Does not call discovered tools. Pass changesetId to read a staged config, and contentPackId for pack-owned configs. Updates connection metadata immediately on that config version; it does not create or commit a changeset.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint true.

Inputs​

FieldTypeRequiredDescription
mcpConfigIdstringRequiredPattern: ^MCP_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
mcpConfigobject
mcpConfig.idstringPattern: ^MCP_[A-Z0-9]{1,7}$.
mcpConfig.organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
mcpConfig.spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
mcpConfig.namestring
mcpConfig.urlstring
mcpConfig.headersmap of string
mcpConfig.authenticationobjectMay be null.
mcpConfig.authentication.typestringAlways oauth.
mcpConfig.authentication.credentialIdstringPattern: ^CRD_[A-Z0-9]{1,7}$.
mcpConfig.discoveredToolsarray of object
mcpConfig.discoveredTools[].namestring
mcpConfig.discoveredTools[].descriptionstring
mcpConfig.discoveredTools[].inputSchemaobject
mcpConfig.discoveredTools[].readOnlyHintboolean
mcpConfig.discoveredTools[].destructiveHintboolean
mcpConfig.discoveredTools[].enabledbooleanDefaults to true.
mcpConfig.discoveredTools[].requiresApprovalOverrideboolean
mcpConfig.lastDiscoveredAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig.connectionStatusenumOne of unchecked, authentication_required, connected, error.
mcpConfig.connectionErrorCodestringMay be null.
mcpConfig.connectionErrorMessagestringMay be null.
mcpConfig.lastCheckedAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig.lastConnectedAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig.createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig.createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
mcpConfig.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mcpConfig.updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
mcpConfig.folderIdstringMay be null.
mcpConfig.folderPathstring
mcpConfig.readOnlyboolean
mcpConfig.installedFromobject (two variants)May be null.
mcpConfig.installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
mcpConfig.installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
mcpConfig.installedFrom[variant 1].templateIdstring
mcpConfig.installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
mcpConfig.installedFrom[variant 2].linkModeenumOne of Copy.
mcpConfig.installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
mcpConfig.versionintegerMay be null. Greater than 0.
mcpConfig.deletedbooleanDefaults to false.
mcpConfig.changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
mcpConfig.changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
mcpConfig.originKeystringMay be null.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

delete-dashboard​

Delete a dashboard.

Deletes a dashboard, staging the change in a draft changeset.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
dashboardIdstringRequiredThe ID of the dashboard to delete. Pattern: ^DSH_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

create-webhook​

Create a webhook.

Creates a new webhook, staging the change in a draft changeset.

Creates the resource in the active chat's space or, when contentPackId is set, in that content pack.

Call get-resource-engineering-guide with topic webhook first, then preview-webhook-config to verify the rendered JSON body before staging.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
eventNameenumRequiredThe event that triggers this webhook. One of CaseCreated, CaseClosed, CaseInitialAnalysisCompleted, ContentWorkItemCreated, ThreatReportCreated, CircuitBreakerTripped, SimbaUsageAlert, AlertQueued, AlertInitialScoreCompleted, AlertPromoted, AlertExpired, AlertTriageFailure, CaseNewAlertEvidenceAttached.
methodenumRequiredOne of GET, POST, PUT, PATCH, DELETE.
headersmap of stringOptional
bodystringOptionalMay be null. At most 1000000 characters.
triggerExpressionstringOptionalMay be null. At most 1000000 characters.
folderPathstringOptional
namestringRequired
urlstringRequired
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
idstringThe ID of the created webhook.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

update-webhook​

Update a webhook.

Updates an existing webhook, staging the change in a draft changeset. Call get-resource-engineering-guide with topic webhook first, then preview-webhook-config to verify the rendered JSON body before staging. Only pass fields you intend to change. Omit headers, body, and other fields to preserve them. Never pass headers: {} unless you mean to remove all headers. A header value of "[redacted]" is a stored plain-text secret: pass it back unchanged to keep it. Plain-text values on secret headers such as Authorization are rejected; use {{ credential.<name> }}.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
eventNameenumOptionalThe event that triggers this webhook. One of CaseCreated, CaseClosed, CaseInitialAnalysisCompleted, ContentWorkItemCreated, ThreatReportCreated, CircuitBreakerTripped, SimbaUsageAlert, AlertQueued, AlertInitialScoreCompleted, AlertPromoted, AlertExpired, AlertTriageFailure, CaseNewAlertEvidenceAttached.
methodenumOptionalOne of GET, POST, PUT, PATCH, DELETE.
headersmap of stringOptional
bodystringOptionalMay be null. At most 1000000 characters.
triggerExpressionstringOptionalMay be null. At most 1000000 characters.
folderPathstringOptional
namestringOptional
urlstringOptional
baseVersionintegerOptional
webhookConfigIdstringRequiredThe ID of the webhook to update. Pattern: ^WHK_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
webhookConfigobject (two variants)
webhookConfig[variant 1].idstringPattern: ^WHK_[A-Z0-9]{1,7}$.
webhookConfig[variant 1].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
webhookConfig[variant 1].spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
webhookConfig[variant 1].namestring
webhookConfig[variant 1].eventNameenumThe event that triggers this webhook. One of CaseCreated, CaseClosed, CaseInitialAnalysisCompleted, ContentWorkItemCreated, ThreatReportCreated, CircuitBreakerTripped, SimbaUsageAlert, AlertQueued, AlertInitialScoreCompleted, AlertPromoted, AlertExpired, AlertTriageFailure, CaseNewAlertEvidenceAttached.
webhookConfig[variant 1].urlstring
webhookConfig[variant 1].methodenumOne of GET, POST, PUT, PATCH, DELETE.
webhookConfig[variant 1].headersmap of string
webhookConfig[variant 1].bodystringMay be null. At most 1000000 characters.
webhookConfig[variant 1].triggerExpressionstringMay be null. At most 1000000 characters.
webhookConfig[variant 1].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
webhookConfig[variant 1].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
webhookConfig[variant 1].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
webhookConfig[variant 1].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
webhookConfig[variant 1].folderIdstringMay be null.
webhookConfig[variant 1].folderPathstring
webhookConfig[variant 1].readOnlyboolean
webhookConfig[variant 1].installedFromobject (two variants)May be null.
webhookConfig[variant 1].installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
webhookConfig[variant 1].installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
webhookConfig[variant 1].installedFrom[variant 1].templateIdstring
webhookConfig[variant 1].installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
webhookConfig[variant 1].installedFrom[variant 2].linkModeenumOne of Copy.
webhookConfig[variant 1].installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
webhookConfig[variant 1].versionintegerMay be null. Greater than 0.
webhookConfig[variant 1].deletedbooleanDefaults to false.
webhookConfig[variant 1].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
webhookConfig[variant 1].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
webhookConfig[variant 1].originKeystringMay be null.
webhookConfig[variant 2].idstringPattern: ^WHK_[A-Z0-9]{1,7}$.
webhookConfig[variant 2].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
webhookConfig[variant 2].namestring
webhookConfig[variant 2].eventNameenumThe event that triggers this webhook. One of CaseCreated, CaseClosed, CaseInitialAnalysisCompleted, ContentWorkItemCreated, ThreatReportCreated, CircuitBreakerTripped, SimbaUsageAlert, AlertQueued, AlertInitialScoreCompleted, AlertPromoted, AlertExpired, AlertTriageFailure, CaseNewAlertEvidenceAttached.
webhookConfig[variant 2].urlstring
webhookConfig[variant 2].methodenumOne of GET, POST, PUT, PATCH, DELETE.
webhookConfig[variant 2].headersmap of string
webhookConfig[variant 2].bodystringMay be null. At most 1000000 characters.
webhookConfig[variant 2].triggerExpressionstringMay be null. At most 1000000 characters.
webhookConfig[variant 2].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
webhookConfig[variant 2].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
webhookConfig[variant 2].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
webhookConfig[variant 2].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
webhookConfig[variant 2].folderIdstringMay be null.
webhookConfig[variant 2].folderPathstring
webhookConfig[variant 2].readOnlyboolean
webhookConfig[variant 2].versionintegerMay be null. Greater than 0.
webhookConfig[variant 2].deletedbooleanDefaults to false.
webhookConfig[variant 2].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
webhookConfig[variant 2].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
webhookConfig[variant 2].originKeystringMay be null.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

delete-webhook​

Delete a webhook.

Deletes a webhook, staging the change in a draft changeset.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
webhookConfigIdstringRequiredThe ID of the webhook to delete. Pattern: ^WHK_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

preview-webhook-config​

Preview webhook config rendering.

Renders a webhook configuration template against a sample event without sending an HTTP request. Pass validateBodyAsJson: true for JSON bodies and confirm bodyJsonValidation.valid before staging. Credentials are redacted in the result.

Annotations: readOnlyHint true, idempotentHint true.

Inputs​

FieldTypeRequiredDescription
configobjectRequired
config.urlstringRequired
config.headersmap of stringOptional
config.methodenumRequiredOne of GET, POST, PUT, PATCH, DELETE.
config.bodystringOptional
eventobject (13 variants)Required
event[CaseCreated].typestringRequiredAlways CaseCreated.
event[CaseCreated].caseobjectRequired
event[CaseCreated].case.idstringRequiredPattern: ^CAS_[A-Z0-9]{1,7}$.
event[CaseCreated].case.namestringRequiredMust not be empty.
event[CaseCreated].case.statusenumRequiredOne of Open, On-Hold, Closed.
event[CaseCreated].case.closureCodeenumRequiredOne of True Positive - Suspicious Activity, Benign Positive - Suspicious But Expected, False Positive - Incorrect Detection Logic, False Positive - Inaccurate Data, Other, Testing. May be null.
event[CaseCreated].case.suggestedClosureCodeenumRequiredOne of True Positive - Suspicious Activity, Benign Positive - Suspicious But Expected, False Positive - Incorrect Detection Logic, False Positive - Inaccurate Data, Other, Testing. May be null.
event[CaseCreated].case.suggestedClosureCodeDismissedbooleanRequired
event[CaseCreated].case.typeIdintegerRequiredMay be null. Greater than 0.
event[CaseCreated].case.severityIdintegerRequiredMay be null. Greater than 0.
event[CaseCreated].case.phaseIdintegerRequiredGreater than 0.
event[CaseCreated].case.assignedToUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseCreated].case.summarystringRequired
event[CaseCreated].case.entitiesarray of objectRequiredNested fields omitted; see the schema in tools/list.
event[CaseCreated].case.createdByDetectionIdstringRequiredMay be null. Pattern: ^DET_[A-Z0-9]{1,7}$.
event[CaseCreated].case.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[CaseCreated].case.spaceIdstringRequiredPattern: ^SPC_[A-Z0-9]{1,7}$.
event[CaseCreated].case.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseCreated].case.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseCreated].case.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseCreated].case.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseCreated].case.versionnumberRequired
event[CaseCreated].case.timeToDetectMsintegerRequiredMay be null. Minimum 0.
event[CaseCreated].case.timeToInvestigateMsintegerRequiredMay be null. Minimum 0.
event[CaseCreated].case.timeToContainMsintegerRequiredMay be null. Minimum 0.
event[CaseCreated].case.timeToEradicateMsintegerRequiredMay be null. Minimum 0.
event[CaseCreated].case.timeToResolveMsintegerRequiredMay be null. Minimum 0.
event[CaseCreated].case.initialAnalysisStatusenumRequiredOne of PENDING, IN_PROGRESS, PARTIAL, COMPLETED, FAILED, SKIPPED, STOPPED.
event[CaseCreated].case.initialAnalysisCompletedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseCreated].case.closedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseCreated].case.closedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseCreated].case.closedByChatIdstringRequiredMay be null. Pattern: ^CHT_[A-Z0-9]{1,7}$.
event[CaseCreated].case.analysisSkippedReasonenumOptionalOne of QuotaExceeded, BudgetExhausted, PromoteAllConfigured, UserRequested, RateLimited, AutomaticAnalysisDisabled. May be null.
event[CaseCreated].case.analysisStoppedReasonenumRequiredOne of QuotaExceeded. May be null.
event[CaseCreated].case.blocksarray of object (five variants)RequiredNested fields omitted; see the schema in tools/list.
event[CaseClosed].typestringRequiredAlways CaseClosed.
event[CaseClosed].caseobjectRequired
event[CaseClosed].case.idstringRequiredPattern: ^CAS_[A-Z0-9]{1,7}$.
event[CaseClosed].case.namestringRequiredMust not be empty.
event[CaseClosed].case.statusenumRequiredOne of Open, On-Hold, Closed.
event[CaseClosed].case.closureCodeenumRequiredOne of True Positive - Suspicious Activity, Benign Positive - Suspicious But Expected, False Positive - Incorrect Detection Logic, False Positive - Inaccurate Data, Other, Testing. May be null.
event[CaseClosed].case.suggestedClosureCodeenumRequiredOne of True Positive - Suspicious Activity, Benign Positive - Suspicious But Expected, False Positive - Incorrect Detection Logic, False Positive - Inaccurate Data, Other, Testing. May be null.
event[CaseClosed].case.suggestedClosureCodeDismissedbooleanRequired
event[CaseClosed].case.typeIdintegerRequiredMay be null. Greater than 0.
event[CaseClosed].case.severityIdintegerRequiredMay be null. Greater than 0.
event[CaseClosed].case.phaseIdintegerRequiredGreater than 0.
event[CaseClosed].case.assignedToUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseClosed].case.summarystringRequired
event[CaseClosed].case.entitiesarray of objectRequiredNested fields omitted; see the schema in tools/list.
event[CaseClosed].case.createdByDetectionIdstringRequiredMay be null. Pattern: ^DET_[A-Z0-9]{1,7}$.
event[CaseClosed].case.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[CaseClosed].case.spaceIdstringRequiredPattern: ^SPC_[A-Z0-9]{1,7}$.
event[CaseClosed].case.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseClosed].case.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseClosed].case.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseClosed].case.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseClosed].case.versionnumberRequired
event[CaseClosed].case.timeToDetectMsintegerRequiredMay be null. Minimum 0.
event[CaseClosed].case.timeToInvestigateMsintegerRequiredMay be null. Minimum 0.
event[CaseClosed].case.timeToContainMsintegerRequiredMay be null. Minimum 0.
event[CaseClosed].case.timeToEradicateMsintegerRequiredMay be null. Minimum 0.
event[CaseClosed].case.timeToResolveMsintegerRequiredMay be null. Minimum 0.
event[CaseClosed].case.initialAnalysisStatusenumRequiredOne of PENDING, IN_PROGRESS, PARTIAL, COMPLETED, FAILED, SKIPPED, STOPPED.
event[CaseClosed].case.initialAnalysisCompletedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseClosed].case.closedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseClosed].case.closedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseClosed].case.closedByChatIdstringRequiredMay be null. Pattern: ^CHT_[A-Z0-9]{1,7}$.
event[CaseClosed].case.analysisSkippedReasonenumOptionalOne of QuotaExceeded, BudgetExhausted, PromoteAllConfigured, UserRequested, RateLimited, AutomaticAnalysisDisabled. May be null.
event[CaseClosed].case.analysisStoppedReasonenumRequiredOne of QuotaExceeded. May be null.
event[CaseClosed].case.blocksarray of object (five variants)RequiredNested fields omitted; see the schema in tools/list.
event[CaseInitialAnalysisCompleted].typestringRequiredAlways CaseInitialAnalysisCompleted.
event[CaseInitialAnalysisCompleted].caseobjectRequired
event[CaseInitialAnalysisCompleted].case.idstringRequiredPattern: ^CAS_[A-Z0-9]{1,7}$.
event[CaseInitialAnalysisCompleted].case.namestringRequiredMust not be empty.
event[CaseInitialAnalysisCompleted].case.statusenumRequiredOne of Open, On-Hold, Closed.
event[CaseInitialAnalysisCompleted].case.closureCodeenumRequiredOne of True Positive - Suspicious Activity, Benign Positive - Suspicious But Expected, False Positive - Incorrect Detection Logic, False Positive - Inaccurate Data, Other, Testing. May be null.
event[CaseInitialAnalysisCompleted].case.suggestedClosureCodeenumRequiredOne of True Positive - Suspicious Activity, Benign Positive - Suspicious But Expected, False Positive - Incorrect Detection Logic, False Positive - Inaccurate Data, Other, Testing. May be null.
event[CaseInitialAnalysisCompleted].case.suggestedClosureCodeDismissedbooleanRequired
event[CaseInitialAnalysisCompleted].case.typeIdintegerRequiredMay be null. Greater than 0.
event[CaseInitialAnalysisCompleted].case.severityIdintegerRequiredMay be null. Greater than 0.
event[CaseInitialAnalysisCompleted].case.phaseIdintegerRequiredGreater than 0.
event[CaseInitialAnalysisCompleted].case.assignedToUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseInitialAnalysisCompleted].case.summarystringRequired
event[CaseInitialAnalysisCompleted].case.entitiesarray of objectRequiredNested fields omitted; see the schema in tools/list.
event[CaseInitialAnalysisCompleted].case.createdByDetectionIdstringRequiredMay be null. Pattern: ^DET_[A-Z0-9]{1,7}$.
event[CaseInitialAnalysisCompleted].case.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[CaseInitialAnalysisCompleted].case.spaceIdstringRequiredPattern: ^SPC_[A-Z0-9]{1,7}$.
event[CaseInitialAnalysisCompleted].case.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseInitialAnalysisCompleted].case.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseInitialAnalysisCompleted].case.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseInitialAnalysisCompleted].case.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseInitialAnalysisCompleted].case.versionnumberRequired
event[CaseInitialAnalysisCompleted].case.timeToDetectMsintegerRequiredMay be null. Minimum 0.
event[CaseInitialAnalysisCompleted].case.timeToInvestigateMsintegerRequiredMay be null. Minimum 0.
event[CaseInitialAnalysisCompleted].case.timeToContainMsintegerRequiredMay be null. Minimum 0.
event[CaseInitialAnalysisCompleted].case.timeToEradicateMsintegerRequiredMay be null. Minimum 0.
event[CaseInitialAnalysisCompleted].case.timeToResolveMsintegerRequiredMay be null. Minimum 0.
event[CaseInitialAnalysisCompleted].case.initialAnalysisStatusenumRequiredOne of PENDING, IN_PROGRESS, PARTIAL, COMPLETED, FAILED, SKIPPED, STOPPED.
event[CaseInitialAnalysisCompleted].case.initialAnalysisCompletedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseInitialAnalysisCompleted].case.closedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseInitialAnalysisCompleted].case.closedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseInitialAnalysisCompleted].case.closedByChatIdstringRequiredMay be null. Pattern: ^CHT_[A-Z0-9]{1,7}$.
event[CaseInitialAnalysisCompleted].case.analysisSkippedReasonenumOptionalOne of QuotaExceeded, BudgetExhausted, PromoteAllConfigured, UserRequested, RateLimited, AutomaticAnalysisDisabled. May be null.
event[CaseInitialAnalysisCompleted].case.analysisStoppedReasonenumRequiredOne of QuotaExceeded. May be null.
event[CaseInitialAnalysisCompleted].case.blocksarray of object (five variants)RequiredNested fields omitted; see the schema in tools/list.
event[ContentWorkItemCreated].typestringRequiredAlways ContentWorkItemCreated.
event[ContentWorkItemCreated].contentWorkItemobjectRequired
event[ContentWorkItemCreated].contentWorkItem.idstringRequiredPattern: ^CWI_[A-Z0-9]{1,7}$.
event[ContentWorkItemCreated].contentWorkItem.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[ContentWorkItemCreated].contentWorkItem.spaceIdstringRequiredPattern: ^SPC_[A-Z0-9]{1,7}$.
event[ContentWorkItemCreated].contentWorkItem.namestringRequired
event[ContentWorkItemCreated].contentWorkItem.descriptionstringRequired
event[ContentWorkItemCreated].contentWorkItem.statusenumRequiredOne of Open, Done, Cancelled.
event[ContentWorkItemCreated].contentWorkItem.assignedToUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[ContentWorkItemCreated].contentWorkItem.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[ContentWorkItemCreated].contentWorkItem.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[ContentWorkItemCreated].contentWorkItem.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[ContentWorkItemCreated].contentWorkItem.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[ContentWorkItemCreated].contentWorkItem.implementationSkippedReasonenumOptionalOne of QuotaExceeded. May be null.
event[ThreatReportCreated].typestringRequiredAlways ThreatReportCreated.
event[ThreatReportCreated].threatReportobjectRequired
event[ThreatReportCreated].threatReport.idstringRequiredPattern: ^THR_[A-Z0-9]{1,7}$.
event[ThreatReportCreated].threatReport.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[ThreatReportCreated].threatReport.namestringRequired
event[ThreatReportCreated].threatReport.summarystringRequired
event[ThreatReportCreated].threatReport.contentstringRequired
event[ThreatReportCreated].threatReport.publishedDatestringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[ThreatReportCreated].threatReport.urlstringRequiredFormat: uri.
event[ThreatReportCreated].threatReport.authorstringOptionalMay be null.
event[ThreatReportCreated].threatReport.imageUrlstringOptionalMay be null. Format: uri.
event[ThreatReportCreated].threatReport.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[ThreatReportCreated].threatReport.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[ThreatReportCreated].threatReport.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[ThreatReportCreated].threatReport.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[ThreatReportCreated].threatReport.versionnumberRequired
event[ThreatReportCreated].threatReport.triageCompletebooleanRequired
event[ThreatReportCreated].threatReport.contentWorkItemsarray of objectRequiredNested fields omitted; see the schema in tools/list.
event[ThreatReportCreated].threatReport.triageQuotaSkippedSpacesmap of stringOptional
event[CircuitBreakerTripped].typestringRequiredAlways CircuitBreakerTripped.
event[CircuitBreakerTripped].circuitBreakerobjectRequired
event[CircuitBreakerTripped].circuitBreaker.breakerTypestringRequired
event[CircuitBreakerTripped].circuitBreaker.paramsmap of stringRequired
event[CircuitBreakerTripped].circuitBreaker.cutoffnumberRequired
event[SimbaUsageAlert].typestringRequiredAlways SimbaUsageAlert.
event[SimbaUsageAlert].alertobjectRequired
event[SimbaUsageAlert].alert.categoryenumRequiredOne of Cases, ContentEngineering, Chat, Misc, Total.
event[SimbaUsageAlert].alert.spaceIdstringRequiredMay be null.
event[SimbaUsageAlert].alert.budgetAmountUsdnumberRequired
event[SimbaUsageAlert].alert.currentUsageUsdnumberRequired
event[SimbaUsageAlert].alert.ruleobject (two variants)RequiredNested fields omitted; see the schema in tools/list.
event[AlertQueued].typestringRequiredAlways AlertQueued.
event[AlertQueued].alertobjectRequired
event[AlertQueued].alert.idstringRequiredPattern: ^ALR_[A-Z0-9]{1,7}$.
event[AlertQueued].alert.namestringRequired
event[AlertQueued].alert.statusenumRequiredOne of Queued, Accumulating, Processing, Promoted, Merged, Expired, TriageFailure.
event[AlertQueued].alert.createdByDetectionIdstringRequiredMay be null. Pattern: ^DET_[A-Z0-9]{1,7}$.
event[AlertQueued].alert.createdByDetectionNamestringRequiredMay be null.
event[AlertQueued].alert.primarySignalIdstringRequired
event[AlertQueued].alert.signalIdsarray of stringRequired
event[AlertQueued].alert.currentPriorityintegerRequiredMay be null. Minimum 1. Maximum 10.
event[AlertQueued].alert.summarystringRequired
event[AlertQueued].alert.playbookSnapshotstringRequiredMay be null.
event[AlertQueued].alert.accumulationKeyValuestringRequiredMay be null.
event[AlertQueued].alert.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[AlertQueued].alert.spaceIdstringRequiredPattern: ^SPC_[A-Z0-9]{1,7}$.
event[AlertQueued].alert.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[AlertQueued].alert.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[AlertQueued].alert.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[AlertQueued].alert.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[AlertQueued].alert.versionnumberRequired
event[AlertQueued].alert.primarySignalobjectOptionalNested fields omitted; see the schema in tools/list.
event[AlertQueued].alert.signalsarray of objectOptionalNested fields omitted; see the schema in tools/list.
event[AlertInitialScoreCompleted].typestringRequiredAlways AlertInitialScoreCompleted.
event[AlertInitialScoreCompleted].alertobjectRequired
event[AlertInitialScoreCompleted].alert.idstringRequiredPattern: ^ALR_[A-Z0-9]{1,7}$.
event[AlertInitialScoreCompleted].alert.namestringRequired
event[AlertInitialScoreCompleted].alert.statusenumRequiredOne of Queued, Accumulating, Processing, Promoted, Merged, Expired, TriageFailure.
event[AlertInitialScoreCompleted].alert.createdByDetectionIdstringRequiredMay be null. Pattern: ^DET_[A-Z0-9]{1,7}$.
event[AlertInitialScoreCompleted].alert.createdByDetectionNamestringRequiredMay be null.
event[AlertInitialScoreCompleted].alert.primarySignalIdstringRequired
event[AlertInitialScoreCompleted].alert.signalIdsarray of stringRequired
event[AlertInitialScoreCompleted].alert.currentPriorityintegerRequiredMay be null. Minimum 1. Maximum 10.
event[AlertInitialScoreCompleted].alert.summarystringRequired
event[AlertInitialScoreCompleted].alert.playbookSnapshotstringRequiredMay be null.
event[AlertInitialScoreCompleted].alert.accumulationKeyValuestringRequiredMay be null.
event[AlertInitialScoreCompleted].alert.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[AlertInitialScoreCompleted].alert.spaceIdstringRequiredPattern: ^SPC_[A-Z0-9]{1,7}$.
event[AlertInitialScoreCompleted].alert.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[AlertInitialScoreCompleted].alert.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[AlertInitialScoreCompleted].alert.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[AlertInitialScoreCompleted].alert.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[AlertInitialScoreCompleted].alert.versionnumberRequired
event[AlertInitialScoreCompleted].alert.primarySignalobjectOptionalNested fields omitted; see the schema in tools/list.
event[AlertInitialScoreCompleted].alert.signalsarray of objectOptionalNested fields omitted; see the schema in tools/list.
event[AlertPromoted].typestringRequiredAlways AlertPromoted.
event[AlertPromoted].alertobjectRequired
event[AlertPromoted].alert.idstringRequiredPattern: ^ALR_[A-Z0-9]{1,7}$.
event[AlertPromoted].alert.namestringRequired
event[AlertPromoted].alert.statusenumRequiredOne of Queued, Accumulating, Processing, Promoted, Merged, Expired, TriageFailure.
event[AlertPromoted].alert.createdByDetectionIdstringRequiredMay be null. Pattern: ^DET_[A-Z0-9]{1,7}$.
event[AlertPromoted].alert.createdByDetectionNamestringRequiredMay be null.
event[AlertPromoted].alert.primarySignalIdstringRequired
event[AlertPromoted].alert.signalIdsarray of stringRequired
event[AlertPromoted].alert.currentPriorityintegerRequiredMay be null. Minimum 1. Maximum 10.
event[AlertPromoted].alert.summarystringRequired
event[AlertPromoted].alert.playbookSnapshotstringRequiredMay be null.
event[AlertPromoted].alert.accumulationKeyValuestringRequiredMay be null.
event[AlertPromoted].alert.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[AlertPromoted].alert.spaceIdstringRequiredPattern: ^SPC_[A-Z0-9]{1,7}$.
event[AlertPromoted].alert.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[AlertPromoted].alert.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[AlertPromoted].alert.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[AlertPromoted].alert.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[AlertPromoted].alert.versionnumberRequired
event[AlertPromoted].alert.primarySignalobjectOptionalNested fields omitted; see the schema in tools/list.
event[AlertPromoted].alert.signalsarray of objectOptionalNested fields omitted; see the schema in tools/list.
event[AlertPromoted].caseIdstringRequiredPattern: ^CAS_[A-Z0-9]{1,7}$.
event[AlertPromoted].promotedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[AlertExpired].typestringRequiredAlways AlertExpired.
event[AlertExpired].alertobjectRequired
event[AlertExpired].alert.idstringRequiredPattern: ^ALR_[A-Z0-9]{1,7}$.
event[AlertExpired].alert.namestringRequired
event[AlertExpired].alert.statusenumRequiredOne of Queued, Accumulating, Processing, Promoted, Merged, Expired, TriageFailure.
event[AlertExpired].alert.createdByDetectionIdstringRequiredMay be null. Pattern: ^DET_[A-Z0-9]{1,7}$.
event[AlertExpired].alert.createdByDetectionNamestringRequiredMay be null.
event[AlertExpired].alert.primarySignalIdstringRequired
event[AlertExpired].alert.signalIdsarray of stringRequired
event[AlertExpired].alert.currentPriorityintegerRequiredMay be null. Minimum 1. Maximum 10.
event[AlertExpired].alert.summarystringRequired
event[AlertExpired].alert.playbookSnapshotstringRequiredMay be null.
event[AlertExpired].alert.accumulationKeyValuestringRequiredMay be null.
event[AlertExpired].alert.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[AlertExpired].alert.spaceIdstringRequiredPattern: ^SPC_[A-Z0-9]{1,7}$.
event[AlertExpired].alert.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[AlertExpired].alert.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[AlertExpired].alert.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[AlertExpired].alert.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[AlertExpired].alert.versionnumberRequired
event[AlertExpired].alert.primarySignalobjectOptionalNested fields omitted; see the schema in tools/list.
event[AlertExpired].alert.signalsarray of objectOptionalNested fields omitted; see the schema in tools/list.
event[AlertTriageFailure].typestringRequiredAlways AlertTriageFailure.
event[AlertTriageFailure].alertobjectRequired
event[AlertTriageFailure].alert.idstringRequiredPattern: ^ALR_[A-Z0-9]{1,7}$.
event[AlertTriageFailure].alert.namestringRequired
event[AlertTriageFailure].alert.statusenumRequiredOne of Queued, Accumulating, Processing, Promoted, Merged, Expired, TriageFailure.
event[AlertTriageFailure].alert.createdByDetectionIdstringRequiredMay be null. Pattern: ^DET_[A-Z0-9]{1,7}$.
event[AlertTriageFailure].alert.createdByDetectionNamestringRequiredMay be null.
event[AlertTriageFailure].alert.primarySignalIdstringRequired
event[AlertTriageFailure].alert.signalIdsarray of stringRequired
event[AlertTriageFailure].alert.currentPriorityintegerRequiredMay be null. Minimum 1. Maximum 10.
event[AlertTriageFailure].alert.summarystringRequired
event[AlertTriageFailure].alert.playbookSnapshotstringRequiredMay be null.
event[AlertTriageFailure].alert.accumulationKeyValuestringRequiredMay be null.
event[AlertTriageFailure].alert.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[AlertTriageFailure].alert.spaceIdstringRequiredPattern: ^SPC_[A-Z0-9]{1,7}$.
event[AlertTriageFailure].alert.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[AlertTriageFailure].alert.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[AlertTriageFailure].alert.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[AlertTriageFailure].alert.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[AlertTriageFailure].alert.versionnumberRequired
event[AlertTriageFailure].alert.primarySignalobjectOptionalNested fields omitted; see the schema in tools/list.
event[AlertTriageFailure].alert.signalsarray of objectOptionalNested fields omitted; see the schema in tools/list.
event[AlertTriageFailure].reasonstringRequiredMay be null. At most 4000 characters.
event[CaseNewAlertEvidenceAttached].typestringRequiredAlways CaseNewAlertEvidenceAttached.
event[CaseNewAlertEvidenceAttached].caseobjectRequired
event[CaseNewAlertEvidenceAttached].case.idstringRequiredPattern: ^CAS_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].case.namestringRequiredMust not be empty.
event[CaseNewAlertEvidenceAttached].case.statusenumRequiredOne of Open, On-Hold, Closed.
event[CaseNewAlertEvidenceAttached].case.closureCodeenumRequiredOne of True Positive - Suspicious Activity, Benign Positive - Suspicious But Expected, False Positive - Incorrect Detection Logic, False Positive - Inaccurate Data, Other, Testing. May be null.
event[CaseNewAlertEvidenceAttached].case.suggestedClosureCodeenumRequiredOne of True Positive - Suspicious Activity, Benign Positive - Suspicious But Expected, False Positive - Incorrect Detection Logic, False Positive - Inaccurate Data, Other, Testing. May be null.
event[CaseNewAlertEvidenceAttached].case.suggestedClosureCodeDismissedbooleanRequired
event[CaseNewAlertEvidenceAttached].case.typeIdintegerRequiredMay be null. Greater than 0.
event[CaseNewAlertEvidenceAttached].case.severityIdintegerRequiredMay be null. Greater than 0.
event[CaseNewAlertEvidenceAttached].case.phaseIdintegerRequiredGreater than 0.
event[CaseNewAlertEvidenceAttached].case.assignedToUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].case.summarystringRequired
event[CaseNewAlertEvidenceAttached].case.entitiesarray of objectRequiredNested fields omitted; see the schema in tools/list.
event[CaseNewAlertEvidenceAttached].case.createdByDetectionIdstringRequiredMay be null. Pattern: ^DET_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].case.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].case.spaceIdstringRequiredPattern: ^SPC_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].case.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseNewAlertEvidenceAttached].case.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].case.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseNewAlertEvidenceAttached].case.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].case.versionnumberRequired
event[CaseNewAlertEvidenceAttached].case.timeToDetectMsintegerRequiredMay be null. Minimum 0.
event[CaseNewAlertEvidenceAttached].case.timeToInvestigateMsintegerRequiredMay be null. Minimum 0.
event[CaseNewAlertEvidenceAttached].case.timeToContainMsintegerRequiredMay be null. Minimum 0.
event[CaseNewAlertEvidenceAttached].case.timeToEradicateMsintegerRequiredMay be null. Minimum 0.
event[CaseNewAlertEvidenceAttached].case.timeToResolveMsintegerRequiredMay be null. Minimum 0.
event[CaseNewAlertEvidenceAttached].case.initialAnalysisStatusenumRequiredOne of PENDING, IN_PROGRESS, PARTIAL, COMPLETED, FAILED, SKIPPED, STOPPED.
event[CaseNewAlertEvidenceAttached].case.initialAnalysisCompletedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseNewAlertEvidenceAttached].case.closedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseNewAlertEvidenceAttached].case.closedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].case.closedByChatIdstringRequiredMay be null. Pattern: ^CHT_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].case.analysisSkippedReasonenumOptionalOne of QuotaExceeded, BudgetExhausted, PromoteAllConfigured, UserRequested, RateLimited, AutomaticAnalysisDisabled. May be null.
event[CaseNewAlertEvidenceAttached].case.analysisStoppedReasonenumRequiredOne of QuotaExceeded. May be null.
event[CaseNewAlertEvidenceAttached].case.blocksarray of object (five variants)RequiredNested fields omitted; see the schema in tools/list.
event[CaseNewAlertEvidenceAttached].alertobjectRequired
event[CaseNewAlertEvidenceAttached].alert.idstringRequiredPattern: ^ALR_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].alert.namestringRequired
event[CaseNewAlertEvidenceAttached].alert.statusenumRequiredOne of Queued, Accumulating, Processing, Promoted, Merged, Expired, TriageFailure.
event[CaseNewAlertEvidenceAttached].alert.createdByDetectionIdstringRequiredMay be null. Pattern: ^DET_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].alert.createdByDetectionNamestringRequiredMay be null.
event[CaseNewAlertEvidenceAttached].alert.primarySignalIdstringRequired
event[CaseNewAlertEvidenceAttached].alert.signalIdsarray of stringRequired
event[CaseNewAlertEvidenceAttached].alert.currentPriorityintegerRequiredMay be null. Minimum 1. Maximum 10.
event[CaseNewAlertEvidenceAttached].alert.summarystringRequired
event[CaseNewAlertEvidenceAttached].alert.playbookSnapshotstringRequiredMay be null.
event[CaseNewAlertEvidenceAttached].alert.accumulationKeyValuestringRequiredMay be null.
event[CaseNewAlertEvidenceAttached].alert.organizationIdstringRequiredPattern: ^ORG_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].alert.spaceIdstringRequiredPattern: ^SPC_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].alert.createdAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseNewAlertEvidenceAttached].alert.createdByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].alert.updatedAtstringRequiredJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
event[CaseNewAlertEvidenceAttached].alert.updatedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
event[CaseNewAlertEvidenceAttached].alert.versionnumberRequired
event[CaseNewAlertEvidenceAttached].alert.primarySignalobjectOptionalNested fields omitted; see the schema in tools/list.
event[CaseNewAlertEvidenceAttached].alert.signalsarray of objectOptionalNested fields omitted; see the schema in tools/list.
event[CaseNewAlertEvidenceAttached].promotedByUserIdstringRequiredMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
propertiesobjectOptional
validateBodyAsJsonbooleanOptional

Outputs​

FieldTypeDescription
configobject
config.headersmap of string
config.methodenumOne of GET, POST, PUT, PATCH, DELETE.
config.bodystring
config.urlstringMust not be empty.
bodyJsonValidationobject
bodyJsonValidation.validboolean
bodyJsonValidation.errorstring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

create-skill​

Create a skill.

Creates a new skill, staging the change in a draft changeset.

Creates the resource in the active chat's space or, when contentPackId is set, in that content pack.

Content-pack skills are organization-scoped and cannot have a folder.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
descriptionstringRequired
instructionsstringRequired
argumentHintstringOptionalMay be null. At most 1000 characters.
folderPathstringOptional
namestringRequiredPattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$. Must not be empty. At most 64 characters.
disableModelInvocationbooleanOptional
userInvocablebooleanOptional
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
idstringThe ID of the created skill.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

update-skill​

Update a skill.

Updates an existing skill (its name, description, instructions, argument hint, invocation flags, or folder), staging the change in a draft changeset. Set contentPackId when updating a content-pack skill; pack skills cannot have a folder. Read the skill first with get-resource to see its current instructions before editing.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
descriptionstringOptional
instructionsstringOptional
argumentHintstringOptionalMay be null. At most 1000 characters.
folderPathstringOptional
namestringOptionalPattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$. Must not be empty. At most 64 characters.
baseVersionintegerOptional
disableModelInvocationbooleanOptional
userInvocablebooleanOptional
skillIdstringRequiredThe ID of the skill to update. Pattern: ^SKL_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
skillobject (two variants)
skill[variant 1].idstringPattern: ^SKL_[A-Z0-9]{1,7}$.
skill[variant 1].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
skill[variant 1].spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
skill[variant 1].namestring
skill[variant 1].descriptionstring
skill[variant 1].instructionsstring
skill[variant 1].disableModelInvocationboolean
skill[variant 1].userInvocableboolean
skill[variant 1].argumentHintstringMay be null. At most 1000 characters.
skill[variant 1].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
skill[variant 1].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
skill[variant 1].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
skill[variant 1].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
skill[variant 1].folderIdstringMay be null.
skill[variant 1].folderPathstring
skill[variant 1].readOnlyboolean
skill[variant 1].installedFromobject (two variants)May be null.
skill[variant 1].installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
skill[variant 1].installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
skill[variant 1].installedFrom[variant 1].templateIdstring
skill[variant 1].installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
skill[variant 1].installedFrom[variant 2].linkModeenumOne of Copy.
skill[variant 1].installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
skill[variant 1].installedFromPackobject
skill[variant 1].installedFromPack.idstringPattern: ^PAK_[A-Z0-9]{1,7}$.
skill[variant 1].installedFromPack.namestring
skill[variant 1].installedFromPack.linkModeenumOne of Manual, Copy, Automatic.
skill[variant 1].versionintegerMay be null. Greater than 0.
skill[variant 1].deletedbooleanDefaults to false.
skill[variant 1].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
skill[variant 1].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
skill[variant 1].originKeystringMay be null.
skill[variant 2].idstringPattern: ^SKL_[A-Z0-9]{1,7}$.
skill[variant 2].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
skill[variant 2].namestring
skill[variant 2].descriptionstring
skill[variant 2].instructionsstring
skill[variant 2].disableModelInvocationboolean
skill[variant 2].userInvocableboolean
skill[variant 2].argumentHintstringMay be null. At most 1000 characters.
skill[variant 2].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
skill[variant 2].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
skill[variant 2].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
skill[variant 2].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
skill[variant 2].folderIdstringMay be null.
skill[variant 2].folderPathstring
skill[variant 2].readOnlyboolean
skill[variant 2].installedFromPackobject
skill[variant 2].installedFromPack.idstringPattern: ^PAK_[A-Z0-9]{1,7}$.
skill[variant 2].installedFromPack.namestring
skill[variant 2].installedFromPack.linkModeenumOne of Manual, Copy, Automatic.
skill[variant 2].versionintegerMay be null. Greater than 0.
skill[variant 2].deletedbooleanDefaults to false.
skill[variant 2].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
skill[variant 2].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
skill[variant 2].originKeystringMay be null.
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.

delete-skill​

Delete a skill.

Deletes a skill, staging the change in a draft changeset. Set contentPackId when deleting a content-pack skill.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
skillIdstringRequiredThe ID of the skill to delete. Pattern: ^SKL_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional

Outputs​

FieldTypeDescription
changesetIdstringThe exact changeset containing this mutation. Pattern: ^CHG_[A-Z0-9]{1,7}$.
validationobject
validation.validboolean
validation.errorsarray of object
validation.errors[].resourceIdstring
validation.errors[].resourceKindstring
validation.errors[].resourceNamestring
validation.errors[].messagestring
validation.errors[].fieldstring
linksarray of object (three variants)
links[][resource].typestringAlways resource.
links[][resource].idstring
links[][resource].resourceKindenumOne of CaseAlertBlock, Alert, AiProvider, Case, CaseAnalysisBlock, CaseLogBlock, CaseNoteBlock, CaseResponseActionBlock, Changeset, Chat, Comment, Connector, ContentPack, ContentPackInstallation, ContentWorkItem, Credential, Dashboard, DataPlane, Detection, Folder, HttpToolConfig, Integration, Lookup, Mapper, McpConfig, Organization, Parser, ResourceGroup, Role, Schema, Skill, Space, Table, ThreatReport, Union, User, View, WebhookConfig.
links[][resource].linkstringCanonical URL for this result. Format: uri.
links[][changeset].typestringAlways changeset.
links[][changeset].idstring
links[][changeset].linkstringCanonical URL for this result. Format: uri.
links[][query].typestringAlways query.
links[][query].idstring
links[][query].linkstringCanonical URL for this result. Format: uri.