Skip to main content

Deployable content tools

The MCP tools that create, update, delete, list, and validate deployable content: detections, integrations, integration parsers, integration mappers, and lookups.

Each of the five kinds carries a create, update, and delete tool named for the kind, and detections and integrations carry a list tool. A write takes an optional changesetId, and a write with a contentPackId argument can target a content pack instead of a Space. validate-detection-deployment checks a detection query against the deployment requirements without writing anything.

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-detection​

Create a detection.

Creates a new detection in Perpetual. A detection is a rule that can monitor data and trigger alerts or signals.

AI-created detections use a default 1-hour maximum latency. You can choose 1-hour or 1-day latency; the 15-minute option is only available to humans when enabled for the organization.

Omit folderPath to create at the root. A nonempty folderPath must already exist in the target space or content pack; this tool does not create folders. Use search-resources and get-resource to verify a folder before supplying its full path.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringRequiredThe detection name (max 256 characters). At most 256 characters.
descriptionstringRequiredMay be null. At most 100000 characters.
maturityenumRequiredOne of EXPERIMENTAL, TEST, STABLE, DEPRECATED.
levelenumRequiredOne of INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL.
typeenumRequiredThe detection type (required, only QUERY is supported currently). One of QUERY, SCENARIO.
querystringRequiredThe Hamelin query for the detection (max 1,000,000 characters). At most 1000000 characters.
createCasebooleanOptionalWhether to create a case for the detection. Defaults to false.
startsAtstringOptionalJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
retentionDaysintegerOptionalMay be null. Greater than 0.
playbookstringOptionalMay be null. At most 10000 characters.
minimumPriorityintegerOptionalMay be null. Minimum 1. Maximum 10.
accumulationKeyarray of stringOptionalMay be null.
archivedbooleanOptionalDefaults to false.
implementsContentWorkItemIdsarray of stringOptional
folderPathstringOptional
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
maximumLatencyenumOptionalOne of MAX_1H, MAX_1D.
spaceIdstringOptionalPattern: ^SPC_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.
deploybooleanOptional

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 detection.
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-detection​

Update a detection.

Updates an existing detection's fields such as name, description, query, maturity, level, type, deploy status, and other properties. Use this tool when the user wants to modify properties of an existing detection.

You can set maximum latency to 1-hour or 1-day. The 15-minute option is only available to humans when enabled for the organization.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringOptionalThe detection name (max 256 characters). At most 256 characters.
descriptionstringOptionalMay be null. At most 100000 characters.
maturityenumOptionalOne of EXPERIMENTAL, TEST, STABLE, DEPRECATED.
levelenumOptionalOne of INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL.
typeenumOptionalThe detection type (required, only QUERY is supported currently). One of QUERY, SCENARIO.
querystringOptionalThe Hamelin query for the detection (max 1,000,000 characters). At most 1000000 characters.
deploybooleanOptionalWhether to deploy the detection (required). It should only be set to true if the user explicitly asks it to be deployed.
createCasebooleanOptionalWhether to create a case for the detection.
startsAtstringOptionalJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
retentionDaysintegerOptionalMay be null. Greater than 0.
playbookstringOptionalMay be null. At most 10000 characters.
minimumPriorityintegerOptionalMay be null. Minimum 1. Maximum 10.
accumulationKeyarray of stringOptionalMay be null.
archivedbooleanOptional
implementsContentWorkItemIdsarray of stringOptional
folderPathstringOptional
maximumLatencyenumOptionalOne of MAX_1H, MAX_1D.
detectionIdstringRequiredThe ID of the detection to update.
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
detectionobject (two variants)
detection[variant 1].namestringThe detection name (max 256 characters). At most 256 characters.
detection[variant 1].descriptionstringMay be null. At most 100000 characters.
detection[variant 1].maturityenumOne of EXPERIMENTAL, TEST, STABLE, DEPRECATED.
detection[variant 1].levelenumOne of INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL.
detection[variant 1].typeenumThe detection type (required, only QUERY is supported currently). One of QUERY, SCENARIO.
detection[variant 1].querystringThe Hamelin query for the detection (max 1,000,000 characters). At most 1000000 characters.
detection[variant 1].maximumLatencyenumOne of MAX_1H, MAX_1D, MAX_15M.
detection[variant 1].deploybooleanWhether to deploy the detection (required). It should only be set to true if the user explicitly asks it to be deployed.
detection[variant 1].createCasebooleanWhether to create a case for the detection.
detection[variant 1].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
detection[variant 1].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
detection[variant 1].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
detection[variant 1].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
detection[variant 1].startsAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
detection[variant 1].archivedboolean
detection[variant 1].retentionDaysintegerMay be null. Greater than 0.
detection[variant 1].playbookstringMay be null. At most 10000 characters.
detection[variant 1].minimumPriorityintegerMay be null. Minimum 1. Maximum 10.
detection[variant 1].accumulationKeyarray of stringMay be null.
detection[variant 1].versionintegerMay be null. Greater than 0.
detection[variant 1].deletedbooleanDefaults to false.
detection[variant 1].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
detection[variant 1].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
detection[variant 1].idstringPattern: ^DET_[A-Z0-9]{1,7}$.
detection[variant 1].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
detection[variant 1].viewobject
detection[variant 1].view.idstringPattern: ^VIE_[A-Z0-9]{1,7}$.
detection[variant 1].view.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
detection[variant 1].view.statusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
detection[variant 1].view.lastMaterializedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
detection[variant 1].tableobject
detection[variant 1].table.idstringPattern: ^TBL_[A-Z0-9]{1,7}$.
detection[variant 1].table.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
detection[variant 1].table.statusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
detection[variant 1].table.lastMaterializedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
detection[variant 1].deploymentStatusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
detection[variant 1].folderIdstringMay be null. Pattern: ^FLD_[A-Z0-9]{1,7}$.
detection[variant 1].folderPathstring
detection[variant 1].spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
detection[variant 1].installedFromPackobject
detection[variant 1].installedFromPack.idstringPattern: ^PAK_[A-Z0-9]{1,7}$.
detection[variant 1].installedFromPack.namestring
detection[variant 1].installedFromPack.linkModeenumOne of Manual, Copy, Automatic.
detection[variant 1].installedFromobject (two variants)May be null.
detection[variant 1].installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
detection[variant 1].installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
detection[variant 1].installedFrom[variant 1].templateIdstring
detection[variant 1].installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
detection[variant 1].installedFrom[variant 2].linkModeenumOne of Copy.
detection[variant 1].installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
detection[variant 1].readOnlybooleanWhether this detection is read-only (e.g. installed from a content pack).
detection[variant 1].originKeystringMay be null.
detection[variant 2].namestringThe detection name (max 256 characters). At most 256 characters.
detection[variant 2].descriptionstringMay be null. At most 100000 characters.
detection[variant 2].maturityenumOne of EXPERIMENTAL, TEST, STABLE, DEPRECATED.
detection[variant 2].levelenumOne of INFORMATIONAL, LOW, MEDIUM, HIGH, CRITICAL.
detection[variant 2].typeenumThe detection type (required, only QUERY is supported currently). One of QUERY, SCENARIO.
detection[variant 2].querystringThe Hamelin query for the detection (max 1,000,000 characters). At most 1000000 characters.
detection[variant 2].maximumLatencyenumOne of MAX_1H, MAX_1D, MAX_15M.
detection[variant 2].createCasebooleanWhether to create a case for the detection.
detection[variant 2].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
detection[variant 2].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
detection[variant 2].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
detection[variant 2].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
detection[variant 2].startsAtstringJavaScript Date or other runtime timestamp in tool results. May be null. Format: date-time. Constrained by a pattern; see the schema in tools/list.
detection[variant 2].archivedboolean
detection[variant 2].retentionDaysintegerMay be null. Greater than 0.
detection[variant 2].playbookstringMay be null. At most 10000 characters.
detection[variant 2].minimumPriorityintegerMay be null. Minimum 1. Maximum 10.
detection[variant 2].accumulationKeyarray of stringMay be null.
detection[variant 2].versionintegerMay be null. Greater than 0.
detection[variant 2].deletedbooleanDefaults to false.
detection[variant 2].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
detection[variant 2].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
detection[variant 2].idstringPattern: ^DET_[A-Z0-9]{1,7}$.
detection[variant 2].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
detection[variant 2].folderIdstringMay be null. Pattern: ^FLD_[A-Z0-9]{1,7}$.
detection[variant 2].folderPathstring
detection[variant 2].installedFromPackobject
detection[variant 2].installedFromPack.idstringPattern: ^PAK_[A-Z0-9]{1,7}$.
detection[variant 2].installedFromPack.namestring
detection[variant 2].installedFromPack.linkModeenumOne of Manual, Copy, Automatic.
detection[variant 2].readOnlybooleanWhether this detection is read-only (e.g. installed from a content pack).
detection[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-detection​

Delete detection.

Deletes a detection. Use this tool when the user wants to permanently remove a detection.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
detectionIdstringRequiredThe ID of the detection to delete.
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
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.

list-detections​

List detections.

Lists detections with their IDs and names. Use filter, orderby, top, and skip to narrow, sort, and page — each parameter documents the fields and syntax it accepts. When contentPackId is set, the pack's contents are listed instead and filter/orderby are not supported. Use this tool to discover what detections are available before calling get-resource.

Annotations: readOnlyHint true, idempotentHint true.

Inputs​

FieldTypeRequiredDescription
filterstringOptional
orderbystringOptional
topintegerOptionalGreater than 0. Maximum 200. Defaults to 100.
skipintegerOptionalMinimum 0. Defaults to 0.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
detectionsarray of object
detections[].idstringThe detection ID.
detections[].namestringThe detection name.
totalCountintegerMinimum 0.
skipintegerMinimum 0.
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.

validate-detection-deployment​

Validate a detection query for deployment.

Validates a Hamelin query against all detection deployment requirements. This checks that the query compiles, conforms to the signal schema, is eligible for incremental analysis, and can calculate a deterministic event ID. Use this before creating a detection with deploy: true to catch deployment errors early.

Annotations: readOnlyHint true, idempotentHint true.

Inputs​

FieldTypeRequiredDescription
hamelinQuerystringRequiredThe Hamelin detection query to validate for deployment.
spaceIdstringRequiredThe ID of the space to target for this operation. Pattern: ^SPC_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
successbooleanWhether the detection query passes all deployment validations.
errorCountnumber
errorsarray of object
errors[].messagestring
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-integration​

Create integration.

Creates a new integration with the given name and optional settings. Use this tool when the user wants to set up a new data integration.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringRequired
retentionDaysintegerOptionalMay be null. Greater than 0.
folderPathstringOptional
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
spaceIdstringOptionalPattern: ^SPC_[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
integrationobject (two variants)
integration[variant 1].idstringPattern: ^INT_[A-Z0-9]{1,7}$.
integration[variant 1].namestring
integration[variant 1].viewIdstringMay be null.
integration[variant 1].viewNamestringMay be null.
integration[variant 1].defaultConnectorKindstringMay be null. Must not be empty.
integration[variant 1].statusenumOne of DEPLOYED, UNDEPLOYED, UPDATE_PENDING, FAILED, DEGRADED.
integration[variant 1].retentionDaysintegerMay be null. Greater than 0.
integration[variant 1].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
integration[variant 1].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
integration[variant 1].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
integration[variant 1].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
integration[variant 1].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
integration[variant 1].folderIdstringMay be null.
integration[variant 1].folderPathstring
integration[variant 1].spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
integration[variant 1].parsersarray of object
integration[variant 1].parsers[].idstringPattern: ^PRS_[A-Z0-9]{1,7}$.
integration[variant 1].parsers[].namestring
integration[variant 1].mappersarray of object
integration[variant 1].mappers[].idstringPattern: ^MPR_[A-Z0-9]{1,7}$.
integration[variant 1].mappers[].namestring
integration[variant 1].readOnlybooleanWhether this integration is read-only (e.g. installed from a content pack).
integration[variant 1].installedFromPackobject
integration[variant 1].installedFromPack.idstringPattern: ^PAK_[A-Z0-9]{1,7}$.
integration[variant 1].installedFromPack.namestring
integration[variant 1].installedFromPack.linkModeenumOne of Manual, Copy, Automatic.
integration[variant 1].installedFromobject (two variants)May be null.
integration[variant 1].installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
integration[variant 1].installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
integration[variant 1].installedFrom[variant 1].templateIdstring
integration[variant 1].installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
integration[variant 1].installedFrom[variant 2].linkModeenumOne of Copy.
integration[variant 1].installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
integration[variant 1].versionintegerMay be null. Greater than 0.
integration[variant 1].deletedbooleanDefaults to false.
integration[variant 1].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
integration[variant 1].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
integration[variant 1].originKeystringMay be null.
integration[variant 2].idstringPattern: ^INT_[A-Z0-9]{1,7}$.
integration[variant 2].namestring
integration[variant 2].viewNamestringMay be null.
integration[variant 2].defaultConnectorKindstringMay be null. Must not be empty.
integration[variant 2].retentionDaysintegerMay be null. Greater than 0.
integration[variant 2].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
integration[variant 2].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
integration[variant 2].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
integration[variant 2].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
integration[variant 2].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
integration[variant 2].folderIdstringMay be null.
integration[variant 2].folderPathstring
integration[variant 2].parsersarray of object
integration[variant 2].parsers[].idstringPattern: ^PRS_[A-Z0-9]{1,7}$.
integration[variant 2].parsers[].namestring
integration[variant 2].mappersarray of object
integration[variant 2].mappers[].idstringPattern: ^MPR_[A-Z0-9]{1,7}$.
integration[variant 2].mappers[].namestring
integration[variant 2].readOnlybooleanWhether this integration is read-only (e.g. installed from a content pack).
integration[variant 2].installedFromPackobject
integration[variant 2].installedFromPack.idstringPattern: ^PAK_[A-Z0-9]{1,7}$.
integration[variant 2].installedFromPack.namestring
integration[variant 2].installedFromPack.linkModeenumOne of Manual, Copy, Automatic.
integration[variant 2].versionintegerMay be null. Greater than 0.
integration[variant 2].deletedbooleanDefaults to false.
integration[variant 2].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
integration[variant 2].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
integration[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-integration​

Update integration.

Updates an existing integration's fields such as name, retention days, or view name. Use this tool when the user wants to modify properties of an existing integration.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringOptional
retentionDaysintegerOptionalMay be null. Greater than 0.
folderPathstringOptional
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional
integrationIdstringRequiredThe ID of the integration to update. Pattern: ^INT_[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
integrationobject (two variants)
integration[variant 1].idstringPattern: ^INT_[A-Z0-9]{1,7}$.
integration[variant 1].namestring
integration[variant 1].viewIdstringMay be null.
integration[variant 1].viewNamestringMay be null.
integration[variant 1].defaultConnectorKindstringMay be null. Must not be empty.
integration[variant 1].statusenumOne of DEPLOYED, UNDEPLOYED, UPDATE_PENDING, FAILED, DEGRADED.
integration[variant 1].retentionDaysintegerMay be null. Greater than 0.
integration[variant 1].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
integration[variant 1].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
integration[variant 1].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
integration[variant 1].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
integration[variant 1].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
integration[variant 1].folderIdstringMay be null.
integration[variant 1].folderPathstring
integration[variant 1].spaceIdstringPattern: ^SPC_[A-Z0-9]{1,7}$.
integration[variant 1].parsersarray of object
integration[variant 1].parsers[].idstringPattern: ^PRS_[A-Z0-9]{1,7}$.
integration[variant 1].parsers[].namestring
integration[variant 1].mappersarray of object
integration[variant 1].mappers[].idstringPattern: ^MPR_[A-Z0-9]{1,7}$.
integration[variant 1].mappers[].namestring
integration[variant 1].readOnlybooleanWhether this integration is read-only (e.g. installed from a content pack).
integration[variant 1].installedFromPackobject
integration[variant 1].installedFromPack.idstringPattern: ^PAK_[A-Z0-9]{1,7}$.
integration[variant 1].installedFromPack.namestring
integration[variant 1].installedFromPack.linkModeenumOne of Manual, Copy, Automatic.
integration[variant 1].installedFromobject (two variants)May be null.
integration[variant 1].installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
integration[variant 1].installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
integration[variant 1].installedFrom[variant 1].templateIdstring
integration[variant 1].installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
integration[variant 1].installedFrom[variant 2].linkModeenumOne of Copy.
integration[variant 1].installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
integration[variant 1].versionintegerMay be null. Greater than 0.
integration[variant 1].deletedbooleanDefaults to false.
integration[variant 1].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
integration[variant 1].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
integration[variant 1].originKeystringMay be null.
integration[variant 2].idstringPattern: ^INT_[A-Z0-9]{1,7}$.
integration[variant 2].namestring
integration[variant 2].viewNamestringMay be null.
integration[variant 2].defaultConnectorKindstringMay be null. Must not be empty.
integration[variant 2].retentionDaysintegerMay be null. Greater than 0.
integration[variant 2].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
integration[variant 2].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
integration[variant 2].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
integration[variant 2].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
integration[variant 2].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
integration[variant 2].folderIdstringMay be null.
integration[variant 2].folderPathstring
integration[variant 2].parsersarray of object
integration[variant 2].parsers[].idstringPattern: ^PRS_[A-Z0-9]{1,7}$.
integration[variant 2].parsers[].namestring
integration[variant 2].mappersarray of object
integration[variant 2].mappers[].idstringPattern: ^MPR_[A-Z0-9]{1,7}$.
integration[variant 2].mappers[].namestring
integration[variant 2].readOnlybooleanWhether this integration is read-only (e.g. installed from a content pack).
integration[variant 2].installedFromPackobject
integration[variant 2].installedFromPack.idstringPattern: ^PAK_[A-Z0-9]{1,7}$.
integration[variant 2].installedFromPack.namestring
integration[variant 2].installedFromPack.linkModeenumOne of Manual, Copy, Automatic.
integration[variant 2].versionintegerMay be null. Greater than 0.
integration[variant 2].deletedbooleanDefaults to false.
integration[variant 2].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
integration[variant 2].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
integration[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-integration​

Delete integration.

Deletes an integration and all its child parsers and mappers. Use this tool when the user wants to permanently remove an integration and all of its associated components.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
integrationIdstringRequiredThe ID of the integration to delete. Pattern: ^INT_[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
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.

list-integrations​

List integrations.

Lists integrations with their IDs, names, configuration status, parsers, and mappers. Use filter, orderby, top, and skip to narrow, sort, and page — each parameter documents the fields and syntax it accepts, which apply to the integration itself rather than to its nested parsers and mappers. When contentPackId is set, the pack's contents are listed instead and filter/orderby are not supported. Use this tool to discover integrations before calling get-resource.

Annotations: readOnlyHint true, idempotentHint true.

Inputs​

FieldTypeRequiredDescription
filterstringOptional
orderbystringOptional
topintegerOptionalGreater than 0. Maximum 200. Defaults to 100.
skipintegerOptionalMinimum 0. Defaults to 0.
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
contentPackIdstringOptionalPattern: ^PAK_[A-Z0-9]{1,7}$.

Outputs​

FieldTypeDescription
integrationsarray of object
integrations[].idstringThe integration ID.
integrations[].namestringThe integration name.
integrations[].statusstringThe configuration status of the integration (e.g. configured, unconfigured).
integrations[].parsersarray of object
integrations[].parsers[].idstringThe parser ID.
integrations[].parsers[].namestringThe parser name.
integrations[].mappersarray of object
integrations[].mappers[].idstringThe mapper ID.
integrations[].mappers[].namestringThe mapper name.
totalCountintegerMinimum 0.
skipintegerMinimum 0.
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-integration-parser​

Create integration parser.

Stages a new parser in the active changeset. Pass deploy: true on create unless the user asked otherwise.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringRequired
querystringRequiredAt most 1000000 characters.
deploybooleanOptional
connectorIdsarray of stringOptional
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional
integrationIdstringRequiredThe ID of the integration to create the parser in. Pattern: ^INT_[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
parserobject
parser.idstringPattern: ^PRS_[A-Z0-9]{1,7}$.
parser.namestring
parser.querystring
parser.deployboolean
parser.deploymentStatusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
parser.connectorIdsarray of string
parser.tableIdstringMay be null. Pattern: ^TBL_[A-Z0-9]{1,7}$.
parser.tableNamestringMay be null.
parser.organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
parser.createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
parser.createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
parser.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
parser.updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
parser.installedFromobject (two variants)May be null.
parser.installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
parser.installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
parser.installedFrom[variant 1].templateIdstring
parser.installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
parser.installedFrom[variant 2].linkModeenumOne of Copy.
parser.installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
parser.versionintegerMay be null. Greater than 0.
parser.deletedbooleanDefaults to false.
parser.changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
parser.changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
parser.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-integration-parser​

Update integration parser.

Updates an existing parser's fields such as name, query, connectors, or deployment settings. Use this tool when the user wants to modify properties of an existing integration parser.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringOptional
querystringOptionalAt most 1000000 characters.
deploybooleanOptional
connectorIdsarray of stringOptional
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional
integrationIdstringRequiredThe ID of the integration containing the parser. Pattern: ^INT_[A-Z0-9]{1,7}$.
parserIdstringRequiredThe ID of the parser to update. Pattern: ^PRS_[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
parserobject
parser.idstringPattern: ^PRS_[A-Z0-9]{1,7}$.
parser.namestring
parser.querystring
parser.deployboolean
parser.deploymentStatusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
parser.connectorIdsarray of string
parser.tableIdstringMay be null. Pattern: ^TBL_[A-Z0-9]{1,7}$.
parser.tableNamestringMay be null.
parser.organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
parser.createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
parser.createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
parser.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
parser.updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
parser.installedFromobject (two variants)May be null.
parser.installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
parser.installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
parser.installedFrom[variant 1].templateIdstring
parser.installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
parser.installedFrom[variant 2].linkModeenumOne of Copy.
parser.installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
parser.versionintegerMay be null. Greater than 0.
parser.deletedbooleanDefaults to false.
parser.changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
parser.changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
parser.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-integration-parser​

Delete integration parser.

Deletes a parser from an integration. Use this tool when the user wants to permanently remove a specific parser from an integration.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
integrationIdstringRequiredThe ID of the integration containing the parser. Pattern: ^INT_[A-Z0-9]{1,7}$.
parserIdstringRequiredThe ID of the parser to delete. Pattern: ^PRS_[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
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-integration-mapper​

Create integration mapper.

Stages a new mapper in the active changeset.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringRequired
querystringRequiredAt most 1000000 characters.
deploybooleanOptional
parserIdsarray of stringOptional
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional
integrationIdstringRequiredThe ID of the integration to create the mapper in. Pattern: ^INT_[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
mapperobject
mapper.idstringPattern: ^MPR_[A-Z0-9]{1,7}$.
mapper.namestring
mapper.querystring
mapper.deployboolean
mapper.deploymentStatusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
mapper.parserIdsarray of string
mapper.organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
mapper.createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mapper.createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
mapper.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mapper.updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
mapper.installedFromobject (two variants)May be null.
mapper.installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
mapper.installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
mapper.installedFrom[variant 1].templateIdstring
mapper.installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
mapper.installedFrom[variant 2].linkModeenumOne of Copy.
mapper.installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
mapper.versionintegerMay be null. Greater than 0.
mapper.deletedbooleanDefaults to false.
mapper.changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
mapper.changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
mapper.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-integration-mapper​

Update integration mapper.

Updates an existing mapper's fields such as name, query, deployment settings, or associated parsers. Use this tool when the user wants to modify properties of an existing integration mapper.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringOptional
querystringOptionalAt most 1000000 characters.
deploybooleanOptional
parserIdsarray of stringOptional
changesetIdstringOptionalPattern: ^CHG_[A-Z0-9]{1,7}$.
baseVersionintegerOptional
integrationIdstringRequiredThe ID of the integration containing the mapper. Pattern: ^INT_[A-Z0-9]{1,7}$.
mapperIdstringRequiredThe ID of the mapper to update. Pattern: ^MPR_[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
mapperobject
mapper.idstringPattern: ^MPR_[A-Z0-9]{1,7}$.
mapper.namestring
mapper.querystring
mapper.deployboolean
mapper.deploymentStatusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
mapper.parserIdsarray of string
mapper.organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
mapper.createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mapper.createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
mapper.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
mapper.updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
mapper.installedFromobject (two variants)May be null.
mapper.installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
mapper.installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
mapper.installedFrom[variant 1].templateIdstring
mapper.installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
mapper.installedFrom[variant 2].linkModeenumOne of Copy.
mapper.installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
mapper.versionintegerMay be null. Greater than 0.
mapper.deletedbooleanDefaults to false.
mapper.changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
mapper.changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
mapper.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-integration-mapper​

Delete integration mapper.

Deletes a mapper from an integration. Use this tool when the user wants to permanently remove a specific mapper from an integration.

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
integrationIdstringRequiredThe ID of the integration containing the mapper. Pattern: ^INT_[A-Z0-9]{1,7}$.
mapperIdstringRequiredThe ID of the mapper to delete. Pattern: ^MPR_[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
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-lookup​

Create a lookup.

Creates a new lookup, 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.

A lookup whose query is FROM source is a Static (file-upload) lookup — after creating one, tell the user to upload a data file on the lookup's Uploads tab; any other query is a Computed lookup, fully created here.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringRequired
querystringRequiredAt most 1000000 characters.
sourceFormatenumOptionalOne of parsed_lines, csv.
deploybooleanRequiredWhether the lookup is deployed. A deployed lookup has a backing dataset that queries can join against.
archivedbooleanOptionalDefaults to false.
keyColumnsarray of stringOptionalDefaults to [].
folderPathstringRequired
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 lookup.
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-lookup​

Update a lookup.

Updates an existing lookup (name, query, key columns, source format, deploy, or folder), staging the change in a draft changeset. The Static/Computed variant is fixed at creation and cannot change.

Annotations: readOnlyHint false, destructiveHint false, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
namestringOptional
querystringOptionalAt most 1000000 characters.
sourceFormatenumOptionalOne of parsed_lines, csv.
deploybooleanOptionalWhether the lookup is deployed. A deployed lookup has a backing dataset that queries can join against.
archivedbooleanOptional
keyColumnsarray of stringOptional
folderPathstringOptional
baseVersionintegerOptional
lookupIdstringRequiredThe ID of the lookup to update. Pattern: ^LKP_[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
lookupobject (two variants)
lookup[variant 1].idstringPattern: ^LKP_[A-Z0-9]{1,7}$.
lookup[variant 1].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
lookup[variant 1].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
lookup[variant 1].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
lookup[variant 1].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
lookup[variant 1].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
lookup[variant 1].spaceIdstringMay be null. Pattern: ^SPC_[A-Z0-9]{1,7}$.
lookup[variant 1].deploymentStatusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
lookup[variant 1].namestringThe lookup's freeform display name. The backing dataset's schema.name is derived from this server-side.
lookup[variant 1].querystringAt most 1000000 characters.
lookup[variant 1].sourceFormatenumOne of parsed_lines, csv.
lookup[variant 1].deploybooleanWhether the lookup is deployed. A deployed lookup has a backing dataset that queries can join against.
lookup[variant 1].archivedboolean
lookup[variant 1].keyColumnsarray of string
lookup[variant 1].folderIdstringMay be null.
lookup[variant 1].folderPathstring
lookup[variant 1].tableobjectMay be null.
lookup[variant 1].table.idstring
lookup[variant 1].table.resourceKindenumOne of Table, View.
lookup[variant 1].table.namestringConstrained by a pattern; see the schema in tools/list.
lookup[variant 1].table.updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
lookup[variant 1].table.deploymentStatusenumOne of UNDEPLOYED, DEPLOYED, FAILED, DEGRADED, DEPLOY_PENDING, DEPLOY_IN_PROGRESS, UPDATE_PENDING, UPDATE_IN_PROGRESS, REFRESH_IN_PROGRESS, ARCHIVED, CLEANUP_PENDING, CLEANUP_IN_PROGRESS.
lookup[variant 1].table.statusenumOne of Online, UpdatePending, UpdateFailed, UpdateInProgress, DeployPending, DeployInProgress, DeployFailed, Degraded, Archived, RefreshPending, RefreshFailed, RefreshInProgress, CleanupPending, CleanupInProgress, CleanupFailed, CleanupSucceeded.
lookup[variant 1].table.statusDetailsobject
lookup[variant 1].table.lastMaterializedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
lookup[variant 1].table.lastAttemptedIngestionIdstringMay be null.
lookup[variant 1].table.sourceFormatenumOne of parsed_lines, csv.
lookup[variant 1].table.keyColumnsarray of string
lookup[variant 1].readOnlybooleanWhether this lookup is read-only (e.g. installed from a content pack).
lookup[variant 1].installedFromPackobject
lookup[variant 1].installedFromPack.idstringPattern: ^PAK_[A-Z0-9]{1,7}$.
lookup[variant 1].installedFromPack.namestring
lookup[variant 1].installedFromPack.linkModeenumOne of Manual, Copy, Automatic.
lookup[variant 1].installedFromobject (two variants)May be null.
lookup[variant 1].installedFrom[variant 1].linkModeenumOne of Manual, Automatic.
lookup[variant 1].installedFrom[variant 1].installationIdstringMay be null. Pattern: ^PKI_[A-Z0-9]{1,7}$.
lookup[variant 1].installedFrom[variant 1].templateIdstring
lookup[variant 1].installedFrom[variant 1].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
lookup[variant 1].installedFrom[variant 2].linkModeenumOne of Copy.
lookup[variant 1].installedFrom[variant 2].contentPackIdstringPattern: ^PAK_[A-Z0-9]{1,7}$.
lookup[variant 1].versionintegerMay be null. Greater than 0.
lookup[variant 1].deletedbooleanDefaults to false.
lookup[variant 1].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
lookup[variant 1].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
lookup[variant 1].originKeystringMay be null.
lookup[variant 2].idstringPattern: ^LKP_[A-Z0-9]{1,7}$.
lookup[variant 2].createdAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
lookup[variant 2].createdByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
lookup[variant 2].updatedAtstringJavaScript Date or other runtime timestamp in tool results. Format: date-time. Constrained by a pattern; see the schema in tools/list.
lookup[variant 2].updatedByUserIdstringMay be null. Pattern: ^USR_[A-Z0-9]{1,7}$.
lookup[variant 2].organizationIdstringPattern: ^ORG_[A-Z0-9]{1,7}$.
lookup[variant 2].namestringThe lookup's freeform display name. The backing dataset's schema.name is derived from this server-side.
lookup[variant 2].querystringAt most 1000000 characters.
lookup[variant 2].sourceFormatenumOne of parsed_lines, csv.
lookup[variant 2].archivedboolean
lookup[variant 2].keyColumnsarray of string
lookup[variant 2].folderIdstringMay be null.
lookup[variant 2].folderPathstring
lookup[variant 2].readOnlybooleanWhether this lookup is read-only (e.g. installed from a content pack).
lookup[variant 2].installedFromPackobject
lookup[variant 2].installedFromPack.idstringPattern: ^PAK_[A-Z0-9]{1,7}$.
lookup[variant 2].installedFromPack.namestring
lookup[variant 2].installedFromPack.linkModeenumOne of Manual, Copy, Automatic.
lookup[variant 2].versionintegerMay be null. Greater than 0.
lookup[variant 2].deletedbooleanDefaults to false.
lookup[variant 2].changesetIdstringMay be null. Pattern: ^CHG_[A-Z0-9]{1,7}$.
lookup[variant 2].changesetStatusenumOne of Unchanged, Added, Modified, Deleted. May be null.
lookup[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-lookup​

Delete a lookup.

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

Annotations: readOnlyHint false, destructiveHint true, idempotentHint false.

Inputs​

FieldTypeRequiredDescription
lookupIdstringRequiredThe ID of the lookup to delete. Pattern: ^LKP_[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.