The Google Cloud Security Operations API (Chronicle API) provides endpoints that help analysts investigate and mitigate security threats throughout their lifecycle.
- REST Resource: v1beta.projects.locations.instances
- REST Resource: v1beta.projects.locations.instances.dataAccessLabels
- REST Resource: v1beta.projects.locations.instances.dataAccessScopes
- REST Resource: v1beta.projects.locations.instances.entities
- REST Resource: v1beta.projects.locations.instances.events
- REST Resource: v1beta.projects.locations.instances.feedPacks
- REST Resource: v1beta.projects.locations.instances.feedServiceAccounts
- REST Resource: v1beta.projects.locations.instances.feedSourceTypeSchemas
- REST Resource: v1beta.projects.locations.instances.feedSourceTypeSchemas.logTypeSchemas
- REST Resource: v1beta.projects.locations.instances.feeds
- REST Resource: v1beta.projects.locations.instances.forwarders
- REST Resource: v1beta.projects.locations.instances.forwarders.collectors
- REST Resource: v1beta.projects.locations.instances.logTypes.logs
- REST Resource: v1beta.projects.locations.instances.operations
- REST Resource: v1beta.projects.locations.instances.referenceLists
- REST Resource: v1beta.projects.locations.instances.rules
- REST Resource: v1beta.projects.locations.instances.rules.deployments
- REST Resource: v1beta.projects.locations.instances.rules.retrohunts
- REST Resource: v1beta.projects.locations.instances.watchlists
- REST Resource: v1alpha.projects.locations.instances
- REST Resource: v1alpha.projects.locations.instances.alertGroupingRules
- REST Resource: v1alpha.projects.locations.instances.analytics
- REST Resource: v1alpha.projects.locations.instances.analytics.entities.analyticValues
- REST Resource: v1alpha.projects.locations.instances.announcements
- REST Resource: v1alpha.projects.locations.instances.bigQueryAccess
- REST Resource: v1alpha.projects.locations.instances.bigQueryExport
- REST Resource: v1alpha.projects.locations.instances.caseCloseDefinitions
- REST Resource: v1alpha.projects.locations.instances.caseQueueFilters
- REST Resource: v1alpha.projects.locations.instances.caseStageDefinitions
- REST Resource: v1alpha.projects.locations.instances.caseTagDefinitions
- REST Resource: v1alpha.projects.locations.instances.cases
- REST Resource: v1alpha.projects.locations.instances.cases.alerts.contextProperties
- REST Resource: v1alpha.projects.locations.instances.cases.alerts.customFieldValues
- REST Resource: v1alpha.projects.locations.instances.cases.caseAlerts
- REST Resource: v1alpha.projects.locations.instances.cases.caseAlerts.connectorEvents
- REST Resource: v1alpha.projects.locations.instances.cases.caseAlerts.involvedEntities
- REST Resource: v1alpha.projects.locations.instances.cases.caseComments
- REST Resource: v1alpha.projects.locations.instances.cases.caseWallRecords
- REST Resource: v1alpha.projects.locations.instances.cases.chatMessages
- REST Resource: v1alpha.projects.locations.instances.cases.chatMessages.attachments
- REST Resource: v1alpha.projects.locations.instances.cases.chatMessages.legacySoarUsers
- REST Resource: v1alpha.projects.locations.instances.cases.contextProperties
- REST Resource: v1alpha.projects.locations.instances.cases.customFieldValues
- REST Resource: v1alpha.projects.locations.instances.contentHub.contentPacks
- REST Resource: v1alpha.projects.locations.instances.contentHub.featuredContentNativeDashboards
- REST Resource: v1alpha.projects.locations.instances.contentHub.featuredContentRules
- REST Resource: v1alpha.projects.locations.instances.contentHub.featuredContentSearchQueries
- REST Resource: v1alpha.projects.locations.instances.contextProperties
- REST Resource: v1alpha.projects.locations.instances.coverageDetails
- REST Resource: v1alpha.projects.locations.instances.curatedRuleSetCategories
- REST Resource: v1alpha.projects.locations.instances.curatedRuleSetCategories.curatedRuleSets
- REST Resource: v1alpha.projects.locations.instances.curatedRuleSetCategories.curatedRuleSets.curatedRuleSetDeployments
- REST Resource: v1alpha.projects.locations.instances.curatedRules
- REST Resource: v1alpha.projects.locations.instances.customFields
- REST Resource: v1alpha.projects.locations.instances.customLists
- REST Resource: v1alpha.projects.locations.instances.dashboardCharts
- REST Resource: v1alpha.projects.locations.instances.dashboardQueries
- REST Resource: v1alpha.projects.locations.instances.dashboards
- REST Resource: v1alpha.projects.locations.instances.dataAccessLabels
- REST Resource: v1alpha.projects.locations.instances.dataAccessScopes
- REST Resource: v1alpha.projects.locations.instances.dataExports
- REST Resource: v1alpha.projects.locations.instances.dataTableOperationErrors
- REST Resource: v1alpha.projects.locations.instances.dataTables
- REST Resource: v1alpha.projects.locations.instances.dataTables.dataTableRows
- REST Resource: v1alpha.projects.locations.instances.dataTaps
- REST Resource: v1alpha.projects.locations.instances.dynamicParameters
- REST Resource: v1alpha.projects.locations.instances.emailTemplates
- REST Resource: v1alpha.projects.locations.instances.enrichmentControls
- REST Resource: v1alpha.projects.locations.instances.entities
- REST Resource: v1alpha.projects.locations.instances.entitiesBlocklists
- REST Resource: v1alpha.projects.locations.instances.entityRiskScores
- REST Resource: v1alpha.projects.locations.instances.environmentGroups
- REST Resource: v1alpha.projects.locations.instances.environments
- REST Resource: v1alpha.projects.locations.instances.errorNotificationConfigs
- REST Resource: v1alpha.projects.locations.instances.events
- REST Resource: v1alpha.projects.locations.instances.federationGroups
- REST Resource: v1alpha.projects.locations.instances.feedPacks
- REST Resource: v1alpha.projects.locations.instances.feedServiceAccounts
- REST Resource: v1alpha.projects.locations.instances.feedSourceTypeSchemas
- REST Resource: v1alpha.projects.locations.instances.feedSourceTypeSchemas.logTypeSchemas
- REST Resource: v1alpha.projects.locations.instances.feeds
- REST Resource: v1alpha.projects.locations.instances.findingsGraph
- REST Resource: v1alpha.projects.locations.instances.findingsRefinements
- REST Resource: v1alpha.projects.locations.instances.forwarders
- REST Resource: v1alpha.projects.locations.instances.forwarders.collectors
- REST Resource: v1alpha.projects.locations.instances.ingestionLogLabels
- REST Resource: v1alpha.projects.locations.instances.ingestionLogNamespaces
- REST Resource: v1alpha.projects.locations.instances.integrations
- REST Resource: v1alpha.projects.locations.instances.integrations.actions
- REST Resource: v1alpha.projects.locations.instances.integrations.actions.revisions
- REST Resource: v1alpha.projects.locations.instances.integrations.connectors
- REST Resource: v1alpha.projects.locations.instances.integrations.connectors.connectorInstances
- REST Resource: v1alpha.projects.locations.instances.integrations.connectors.connectorInstances.logs
- REST Resource: v1alpha.projects.locations.instances.integrations.connectors.contextProperties
- REST Resource: v1alpha.projects.locations.instances.integrations.connectors.revisions
- REST Resource: v1alpha.projects.locations.instances.integrations.integrationInstances
- REST Resource: v1alpha.projects.locations.instances.integrations.jobs
- REST Resource: v1alpha.projects.locations.instances.integrations.jobs.contextProperties
- REST Resource: v1alpha.projects.locations.instances.integrations.jobs.jobInstances
- REST Resource: v1alpha.projects.locations.instances.integrations.jobs.jobInstances.logs
- REST Resource: v1alpha.projects.locations.instances.integrations.jobs.revisions
- REST Resource: v1alpha.projects.locations.instances.integrations.managers
- REST Resource: v1alpha.projects.locations.instances.integrations.managers.revisions
- REST Resource: v1alpha.projects.locations.instances.investigations
- REST Resource: v1alpha.projects.locations.instances.investigations.investigationComments
- REST Resource: v1alpha.projects.locations.instances.investigations.investigationSteps
- REST Resource: v1alpha.projects.locations.instances.iocAssociations
- REST Resource: v1alpha.projects.locations.instances.iocs
- REST Resource: v1alpha.projects.locations.instances.labsExperiments
- REST Resource: v1alpha.projects.locations.instances.labsExperiments.executions
- REST Resource: v1alpha.projects.locations.instances.legacy
- REST Resource: v1alpha.projects.locations.instances.legacyCaseFederationPlatforms
- REST Resource: v1alpha.projects.locations.instances.legacyConfiguration
- REST Resource: v1alpha.projects.locations.instances.legacyFederatedCases
- REST Resource: v1alpha.projects.locations.instances.legacyPlaybooks
- REST Resource: v1alpha.projects.locations.instances.legacyPublisher
- REST Resource: v1alpha.projects.locations.instances.legacySdk
- REST Resource: v1alpha.projects.locations.instances.legacySoarAudit
- REST Resource: v1alpha.projects.locations.instances.legacySoarDashboard
- REST Resource: v1alpha.projects.locations.instances.legacySoarIdpMappingGroups
- REST Resource: v1alpha.projects.locations.instances.legacySoarSettings
- REST Resource: v1alpha.projects.locations.instances.legacySoarUsers
- REST Resource: v1alpha.projects.locations.instances.legacySoarUsers.attachments
- REST Resource: v1alpha.projects.locations.instances.legacySoarUsers.userNotifications
- REST Resource: v1alpha.projects.locations.instances.legacySoarUsers.workdeskContacts
- REST Resource: v1alpha.projects.locations.instances.legacySoarUsers.workdeskLinks
- REST Resource: v1alpha.projects.locations.instances.legacySoarUsers.workdeskNotes
- REST Resource: v1alpha.projects.locations.instances.legacySystem
- REST Resource: v1alpha.projects.locations.instances.legacySystemMetadata
- REST Resource: v1alpha.projects.locations.instances.logProcessingPipelines
- REST Resource: v1alpha.projects.locations.instances.logTypes
- REST Resource: v1alpha.projects.locations.instances.logTypes.logTypeSettings
- REST Resource: v1alpha.projects.locations.instances.logTypes.logs
- REST Resource: v1alpha.projects.locations.instances.logTypes.parserExtensions
- REST Resource: v1alpha.projects.locations.instances.logTypes.parserExtensions.extensionValidationReports
- REST Resource: v1alpha.projects.locations.instances.logTypes.parserExtensions.extensionValidationReports.validationErrors
- REST Resource: v1alpha.projects.locations.instances.logTypes.parserExtensions.validationReports
- REST Resource: v1alpha.projects.locations.instances.logTypes.parserExtensions.validationReports.parsingErrors
- REST Resource: v1alpha.projects.locations.instances.logTypes.parsers
- REST Resource: v1alpha.projects.locations.instances.logTypes.parsers.validationReports
- REST Resource: v1alpha.projects.locations.instances.logTypes.parsers.validationReports.parsingErrors
- REST Resource: v1alpha.projects.locations.instances.logs
- REST Resource: v1alpha.projects.locations.instances.marketplaceIntegrations
- REST Resource: v1alpha.projects.locations.instances.moduleSettings
- REST Resource: v1alpha.projects.locations.instances.moduleSettings.properties
- REST Resource: v1alpha.projects.locations.instances.nativeDashboards
- REST Resource: v1alpha.projects.locations.instances.notebooks
- REST Resource: v1alpha.projects.locations.instances.ontologyRecords
- REST Resource: v1alpha.projects.locations.instances.ontologyRecords.mappingRules
- REST Resource: v1alpha.projects.locations.instances.ontologyRecords.visualFamilies
- REST Resource: v1alpha.projects.locations.instances.operations
- REST Resource: v1alpha.projects.locations.instances.propertySchemaDefinitions
- REST Resource: v1alpha.projects.locations.instances.referenceLists
- REST Resource: v1alpha.projects.locations.instances.remoteAgents
- REST Resource: v1alpha.projects.locations.instances.requestTemplates
- REST Resource: v1alpha.projects.locations.instances.ruleExecutionErrors
- REST Resource: v1alpha.projects.locations.instances.rules
- REST Resource: v1alpha.projects.locations.instances.rules.deployments
- REST Resource: v1alpha.projects.locations.instances.rules.retrohunts
- REST Resource: v1alpha.projects.locations.instances.savedColumnSets
- REST Resource: v1alpha.projects.locations.instances.slaDefinitions
- REST Resource: v1alpha.projects.locations.instances.soarDomains
- REST Resource: v1alpha.projects.locations.instances.soarNetworks
- REST Resource: v1alpha.projects.locations.instances.socRoles
- REST Resource: v1alpha.projects.locations.instances.tasks
- REST Resource: v1alpha.projects.locations.instances.threatCollections
- REST Resource: v1alpha.projects.locations.instances.uniqueEntities
- REST Resource: v1alpha.projects.locations.instances.users
- REST Resource: v1alpha.projects.locations.instances.users.conversations
- REST Resource: v1alpha.projects.locations.instances.users.conversations.messages
- REST Resource: v1alpha.projects.locations.instances.users.savedColumnSets
- REST Resource: v1alpha.projects.locations.instances.users.searchQueries
- REST Resource: v1alpha.projects.locations.instances.watchlists
- REST Resource: v1alpha.projects.locations.instances.watchlists.entities
- REST Resource: v1alpha.projects.locations.instances.webhooks
- REST Resource: v1.projects.locations.instances
- REST Resource: v1.projects.locations.instances.dataAccessLabels
- REST Resource: v1.projects.locations.instances.dataAccessScopes
- REST Resource: v1.projects.locations.instances.operations
- REST Resource: v1.projects.locations.instances.referenceLists
- REST Resource: v1.projects.locations.instances.rules
- REST Resource: v1.projects.locations.instances.rules.deployments
- REST Resource: v1.projects.locations.instances.rules.retrohunts
- REST Resource: v1.projects.locations.instances.watchlists
Service: chronicle.googleapis.com
Service endpoint
A service endpoint is the base URL that specifies the network address of an API service. A single service can have multiple service endpoints. Chronicle is a regional service and only supports regional endpoints. Requests sent to the global chronicle.googleapis.com endpoint will fail with a `404` error. To find your regional endpoint, see Regional service endpoint.
Regional service endpoint
A regional service endpoint is a base URL that specifies the network address of an API service in a single region. A service that is available in multiple regions might have multiple regional endpoints. Select a location to see its regional service endpoint for this service.
https://chronicle.africa-south1.rep.googleapis.com  REST Resource: v1beta.projects.locations.instances
| Methods | |
|---|---|
| generateCollectionAgentAuth | POST /v1beta/{name}:generateCollectionAgentAuthGenerateCollectionAgentAuth generates an auth json file for the collection agent. | 
| get | GET /v1beta/{name}Gets a Instance. | 
REST Resource: v1beta.projects.locations.instances.dataAccessLabels
| Methods | |
|---|---|
| create | POST /v1beta/{parent}/dataAccessLabelsCreates a data access label. | 
| delete | DELETE /v1beta/{name}Deletes a data access label. | 
| get | GET /v1beta/{name}Gets a data access label. | 
| list | GET /v1beta/{parent}/dataAccessLabelsLists all data access labels for the customer. | 
| patch | PATCH /v1beta/{dataAccessLabel.name}Updates a data access label. | 
REST Resource: v1beta.projects.locations.instances.dataAccessScopes
| Methods | |
|---|---|
| create | POST /v1beta/{parent}/dataAccessScopesCreates a data access scope. | 
| delete | DELETE /v1beta/{name}Deletes a data access scope. | 
| get | GET /v1beta/{name}Retrieves an existing data access scope. | 
| list | GET /v1beta/{parent}/dataAccessScopesLists all existing data access scopes for the customer. | 
| patch | PATCH /v1beta/{dataAccessScope.name}Updates a data access scope. | 
REST Resource: v1beta.projects.locations.instances.entities
| Methods | |
|---|---|
| import | POST /v1beta/{parent}/entities:importImportEntities import the entities. | 
REST Resource: v1beta.projects.locations.instances.events
| Methods | |
|---|---|
| import | POST /v1beta/{parent}/events:importImportEvents import the events. | 
REST Resource: v1beta.projects.locations.instances.feedPacks
| Methods | |
|---|---|
| get | GET /v1beta/{name}Gets a feed pack. | 
| list | GET /v1beta/{parent}/feedPacksLists Packs for which feeds can be configured. | 
REST Resource: v1beta.projects.locations.instances.feedServiceAccounts
| Methods | |
|---|---|
| fetchServiceAccountForCustomer | GET /v1beta/{parent}/feedServiceAccounts:fetchServiceAccountForCustomerFetch Chronicle's service account used for ingesting data from Cloud Storage buckets. | 
REST Resource: v1beta.projects.locations.instances.feedSourceTypeSchemas
| Methods | |
|---|---|
| list | GET /v1beta/{parent}/feedSourceTypeSchemasList all FeedSourceTypeSchemas. | 
REST Resource: v1beta.projects.locations.instances.feedSourceTypeSchemas.logTypeSchemas
| Methods | |
|---|---|
| list | GET /v1beta/{parent}/logTypeSchemasList all LogTypeSchemas compatible with a given FeedSourceType. | 
REST Resource: v1beta.projects.locations.instances.feeds
| Methods | |
|---|---|
| create | POST /v1beta/{parent}/feedsCreates a feed. | 
| delete | DELETE /v1beta/{name}Deletes a feed. | 
| disable | POST /v1beta/{name}:disableDisable feed for ingestion. | 
| enable | POST /v1beta/{name}:enableEnable feed for ingestion. | 
| generateSecret | POST /v1beta/{name}:generateSecretGenerates a new secret for https push feeds which do not support jwt tokens. | 
| get | GET /v1beta/{name}Gets a feed. | 
| importPushLogs | POST /v1beta/{parent}:importPushLogsImport logs coming from https push feeds. | 
| list | GET /v1beta/{parent}/feedsLists all feeds for the customer. | 
| patch | PATCH /v1beta/{feed.name}Updates the full feed. | 
REST Resource: v1beta.projects.locations.instances.forwarders
| Methods | |
|---|---|
| create | POST /v1beta/{parent}/forwardersCreate a forwarder. | 
| delete | DELETE /v1beta/{name}Delete a forwarder by forwarder ID. | 
| generateForwarderFiles | GET /v1beta/{name}:generateForwarderFilesGenerates a forwarder's configuration files. | 
| get | GET /v1beta/{name}Get a forwarder by forwarder ID. | 
| importStatsEvents | POST /v1beta/{name}:importStatsEventsImportStatsEvents imports stats events from a forwarder. | 
| list | GET /v1beta/{parent}/forwardersList all forwarders for the instance. | 
| patch | PATCH /v1beta/{forwarder.name}Update a forwarder. | 
REST Resource: v1beta.projects.locations.instances.forwarders.collectors
| Methods | |
|---|---|
| create | POST /v1beta/{parent}/collectorsCreate a collector. | 
| delete | DELETE /v1beta/{name}Delete a collector by collector ID. | 
| get | GET /v1beta/{name}Get a collector by collector ID. | 
| list | GET /v1beta/{parent}/collectorsList all collectors for the forwarder. | 
| patch | PATCH /v1beta/{collector.name}Update a collector. | 
REST Resource: v1beta.projects.locations.instances.logTypes.logs
| Methods | |
|---|---|
| import | POST /v1beta/{parent}/logs:importImport log telemetry. | 
REST Resource: v1beta.projects.locations.instances.operations
| Methods | |
|---|---|
| cancel | POST /v1beta/{name}:cancelStarts asynchronous cancellation on a long-running operation. | 
| delete | DELETE /v1beta/{name}Deletes a long-running operation. | 
| get | GET /v1beta/{name}Gets the latest state of a long-running operation. | 
| list | GET /v1beta/{name}/operationsLists operations that match the specified filter in the request. | 
REST Resource: v1beta.projects.locations.instances.referenceLists
| Methods | |
|---|---|
| create | POST /v1beta/{parent}/referenceListsCreates a new reference list. | 
| get | GET /v1beta/{name}Gets a single reference list. | 
| list | GET /v1beta/{parent}/referenceListsLists a collection of reference lists. | 
| patch | PATCH /v1beta/{referenceList.name}Updates an existing reference list. | 
REST Resource: v1beta.projects.locations.instances.rules
| Methods | |
|---|---|
| create | POST /v1beta/{parent}/rulesCreates a new Rule. | 
| delete | DELETE /v1beta/{name}Deletes a Rule. | 
| get | GET /v1beta/{name}Gets a Rule. | 
| getDeployment | GET /v1beta/{name}Gets a RuleDeployment. | 
| list | GET /v1beta/{parent}/rulesLists Rules. | 
| listRevisions | GET /v1beta/{name}:listRevisionsLists all revisions of the rule. | 
| patch | PATCH /v1beta/{rule.name}Updates a Rule. | 
| updateDeployment | PATCH /v1beta/{ruleDeployment.name}Updates a RuleDeployment. | 
REST Resource: v1beta.projects.locations.instances.rules.deployments
| Methods | |
|---|---|
| list | GET /v1beta/{parent}/deploymentsLists RuleDeployments across all Rules. | 
REST Resource: v1beta.projects.locations.instances.rules.retrohunts
| Methods | |
|---|---|
| create | POST /v1beta/{parent}/retrohuntsCreate a Retrohunt. | 
| get | GET /v1beta/{name}Get a Retrohunt. | 
| list | GET /v1beta/{parent}/retrohuntsList Retrohunts. | 
REST Resource: v1beta.projects.locations.instances.watchlists
| Methods | |
|---|---|
| create | POST /v1beta/{parent}/watchlistsCreates a watchlist for the given instance. | 
| delete | DELETE /v1beta/{name}Deletes the watchlist for the given instance. | 
| get | GET /v1beta/{name}Gets watchlist details for the given watchlist ID. | 
| list | GET /v1beta/{parent}/watchlistsLists all watchlists for the given instance. | 
| patch | PATCH /v1beta/{watchlist.name}Updates the watchlist for the given instance. | 
REST Resource: v1alpha.projects.locations.instances
| Methods | |
|---|---|
| batchValidateWatchlistEntities | POST /v1alpha/{parent}:batchValidateWatchlistEntitiesValidates a batch of entities that could be added into watchlist under an instance. | 
| computeAllFindingsRefinementActivities | POST /v1alpha/{instance}:computeAllFindingsRefinementActivitiesReturns findings refinement activity for all findings refinements. | 
| continuePocGraduation | POST /v1alpha/{name}:continuePocGraduationContinuePocGraduation verifies and proceeds graduation. | 
| countAllCuratedRuleSetDetections | POST /v1alpha/{instance}:countAllCuratedRuleSetDetectionsCount detections across all curated rule sets. | 
| createFeedback | POST /v1alpha/{instance}:createFeedbackRPC to submit user feedback on content generated by AI services. | 
| delete | DELETE /v1alpha/{name}DeleteInstance deletes an Instance. | 
| extractSyslog | POST /v1alpha/{instance}:extractSyslogExtractSyslog extracts structured part of log from a unstructured log by running a grok regex over it. | 
| fetchFederationAccess | GET /v1alpha/{name}:fetchFederationAccessFetchFederationAccess method lists all the instances the authenticated user has access to and the operations they can perform over these instances. | 
| findEntity | GET /v1alpha/{instance}:findEntityIdentifies the entity type and retrieves relevant data associated with a specified indicator. | 
| findEntityAlerts | GET /v1alpha/{instance}:findEntityAlertsGet alerts for an entity | 
| findRelatedEntities | GET /v1alpha/{instance}:findRelatedEntitiesFinds all the entities associated with provided entity. | 
| findUdmFieldValues | GET /v1alpha/{instance}:findUdmFieldValuesFinds ingested UDM field values that match a query. | 
| generateCollectionAgentAuth | POST /v1alpha/{name}:generateCollectionAgentAuthGenerateCollectionAgentAuth generates an auth json file for the collection agent. | 
| generateSoarAuthJwt | POST /v1alpha/{name}:generateSoarAuthJwtGenerateSoarAuthJwt signs a jwt in order to proceed with jwt exchange based authenticate with soar. | 
| generateSoarChatMessage | POST /v1alpha/{instance}:generateSoarChatMessageGenerates a SOAR chat message based on the given intent. | 
| generateUdmKeyValueMappings | POST /v1alpha/{instance}:generateUdmKeyValueMappingsGenerateUDMKeyValueMappings generates key value mapping of a raw log. | 
| generateWorkspaceConnectionToken | POST /v1alpha/{name}:generateWorkspaceConnectionTokenGenerates a token that can be used to connect a workspace customer to a chronicle instance | 
| get | GET /v1alpha/{name}Gets a Instance. | 
| getBigQueryExport | GET /v1alpha/{name}Get the BigQuery export configuration for a Chronicle instance. | 
| getEnrichmentCombination | GET /v1alpha/{name}Get the EnrichmentCombination. | 
| getMultitenantDirectory | GET /v1alpha/{name}Gets the super and subtenants and gets the current tenant name. | 
| getRiskConfig | GET /v1alpha/{name}Queries the instance to get the Risk Configurations used for the computation of Entity Risk Score. | 
| getThreatCollectionFilterSet | GET /v1alpha/{name}Get the set of threat collection filter options. | 
| graduatePocInstance | POST /v1alpha/{name}:graduatePocInstanceGraduatePocInstance graduates an instance. | 
| legacyCaseFederationPlatforms | GET /v1alpha/{parent}/legacyCaseFederationPlatformsLegacy endpoint for listing case federation platforms. | 
| legacySystemMetadata | GET /v1alpha/{instance}/legacySystemMetadataLegacy Get System Metadata. | 
| listAllFindingsRefinementDeployments | GET /v1alpha/{instance}:listAllFindingsRefinementDeploymentsLists all findings refinement deployments. | 
| patch | PATCH /v1alpha/{instance.name}Updates an Instance. | 
| queryProductSourceStats | GET /v1alpha/{instance}:queryProductSourceStatsGets available product sources along with their stats. | 
| searchEntities | GET /v1alpha/{instance}:searchEntitiesIdentifies the entity type and retrieves relevant data associated with a specified indicator. | 
| searchRawLogs | POST /v1alpha/{instance}:searchRawLogsApi to get events, entities, or unparsed raw logs matching the given raw log query. | 
| submitResponseFeedback | POST /v1alpha/{instance}:submitResponseFeedbackSubmits a Response Feedback. | 
| summarizeEntitiesFromQuery | GET /v1alpha/{instance}:summarizeEntitiesFromQueryParses the query and identifies the entities contained within the search query. | 
| summarizeEntity | GET /v1alpha/{instance}:summarizeEntityReturns all entity data over specified time. | 
| testFindingsRefinement | POST /v1alpha/{instance}:testFindingsRefinementTests for and returns past activity for a findings refinement, including, potentially, times when the findings refinement was not yet created. | 
| translateUdmQuery | POST /v1alpha/{instance}:translateUdmQueryTranslate natural language to a UDM Search query. | 
| translateYlRule | POST /v1alpha/{instance}:translateYlRuleTranslate natural language to a Yara-L rule. | 
| udmSearch | GET /v1alpha/{instance}:udmSearchPerforms a UDM search that returns matching events for the query. | 
| undelete | POST /v1alpha/{name}:undeleteUndeleteInstance undeletes a soft-deleted Instance. | 
| updateBigQueryExport | PATCH /v1alpha/{bigQueryExport.name}Update the BigQuery export configuration for a Chronicle instance. | 
| updateRiskConfig | PATCH /v1alpha/{riskConfig.name}Updates RiskConfig used for the computation of Entity Risk Score. | 
| validateQuery | GET /v1alpha/{instance}:validateQueryValidates UDM search query by compiling the query. | 
| verifyNonce | POST /v1alpha/{name}:verifyNonceVerifies the nonce used to graduate an instance. | 
| verifyReferenceList | POST /v1alpha/{instance}:verifyReferenceListVerifyReferenceList validates list content and returns line errors, if any. | 
| verifyRuleText | POST /v1alpha/{instance}:verifyRuleTextVerifies the given rule text. | 
REST Resource: v1alpha.projects.locations.instances.alertGroupingRules
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/alertGroupingRulesCreate a AlertGroupingRule. | 
| delete | DELETE /v1alpha/{name}Delete a AlertGroupingRule. | 
| get | GET /v1alpha/{name}Get a AlertGroupingRule. | 
| list | GET /v1alpha/{parent}/alertGroupingRulesList page of AlertGroupingRules. | 
| patch | PATCH /v1alpha/{alertGroupingRule.name}Update a AlertGroupingRule. | 
REST Resource: v1alpha.projects.locations.instances.analytics
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/analyticsLists all supported analytics for APIs which can filter by analytic type, such as ListAnalyticValues. | 
REST Resource: v1alpha.projects.locations.instances.analytics.entities.analyticValues
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/analyticValuesLists analytic values. | 
REST Resource: v1alpha.projects.locations.instances.announcements
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/announcementsCreate an Announcement. | 
| delete | DELETE /v1alpha/{name}Delete an Announcement. | 
| get | GET /v1alpha/{name}Get an Announcement. | 
| list | GET /v1alpha/{parent}/announcementsList page of Announcements. | 
| patch | PATCH /v1alpha/{announcement.name}Update an Announcement. | 
REST Resource: v1alpha.projects.locations.instances.bigQueryAccess
| Methods | |
|---|---|
| provide | POST /v1alpha/{parent}/bigQueryAccess:provideProvide BigQuery access for the given email. | 
REST Resource: v1alpha.projects.locations.instances.bigQueryExport
| Methods | |
|---|---|
| provision | POST /v1alpha/{parent}/bigQueryExport:provisionProvision the BigQuery export for a Chronicle instance. | 
REST Resource: v1alpha.projects.locations.instances.caseCloseDefinitions
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/caseCloseDefinitionsCreates a CaseCloseDefinition. | 
| delete | DELETE /v1alpha/{name}Deletes a CaseCloseDefinition. | 
| get | GET /v1alpha/{name}Gets a CaseCloseDefinition. | 
| list | GET /v1alpha/{parent}/caseCloseDefinitionsLists CaseCloseDefinitions. | 
| patch | PATCH /v1alpha/{caseCloseDefinition.name}Updates a CaseCloseDefinition. | 
REST Resource: v1alpha.projects.locations.instances.caseQueueFilters
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/caseQueueFiltersCreate a CaseQueueFilter. | 
| delete | DELETE /v1alpha/{name}Delete a CaseQueueFilter. | 
| get | GET /v1alpha/{name}Get a CaseQueueFilter. | 
| getShareConfig | GET /v1alpha/{name}Get a ShareConfig. | 
| list | GET /v1alpha/{parent}/caseQueueFiltersLists CaseQueueFilters. | 
| patch | PATCH /v1alpha/{caseQueueFilter.name}Update a CaseQueueFilter. | 
| updateShareConfig | PATCH /v1alpha/{shareConfig.name}Update a ShareConfig. | 
REST Resource: v1alpha.projects.locations.instances.caseStageDefinitions
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/caseStageDefinitionsCreate a stages available for case management. | 
| delete | DELETE /v1alpha/{name}Delete a stages available for case management. | 
| get | GET /v1alpha/{name}Get specific stage available for case management. | 
| list | GET /v1alpha/{parent}/caseStageDefinitionsLists all stages available for case management. | 
| patch | PATCH /v1alpha/{caseStageDefinition.name}Update a stages available for case management. | 
REST Resource: v1alpha.projects.locations.instances.caseTagDefinitions
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/caseTagDefinitionsCreate a CaseTagDefinition. | 
| delete | DELETE /v1alpha/{name}Delete a CaseTagDefinition. | 
| get | GET /v1alpha/{name}Get a CaseTagDefinition. | 
| import | POST /v1alpha/{parent}/caseTagDefinitions:importImport CaseTagDefinitions. | 
| list | GET /v1alpha/{parent}/caseTagDefinitionsLists CaseTagDefinitions. | 
| patch | PATCH /v1alpha/{caseTagDefinition.name}Update a CaseTagDefinition. | 
REST Resource: v1alpha.projects.locations.instances.cases
| Methods | |
|---|---|
| addTag | POST /v1alpha/{name}:addTagAdd a case tag. | 
| countPriorities | GET /v1alpha/{parent}/cases:countPrioritiesCount a selection of cases by priority. | 
| createInsight | POST /v1alpha/{name}:createInsightAdd a case insight. | 
| executeBulkAddTag | POST /v1alpha/{parent}/cases:executeBulkAddTagAdd cases tags in bulk. | 
| executeBulkAssign | POST /v1alpha/{parent}/cases:executeBulkAssignAssign cases in bulk. | 
| executeBulkChangePriority | POST /v1alpha/{parent}/cases:executeBulkChangePriorityChange cases priority in bulk. | 
| executeBulkChangeStage | POST /v1alpha/{parent}/cases:executeBulkChangeStageAdd cases stage in bulk. | 
| executeBulkClose | POST /v1alpha/{parent}/cases:executeBulkCloseClose cases in bulk. | 
| executeBulkReopen | POST /v1alpha/{parent}/cases:executeBulkReopenReopen cases in bulk. | 
| generateReport | POST /v1alpha/{name}:generateReportGenerate case report. | 
| get | GET /v1alpha/{name}Get a case. | 
| getCaseOverviewData | GET /v1alpha/{name}:caseOverviewDataGet case overview. | 
| list | GET /v1alpha/{parent}/casesLists cases. | 
| merge | POST /v1alpha/{parent}/cases:mergeMerge cases. | 
| patch | PATCH /v1alpha/{case.name}Update a case. | 
| pauseSla | POST /v1alpha/{name}:pauseSlaPause case SLA. | 
| removeTag | POST /v1alpha/{name}:removeTagRemove a case tag. | 
| resolveOverviewWidget | GET /v1alpha/{name}:resolveOverviewWidgetResolve case overview widget. | 
| resumeSla | POST /v1alpha/{name}:resumeSlaResume case SLA. | 
REST Resource: v1alpha.projects.locations.instances.cases.alerts.contextProperties
| Methods | |
|---|---|
| clearAll | POST /v1alpha/{parent}/contextProperties:clearAllThe method clears all context-properties set on a specific context. | 
| create | POST /v1alpha/{parent}/contextPropertiesCreate a context-property. | 
| delete | DELETE /v1alpha/{name}Delete a context-property. | 
| get | GET /v1alpha/{name}Get a context-property. | 
| list | GET /v1alpha/{parent}/contextPropertiesList context-properties. | 
| patch | PATCH /v1alpha/{contextProperty.name}Update a context-property. | 
REST Resource: v1alpha.projects.locations.instances.cases.alerts.customFieldValues
| Methods | |
|---|---|
| batchUpdate | POST /v1alpha/{parent}/customFieldValues:batchUpdateBatch update CustomFieldValues. | 
| get | GET /v1alpha/{name}Get a CustomFieldValue. | 
| list | GET /v1alpha/{parent}/customFieldValuesLists CustomFieldValues. | 
| patch | PATCH /v1alpha/{customFieldValue.name}Update a CustomFieldValue. | 
REST Resource: v1alpha.projects.locations.instances.cases.caseAlerts
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get a CaseAlert. | 
| getAlertOverviewData | GET /v1alpha/{name}:alertOverviewDataGet alert overview. | 
| list | GET /v1alpha/{parent}/caseAlertsList CaseAlerts. | 
| move | POST /v1alpha/{name}:moveMove CaseAlert to a different case. | 
| patch | PATCH /v1alpha/{caseAlert.name}Update a CaseAlert. | 
| pauseSla | POST /v1alpha/{name}:pauseSlaPause a CaseAlert SLA. | 
| resolveOverviewWidget | GET /v1alpha/{name}:resolveOverviewWidgetResolve alert overview widget. | 
| resumeSla | POST /v1alpha/{name}:resumeSlaResume a CaseAlert SLA. | 
| setSla | POST /v1alpha/{name}:setSlaSet CaseAlert SLA. | 
REST Resource: v1alpha.projects.locations.instances.cases.caseAlerts.connectorEvents
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get a ConnectorEvent. | 
| getFormatted | GET /v1alpha/{parent}/connectorEvents:formattedGet a formatted ConnectorEvents for a given case/alert. | 
| list | GET /v1alpha/{parent}/connectorEventsList page of ConnectorEvents. | 
REST Resource: v1alpha.projects.locations.instances.cases.caseAlerts.involvedEntities
| Methods | |
|---|---|
| addProperty | POST /v1alpha/{name}:addPropertyAdd a property to an InvolvedEntity. | 
| create | POST /v1alpha/{parent}/involvedEntitiesCreate an InvolvedEntity. | 
| fetchCards | GET /v1alpha/{parent}/involvedEntities:fetchCardsFetch invloved entities cards. | 
| get | GET /v1alpha/{name}Get an InvolvedEntity. | 
| list | GET /v1alpha/{parent}/involvedEntitiesLists InvolvedEntities. | 
| patch | PATCH /v1alpha/{involvedEntity.name}Update an InvolvedEntity. | 
| updateProperty | POST /v1alpha/{name}:updatePropertyUpdate a property of an InvolvedEntity. | 
REST Resource: v1alpha.projects.locations.instances.cases.caseComments
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/caseCommentsCreate a CaseComment. | 
| delete | DELETE /v1alpha/{name}Delete a CaseComment. | 
| get | GET /v1alpha/{name}Get a CaseComment. | 
| list | GET /v1alpha/{parent}/caseCommentsLists CaseComments. | 
| patch | PATCH /v1alpha/{caseComment.name}Update a CaseComment. | 
REST Resource: v1alpha.projects.locations.instances.cases.caseWallRecords
| Methods | |
|---|---|
| favorite | PATCH /v1alpha/{favoriteRequest.name}:favoriteSet a wall item as a favorite one. | 
| fetchActivitiesCount | GET /v1alpha/{parent}/caseWallRecords:fetchActivitiesCountFetches the count of activities for a given type. | 
| get | GET /v1alpha/{name}Get a CaseWallRecord. | 
| list | GET /v1alpha/{parent}Lists CaseWallRecords. | 
REST Resource: v1alpha.projects.locations.instances.cases.chatMessages
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/chatMessagesCreates a Case-chat message. | 
| get | GET /v1alpha/{name}Gets a Case-chat message. | 
| list | GET /v1alpha/{parent}/chatMessagesLists all Case-chat messages for a given case. | 
| pinMessage | POST /v1alpha/{name}:pinMessagePins a Case-chat message to the case wall. | 
| unpinMessage | POST /v1alpha/{name}:unpinMessageUnpins a Case-chat message from the case wall. | 
| upload | POST /v1alpha/{parent}/chatMessages:createWithAttachmentPOST /upload/v1alpha/{parent}/chatMessages:createWithAttachmentCreates a Case-chat message with an attachment. | 
REST Resource: v1alpha.projects.locations.instances.cases.chatMessages.attachments
| Methods | |
|---|---|
| download | GET /v1alpha/{name}:downloadDownloads a Case-chat message attachment. | 
REST Resource: v1alpha.projects.locations.instances.cases.chatMessages.legacySoarUsers
| Methods | |
|---|---|
| unreadMessagesCount | GET /v1alpha/{parent}:unreadMessagesCountGets the amount of unread messages for current user | 
REST Resource: v1alpha.projects.locations.instances.cases.contextProperties
| Methods | |
|---|---|
| clearAll | POST /v1alpha/{parent}/contextProperties:clearAllThe method clears all context-properties set on a specific context. | 
| create | POST /v1alpha/{parent}/contextPropertiesCreate a context-property. | 
| delete | DELETE /v1alpha/{name}Delete a context-property. | 
| get | GET /v1alpha/{name}Get a context-property. | 
| list | GET /v1alpha/{parent}/contextPropertiesList context-properties. | 
| patch | PATCH /v1alpha/{contextProperty.name}Update a context-property. | 
REST Resource: v1alpha.projects.locations.instances.cases.customFieldValues
| Methods | |
|---|---|
| batchUpdate | POST /v1alpha/{parent}/customFieldValues:batchUpdateBatch update CustomFieldValues. | 
| get | GET /v1alpha/{name}Get a CustomFieldValue. | 
| list | GET /v1alpha/{parent}/customFieldValuesLists CustomFieldValues. | 
| patch | PATCH /v1alpha/{customFieldValue.name}Update a CustomFieldValue. | 
REST Resource: v1alpha.projects.locations.instances.contentHub.contentPacks
| Methods | |
|---|---|
| add | POST /v1alpha/{parent}:addCreate a ContentPack. | 
| alignPlaybooks | POST /v1alpha/{name}:alignPlaybooksAlign Playbooks from a Content Pack. | 
| delete | DELETE /v1alpha/{name}Delete a ContentPack. | 
| deployConnectorInstances | POST /v1alpha/{name}:deployConnectorInstancesInstall Connector Instances from a Content Pack. | 
| deployPlaybooks | POST /v1alpha/{name}:deployPlaybooksInstall Playbooks from a Content Pack. | 
| deployTestCases | POST /v1alpha/{name}:deployTestCasesInstall test cases. | 
| download | GET /v1alpha/{name}:exportPackExport Content Pack. | 
| get | GET /v1alpha/{name}Get a ContentPack. | 
| installIntegration | POST /v1alpha/{name}:installIntegrationInstall integration. | 
| list | GET /v1alpha/{parent}Lists ContentPacks. | 
| markAsDeployed | POST /v1alpha/{name}:markAsDeployedMark Content Pack as deployed. | 
| upload | POST /v1alpha/{parent}:importPackPOST /upload/v1alpha/{parent}:importPackImport Content Pack. | 
REST Resource: v1alpha.projects.locations.instances.contentHub.featuredContentNativeDashboards
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get a native dashboard featured content. | 
| install | POST /v1alpha/{name}:installInstall a native dashboard featured content. | 
| list | GET /v1alpha/{parent}/featuredContentNativeDashboardsList all native dashboards featured content. | 
REST Resource: v1alpha.projects.locations.instances.contentHub.featuredContentRules
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/featuredContentRulesLists FeaturedContentRules | 
REST Resource: v1alpha.projects.locations.instances.contentHub.featuredContentSearchQueries
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get a search featured content. | 
| installFeaturedContentSearchQuery | POST /v1alpha/{name}Install a search featured content. | 
| list | GET /v1alpha/{parent}/featuredContentSearchQueriesList all searches featured content. | 
REST Resource: v1alpha.projects.locations.instances.contextProperties
| Methods | |
|---|---|
| clearAll | POST /v1alpha/{parent}/contextProperties:clearAllThe method clears all context-properties set on a specific context. | 
| create | POST /v1alpha/{parent}/contextPropertiesCreate a context-property. | 
| delete | DELETE /v1alpha/{name}Delete a context-property. | 
| get | GET /v1alpha/{name}Get a context-property. | 
| list | GET /v1alpha/{parent}/contextPropertiesList context-properties. | 
| patch | PATCH /v1alpha/{contextProperty.name}Update a context-property. | 
REST Resource: v1alpha.projects.locations.instances.coverageDetails
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get coverage details for a threat collection and rule combination. | 
| list | GET /v1alpha/{parent}/coverageDetailsList coverage details for threat collection and rule combinations. | 
REST Resource: v1alpha.projects.locations.instances.curatedRuleSetCategories
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Gets a CuratedRuleSetCategory. | 
| list | GET /v1alpha/{parent}/curatedRuleSetCategoriesLists CuratedRuleSetCategories. | 
REST Resource: v1alpha.projects.locations.instances.curatedRuleSetCategories.curatedRuleSets
| Methods | |
|---|---|
| countCuratedRuleSetDetections | POST /v1alpha/{name}:countCuratedRuleSetDetectionsCounts the detections generated by a CuratedRuleSet. | 
| get | GET /v1alpha/{name}Gets a CuratedRuleSet. | 
| list | GET /v1alpha/{parent}/curatedRuleSetsLists CuratedRuleSets. | 
REST Resource: v1alpha.projects.locations.instances.curatedRuleSetCategories.curatedRuleSets.curatedRuleSetDeployments
| Methods | |
|---|---|
| batchUpdate | POST /v1alpha/{parent}/curatedRuleSetDeployments:batchUpdateUpdate multiple deployments of curated rule sets. | 
| get | GET /v1alpha/{name}Get a deployment of a curated rule set. | 
| list | GET /v1alpha/{parent}/curatedRuleSetDeploymentsLists deployments for a curated rule set. | 
| patch | PATCH /v1alpha/{curatedRuleSetDeployment.name}Update a deployment of a curated rule set. | 
REST Resource: v1alpha.projects.locations.instances.curatedRules
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Gets a CuratedRule. | 
| list | GET /v1alpha/{parent}/curatedRulesLists CuratedRules. | 
REST Resource: v1alpha.projects.locations.instances.customFields
| Methods | |
|---|---|
| batchGet | GET /v1alpha/{parent}/customFields:batchGetBatch gets multiple CustomFields. | 
| create | POST /v1alpha/{parent}/customFieldsCreate a CustomField. | 
| delete | DELETE /v1alpha/{name}Delete a CustomField. | 
| get | GET /v1alpha/{name}Get a CustomField. | 
| list | GET /v1alpha/{parent}/customFieldsLists custom fields. | 
| patch | PATCH /v1alpha/{customField.name}Update a CustomField. | 
REST Resource: v1alpha.projects.locations.instances.customLists
| Methods | |
|---|---|
| batchDelete | POST /v1alpha/{parent}/customLists:batchDeleteBatch delete custom lists by custom lists names. | 
| create | POST /v1alpha/{parent}/customListsCreate a CustomList. | 
| delete | DELETE /v1alpha/{name}Delete a custom list. | 
| export | POST /v1alpha/{parent}/customLists:exportExport custom lists by custom lists names. | 
| get | GET /v1alpha/{name}Get a CustomList. | 
| import | POST /v1alpha/{parent}/customLists:importImport custom lists from CSV file. | 
| list | GET /v1alpha/{parent}/customListsList all CustomLists. | 
| patch | PATCH /v1alpha/{customList.name}Update a CustomList. | 
REST Resource: v1alpha.projects.locations.instances.dashboardCharts
| Methods | |
|---|---|
| batchGet | GET /v1alpha/{parent}/dashboardCharts:batchGetGet dashboard charts in batches. | 
| get | GET /v1alpha/{name}Get a dashboard chart. | 
REST Resource: v1alpha.projects.locations.instances.dashboardQueries
| Methods | |
|---|---|
| execute | POST /v1alpha/{parent}/dashboardQueries:executeExecute a query and return the data. | 
| get | GET /v1alpha/{name}Get a dashboard query. | 
REST Resource: v1alpha.projects.locations.instances.dashboards
| Methods | |
|---|---|
| copy | POST /v1alpha/{name}:copyCopy a dashboard of one type to a dashbooard of another type. | 
| create | POST /v1alpha/{parent}/dashboardsCreate a dashboard. | 
| delete | DELETE /v1alpha/{name}Delete a dashboard. | 
| get | GET /v1alpha/{name}Get a dashboard. | 
| list | GET /v1alpha/{parent}/dashboardsList all dashboards. | 
REST Resource: v1alpha.projects.locations.instances.dataAccessLabels
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/dataAccessLabelsCreates a data access label. | 
| delete | DELETE /v1alpha/{name}Deletes a data access label. | 
| get | GET /v1alpha/{name}Gets a data access label. | 
| list | GET /v1alpha/{parent}/dataAccessLabelsLists all data access labels for the customer. | 
| patch | PATCH /v1alpha/{dataAccessLabel.name}Updates a data access label. | 
REST Resource: v1alpha.projects.locations.instances.dataAccessScopes
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/dataAccessScopesCreates a data access scope. | 
| delete | DELETE /v1alpha/{name}Deletes a data access scope. | 
| get | GET /v1alpha/{name}Retrieves an existing data access scope. | 
| list | GET /v1alpha/{parent}/dataAccessScopesLists all existing data access scopes for the customer. | 
| patch | PATCH /v1alpha/{dataAccessScope.name}Updates a data access scope. | 
REST Resource: v1alpha.projects.locations.instances.dataExports
| Methods | |
|---|---|
| cancel | POST /v1alpha/{name}:cancelCancels a DataExport. | 
| create | POST /v1alpha/{parent}/dataExportsCreates a new DataExport. | 
| fetchServiceAccountForDataExport | GET /v1alpha/{parent}/dataExports:fetchServiceAccountForDataExportFetches the service account for Data Export for a chronicle instance. | 
| fetchavailablelogtypes | POST /v1alpha/{parent}/dataExports:fetchavailablelogtypesFetches available log types for export. | 
| get | GET /v1alpha/{name}Gets a DataExport. | 
| list | GET /v1alpha/{parent}/dataExportsLists Data Export requests. | 
| patch | PATCH /v1alpha/{dataExport.name}Updates a Data Export request. | 
REST Resource: v1alpha.projects.locations.instances.dataTableOperationErrors
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get the error for a data table operation. | 
REST Resource: v1alpha.projects.locations.instances.dataTables
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/dataTablesCreate a new data table. | 
| delete | DELETE /v1alpha/{name}Delete data table. | 
| get | GET /v1alpha/{name}Get data table info. | 
| list | GET /v1alpha/{parent}/dataTablesList data tables. | 
| patch | PATCH /v1alpha/{dataTable.name}Update data table. | 
| upload | POST /v1alpha/{parent}/dataTables:bulkCreateDataTableAsyncPOST /upload/v1alpha/{parent}/dataTables:bulkCreateDataTableAsyncCreate data table from a bulk file. | 
REST Resource: v1alpha.projects.locations.instances.dataTables.dataTableRows
| Methods | |
|---|---|
| bulkCreate | POST /v1alpha/{parent}/dataTableRows:bulkCreateCreate data table rows in bulk. | 
| bulkCreateAsync | POST /v1alpha/{parent}/dataTableRows:bulkCreateAsyncCreate data table rows in bulk asynchronously. | 
| bulkGet | POST /v1alpha/{parent}/dataTableRows:bulkGetGet data table rows in bulk. | 
| bulkReplace | POST /v1alpha/{parent}/dataTableRows:bulkReplaceReplace all existing data table rows with new data table rows. | 
| bulkReplaceAsync | POST /v1alpha/{parent}/dataTableRows:bulkReplaceAsyncReplace all existing data table rows with new data table rows asynchronously. | 
| bulkUpdate | POST /v1alpha/{parent}/dataTableRows:bulkUpdateUpdate data table rows in bulk. | 
| bulkUpdateAsync | POST /v1alpha/{parent}/dataTableRows:bulkUpdateAsyncUpdate data table rows in bulk asynchronously. | 
| create | POST /v1alpha/{parent}/dataTableRowsCreate a new data table row. | 
| delete | DELETE /v1alpha/{name}Delete data table row. | 
| get | GET /v1alpha/{name}Get data table row | 
| list | GET /v1alpha/{parent}/dataTableRowsList data table rows. | 
| patch | PATCH /v1alpha/{dataTableRow.name}Update data table row | 
REST Resource: v1alpha.projects.locations.instances.dataTaps
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/dataTapsCreates a DataTap. | 
| delete | DELETE /v1alpha/{name}Deletes a DataTap. | 
| get | GET /v1alpha/{name}Gets a DataTap. | 
| list | GET /v1alpha/{parent}/dataTapsLists DataTaps. | 
| patch | PATCH /v1alpha/{dataTap.name}Updates a DataTap. | 
REST Resource: v1alpha.projects.locations.instances.dynamicParameters
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/dynamicParametersCreate a DynamicParameter. | 
| delete | DELETE /v1alpha/{name}Delete a DynamicParameter. | 
| export | POST /v1alpha/{parent}/dynamicParameters:exportExport all DynamicParameters. | 
| get | GET /v1alpha/{name}Get a DynamicParameter. | 
| import | POST /v1alpha/{parent}/dynamicParameters:importImport DynamicParameters. | 
| list | GET /v1alpha/{parent}/dynamicParametersLists DynamicParameters. | 
| patch | PATCH /v1alpha/{dynamicParameter.name}Update a DynamicParameter. | 
REST Resource: v1alpha.projects.locations.instances.emailTemplates
| Methods | |
|---|---|
| batchDelete | POST /v1alpha/{parent}/emailTemplates:batchDeleteBatch delete email templates. | 
| create | POST /v1alpha/{parent}/emailTemplatesCreates an EmailTemplate for a given instance. | 
| delete | DELETE /v1alpha/{name}Deletes an EmailTemplate for a given instance. | 
| export | POST /v1alpha/{parent}/emailTemplates:exportExport email templates as file stream. | 
| get | GET /v1alpha/{name}Gets an EmailTemplate by name. | 
| import | POST /v1alpha/{parent}/emailTemplates:importImport email templates from file stream. | 
| list | GET /v1alpha/{parent}/emailTemplatesLists all EmailTemplates for a given instance. | 
| patch | PATCH /v1alpha/{emailTemplate.name}Updates an EmailTemplate for a given instance. | 
REST Resource: v1alpha.projects.locations.instances.enrichmentControls
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/enrichmentControlsCreate an EnrichmentControl resource. | 
| delete | DELETE /v1alpha/{name}Delete an EnrichmentControl. | 
| disable | POST /v1alpha/{name}:disableDisable an EnrichmentControl. | 
| get | GET /v1alpha/{name}Get an EnrichmentControl. | 
| list | GET /v1alpha/{parent}/enrichmentControlsList all EnrichmentControls. | 
REST Resource: v1alpha.projects.locations.instances.entities
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Gets an entity by name. | 
| import | POST /v1alpha/{parent}/entities:importImportEntities import the entities. | 
| modifyEntityRiskScore | POST /v1alpha/{name}:modifyEntityRiskScoreModify base entity risk score for an entity. | 
| queryEntityRiskScoreModifications | GET /v1alpha/{name}:queryEntityRiskScoreModificationsQuery modifications to base entity risk score for an entity. | 
REST Resource: v1alpha.projects.locations.instances.entitiesBlocklists
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/entitiesBlocklistsCreate a EntitiesBlocklist. | 
| delete | DELETE /v1alpha/{name}Delete a EntitiesBlocklist. | 
| get | GET /v1alpha/{name}Get a EntitiesBlocklist. | 
| list | GET /v1alpha/{parent}/entitiesBlocklistsList page of EntitiesBlocklists. | 
| patch | PATCH /v1alpha/{entitiesBlocklist.name}Update a EntitiesBlocklist. | 
REST Resource: v1alpha.projects.locations.instances.entityRiskScores
| Methods | |
|---|---|
| query | GET /v1alpha/{instance}/entityRiskScores:queryQueries the instance for EntityRiskScores. | 
REST Resource: v1alpha.projects.locations.instances.environmentGroups
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/environmentGroupsCreate an EnvironmentGroup. | 
| delete | DELETE /v1alpha/{name}Delete an EnvironmentGroup. | 
| get | GET /v1alpha/{name}Get an EnvironmentGroup. | 
| list | GET /v1alpha/{parent}/environmentGroupsList EnvironmentGroups. | 
| patch | PATCH /v1alpha/{environmentGroup.name}Update an EnvironmentGroup. | 
REST Resource: v1alpha.projects.locations.instances.environments
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/environmentsCreates a Environment. | 
| delete | DELETE /v1alpha/{name}Deletes a Environment. | 
| get | GET /v1alpha/{name}Gets a Environment. | 
| list | GET /v1alpha/{parent}/environmentsLists Environments. | 
| patch | PATCH /v1alpha/{environment.name}Updates a Environment. | 
| resetWeights | POST /v1alpha/{name}/environments:resetWeightsReset weights of all environments. | 
REST Resource: v1alpha.projects.locations.instances.errorNotificationConfigs
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/errorNotificationConfigsCreates a new error notification config for the customer | 
| delete | DELETE /v1alpha/{name}Deletes an error notification config. | 
| get | GET /v1alpha/{name}Gets a single error notification config. | 
| list | GET /v1alpha/{parent}/errorNotificationConfigsLists error notification configurations for the customer. | 
| patch | PATCH /v1alpha/{errorNotificationConfig.name}Updates an error notification config. | 
REST Resource: v1alpha.projects.locations.instances.events
| Methods | |
|---|---|
| batchGet | GET /v1alpha/{parent}/events:batchGetGets a batch (list) of events given a list of names and a parent. | 
| fetchEnrichedEvent | GET /v1alpha/{name}:fetchEnrichedEventGets the enriched event for a given event id. | 
| get | GET /v1alpha/{name}Gets an event given a name. | 
| import | POST /v1alpha/{parent}/events:importImportEvents import the events. | 
REST Resource: v1alpha.projects.locations.instances.federationGroups
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/federationGroupsCreateFederationGroup method creates a new Federation group. | 
| delete | DELETE /v1alpha/{name}DeleteFederationGroup method deletes a Federation group. | 
| get | GET /v1alpha/{name}GetFederationGroup method gets a Federation group. | 
| list | GET /v1alpha/{parent}/federationGroupsListFederationGroups method lists all Federation groups. | 
| patch | PATCH /v1alpha/{federationGroup.name}UpdateFederationGroup method updates a Federation group. | 
REST Resource: v1alpha.projects.locations.instances.feedPacks
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Gets a feed pack. | 
| list | GET /v1alpha/{parent}/feedPacksLists Packs for which feeds can be configured. | 
REST Resource: v1alpha.projects.locations.instances.feedServiceAccounts
| Methods | |
|---|---|
| fetchServiceAccountForCustomer | GET /v1alpha/{parent}/feedServiceAccounts:fetchServiceAccountForCustomerFetch Chronicle's service account used for ingesting data from Cloud Storage buckets. | 
REST Resource: v1alpha.projects.locations.instances.feedSourceTypeSchemas
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/feedSourceTypeSchemasList all FeedSourceTypeSchemas. | 
REST Resource: v1alpha.projects.locations.instances.feedSourceTypeSchemas.logTypeSchemas
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/logTypeSchemasList all LogTypeSchemas compatible with a given FeedSourceType. | 
REST Resource: v1alpha.projects.locations.instances.feeds
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/feedsCreates a feed. | 
| delete | DELETE /v1alpha/{name}Deletes a feed. | 
| disable | POST /v1alpha/{name}:disableDisable feed for ingestion. | 
| enable | POST /v1alpha/{name}:enableEnable feed for ingestion. | 
| generateSecret | POST /v1alpha/{name}:generateSecretGenerates a new secret for https push feeds which do not support jwt tokens. | 
| get | GET /v1alpha/{name}Gets a feed. | 
| importPushLogs | POST /v1alpha/{parent}:importPushLogsImport logs coming from https push feeds. | 
| list | GET /v1alpha/{parent}/feedsLists all feeds for the customer. | 
| patch | PATCH /v1alpha/{feed.name}Updates the full feed. | 
| scheduleTransfer | POST /v1alpha/{name}:scheduleTransferSchedules a feed transfer for the feed. | 
REST Resource: v1alpha.projects.locations.instances.findingsGraph
| Methods | |
|---|---|
| exploreNode | GET /v1alpha/{name}:exploreNodeExplores a node to find related nodes if it is an IndividualNode or retrieve the individual nodes within the group if it is a GroupNode and return a graph composed by the nodes and their edges over a time range. | 
| initializeGraph | GET /v1alpha/{name}:initializeGraphInitialize a graph from a resource such as a detection or an entity. | 
REST Resource: v1alpha.projects.locations.instances.findingsRefinements
| Methods | |
|---|---|
| computeFindingsRefinementActivity | POST /v1alpha/{name}:computeFindingsRefinementActivityReturns findings refinement activity for a specific findings refinement. | 
| create | POST /v1alpha/{parent}/findingsRefinementsCreates a new findings refinement. | 
| get | GET /v1alpha/{name}Gets a single findings refinement. | 
| getDeployment | GET /v1alpha/{name}Gets a findings refinement deployment. | 
| list | GET /v1alpha/{parent}/findingsRefinementsLists a collection of findings refinements. | 
| patch | PATCH /v1alpha/{findingsRefinement.name}Updates a findings refinement. | 
| updateDeployment | PATCH /v1alpha/{findingsRefinementDeployment.name}Updates a findings refinement deployment. | 
REST Resource: v1alpha.projects.locations.instances.forwarders
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/forwardersCreate a forwarder. | 
| delete | DELETE /v1alpha/{name}Delete a forwarder by forwarder ID. | 
| generateForwarderFiles | GET /v1alpha/{name}:generateForwarderFilesGenerates a forwarder's configuration files. | 
| get | GET /v1alpha/{name}Get a forwarder by forwarder ID. | 
| importStatsEvents | POST /v1alpha/{name}:importStatsEventsImportStatsEvents imports stats events from a forwarder. | 
| list | GET /v1alpha/{parent}/forwardersList all forwarders for the instance. | 
| patch | PATCH /v1alpha/{forwarder.name}Update a forwarder. | 
REST Resource: v1alpha.projects.locations.instances.forwarders.collectors
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/collectorsCreate a collector. | 
| delete | DELETE /v1alpha/{name}Delete a collector by collector ID. | 
| get | GET /v1alpha/{name}Get a collector by collector ID. | 
| list | GET /v1alpha/{parent}/collectorsList all collectors for the forwarder. | 
| patch | PATCH /v1alpha/{collector.name}Update a collector. | 
REST Resource: v1alpha.projects.locations.instances.ingestionLogLabels
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/ingestionLogLabelsReturns the ingestion log labels for the customer. | 
REST Resource: v1alpha.projects.locations.instances.ingestionLogNamespaces
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/ingestionLogNamespacesLists ingestion log namespaces for the customer. | 
REST Resource: v1alpha.projects.locations.instances.integrations
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/integrationsCreate a SOAR Integration. | 
| delete | DELETE /v1alpha/{name}Deletes a SOAR Integration. | 
| download | GET /v1alpha/{name}:exportExport an existing integration package to a zipped folder. | 
| downloadDependency | POST /v1alpha/{name}:downloadDependencyDownload integration dependency. | 
| exportIntegrationItems | GET /v1alpha/{name}:exportItemsExport items from existing integration to a zipped folder. | 
| fetchAffectedItems | GET /v1alpha/{name}:fetchAffectedItemsGet items that can be affected due to a change in the integration (for example, removal of the integration). | 
| fetchAgentIntegrations | GET /v1alpha/{parent}:fetchAgentIntegrationsGet the integrations that are installed on a specific agent. | 
| fetchCommercialDiff | GET /v1alpha/{name}:fetchCommercialDiffGet a diff between the current integration and the matching commercial integration from the store | 
| fetchDependencies | GET /v1alpha/{name}:fetchDependenciesList all of the downloaded dependencies of a custom integration. | 
| fetchRestrictedAgents | GET /v1alpha/{name}:fetchRestrictedAgentsReturns a list of all agents that an integration update should be restricted on, due to possible incompatibility, such as: unsupported Python version. | 
| get | GET /v1alpha/{name}Get a SOAR Integration. | 
| getFetchProductionDiff | GET /v1alpha/{name}:fetchProductionDiffGet a diff between the current staging integration and the matching production integration | 
| getFetchStagingDiff | GET /v1alpha/{name}:fetchStagingDiffGet a diff between the current production integration and the matching staging | 
| import | POST /v1alpha/{parent}:importPOST /upload/v1alpha/{parent}:importImport an integration from a file. | 
| importIntegrationDependency | POST /v1alpha/{name}:uploadDependencyPOST /upload/v1alpha/{name}:uploadDependencyUpload an integration dependency to an existing integration. | 
| importIntegrationItems | POST /v1alpha/{name}:importItemsPOST /upload/v1alpha/{name}:importItemsImport integration items from a file. | 
| list | GET /v1alpha/{parent}/integrationsLists SOAR Integrations. | 
| patch | PATCH /v1alpha/{integration.name}Updates a SOAR Integration. | 
| pushToProduction | POST /v1alpha/{name}:pushToProductionPush an integration from Staging to Production mode. | 
| pushToStaging | POST /v1alpha/{name}:pushToStagingPush an integration from Production to Staging mode. | 
| updateCustomIntegration | POST /v1alpha/{integration.name}:updateCustomIntegrationUpdates a SOAR Custom Integration. | 
| upload | POST /v1alpha/{parent}:extractIntegrationDetailsPOST /upload/v1alpha/{parent}:extractIntegrationDetailsGet the zip file content before importing an integration to the system | 
REST Resource: v1alpha.projects.locations.instances.integrations.actions
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/actionsCreateIntegrationAction creates a IntegrationAction. | 
| delete | DELETE /v1alpha/{name}DeleteIntegrationAction deletes a IntegrationAction. | 
| executeTest | POST /v1alpha/{name}:executeTestExecutes a test on a action definition script. | 
| fetchActionsByEnvironment | GET /v1alpha/{parent}/actions:fetchActionsByEnvironmentFetch actions by environment. | 
| fetchTemplate | GET /v1alpha/{parent}/actions:fetchTemplateFetches the default action template, mainly used for obtaining the default script allowing quick start. | 
| get | GET /v1alpha/{name}GetIntegrationAction gets a IntegrationAction. | 
| list | GET /v1alpha/{parent}/actionsListIntegrationActions lists IntegrationActions. | 
| patch | PATCH /v1alpha/{integrationAction.name}UpdateIntegrationAction updates a IntegrationAction. | 
REST Resource: v1alpha.projects.locations.instances.integrations.actions.revisions
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/revisionsCreateActionRevision creates a new action revision. | 
| delete | DELETE /v1alpha/{name}DeleteActionRevision deletes an action revision. | 
| list | GET /v1alpha/{parent}/revisionsList all revisions of an action. | 
| rollback | POST /v1alpha/{name}:rollbackRollbackIntegrationActionRevision rolls back the action definition to a saved revision. | 
REST Resource: v1alpha.projects.locations.instances.integrations.connectors
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/connectorsCreate a Integration Connector. | 
| delete | DELETE /v1alpha/{name}Delete a Connector. | 
| executeTest | POST /v1alpha/{integrationIdentifier}:executeTestExecute a test on a connector definition script. | 
| fetchTemplate | GET /v1alpha/{parent}/connectors:fetchTemplateRetrieve the default recommended Integration Connector script template. | 
| get | GET /v1alpha/{name}Get a integration connector. | 
| list | GET /v1alpha/{parent}/connectorsList integration connectors. | 
| patch | PATCH /v1alpha/{integrationConnector.name}Update a Integration Connector. | 
REST Resource: v1alpha.projects.locations.instances.integrations.connectors.connectorInstances
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/connectorInstancesCreate a ConnectorInstance. | 
| delete | DELETE /v1alpha/{name}Delete a ConnectorInstance. | 
| fetchLatestDefinition | GET /v1alpha/{parent}:fetchLatestDefinitionFetch the latest definition of a connector. | 
| get | GET /v1alpha/{name}Get a ConnectorInstance. | 
| list | GET /v1alpha/{parent}/connectorInstancesList ConnectorInstances. | 
| patch | PATCH /v1alpha/{connectorInstance.name}Update a ConnectorInstance. | 
| runOnDemand | POST /v1alpha/{name}:runOnDemandRun a connector on demand. | 
| setLogsCollection | POST /v1alpha/{name}:setLogsCollectionSet the logs collection for a connector. | 
REST Resource: v1alpha.projects.locations.instances.integrations.connectors.connectorInstances.logs
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get a single ConnectorInstanceLog. | 
| list | GET /v1alpha/{parent}/logsList all ConnectorInstanceLogs for a given ConnectorInstance. | 
REST Resource: v1alpha.projects.locations.instances.integrations.connectors.contextProperties
| Methods | |
|---|---|
| clearAll | POST /v1alpha/{parent}/contextProperties:clearAllThe method clears all context-properties set on a specific context. | 
| create | POST /v1alpha/{parent}/contextPropertiesCreate a context-property. | 
| delete | DELETE /v1alpha/{name}Delete a context-property. | 
| get | GET /v1alpha/{name}Get a context-property. | 
| list | GET /v1alpha/{parent}/contextPropertiesList context-properties. | 
| patch | PATCH /v1alpha/{contextProperty.name}Update a context-property. | 
REST Resource: v1alpha.projects.locations.instances.integrations.connectors.revisions
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/revisionsCreates a new connector revision. | 
| delete | DELETE /v1alpha/{name}Deletes a connector revision. | 
| list | GET /v1alpha/{parent}/revisionsLists all revisions of a connector. | 
| rollback | POST /v1alpha/{name}:rollbackRollbackConnectorRevision rolls back the connector definition to a saved revision. | 
REST Resource: v1alpha.projects.locations.instances.integrations.integrationInstances
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/integrationInstancesCreate a IntegrationInstance. | 
| delete | DELETE /v1alpha/{name}Delete a IntegrationInstance. | 
| executeTest | POST /v1alpha/{name}:executeTestExecute a test for a given IntegrationInstance. | 
| fetchAffectedItems | GET /v1alpha/{name}:fetchAffectedItemsFetch affected items for a given IntegrationInstance. | 
| fetchDefaultInstance | GET /v1alpha/{parent}/integrationInstances:fetchDefaultInstanceExecute a test for a given IntegrationInstance. | 
| get | GET /v1alpha/{name}Get IntegrationInstance for a given instance. | 
| list | GET /v1alpha/{parent}/integrationInstancesList IntegrationInstances for a given instance. | 
| patch | PATCH /v1alpha/{integrationInstance.name}Update a IntegrationInstance. | 
REST Resource: v1alpha.projects.locations.instances.integrations.jobs
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/jobsCreateIntegrationJob creates a IntegrationJob. | 
| delete | DELETE /v1alpha/{name}DeleteIntegrationJob deletes a IntegrationJob. | 
| executeTest | POST /v1alpha/{name}:executeTestExecutes a test on a job definition script. | 
| fetchTemplate | GET /v1alpha/{parent}/jobs:fetchTemplateFetches the default job template, mainly used for obtaining the default script allowing quick start. | 
| get | GET /v1alpha/{name}GetIntegrationJob gets a IntegrationJob. | 
| list | GET /v1alpha/{parent}/jobsListIntegrationJobs lists IntegrationJobs. | 
| patch | PATCH /v1alpha/{integrationJob.name}UpdateIntegrationJob updates a IntegrationJob. | 
REST Resource: v1alpha.projects.locations.instances.integrations.jobs.contextProperties
| Methods | |
|---|---|
| clearAll | POST /v1alpha/{parent}/contextProperties:clearAllThe method clears all context-properties set on a specific context. | 
| create | POST /v1alpha/{parent}/contextPropertiesCreate a context-property. | 
| delete | DELETE /v1alpha/{name}Delete a context-property. | 
| get | GET /v1alpha/{name}Get a context-property. | 
| list | GET /v1alpha/{parent}/contextPropertiesList context-properties. | 
| patch | PATCH /v1alpha/{contextProperty.name}Update a context-property. | 
REST Resource: v1alpha.projects.locations.instances.integrations.jobs.jobInstances
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/jobInstancesCreateJobInstance creates a new job instance. | 
| delete | DELETE /v1alpha/{name}DeleteJobInstance deletes a job instance. | 
| get | GET /v1alpha/{name}Get instance of a job. | 
| list | GET /v1alpha/{parent}/jobInstancesList all instances of a job. | 
| patch | PATCH /v1alpha/{integrationJobInstance.name}UpdateIntegrationJobInstance updates an instance of a job instance. | 
| runOnDemand | POST /v1alpha/{name}:runOnDemandRunOnDemandIntegrationJobInstance runs job instance script once. | 
REST Resource: v1alpha.projects.locations.instances.integrations.jobs.jobInstances.logs
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get a single IntegrationJobInstanceLog. | 
| list | GET /v1alpha/{parent}/logsList all IntegrationJobInstanceLogs for a given IntegrationJobInstance. | 
REST Resource: v1alpha.projects.locations.instances.integrations.jobs.revisions
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/revisionsCreateJobRevision creates a new job revision. | 
| delete | DELETE /v1alpha/{name}DeleteJobRevision deletes a job revision. | 
| list | GET /v1alpha/{parent}/revisionsList all revisions of a job. | 
| rollback | POST /v1alpha/{name}:rollbackRollbackIntegrationJobRevision rolls back the job definition to a saved revision. | 
REST Resource: v1alpha.projects.locations.instances.integrations.managers
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/managersCreate an Integration Manager. | 
| delete | DELETE /v1alpha/{name}Delete an Integration Manager. | 
| fetchTemplate | GET /v1alpha/{parent}/managers:fetchTemplateRetrieve the default recommended Integration Manager script template. | 
| get | GET /v1alpha/{name}Get an Integration Manager. | 
| list | GET /v1alpha/{parent}/managersList Integration Managers for a given integration. | 
| patch | PATCH /v1alpha/{integrationManager.name}Update an Integration Manager. | 
REST Resource: v1alpha.projects.locations.instances.integrations.managers.revisions
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/revisionsCreateIntegrationManagerRevision creates a new manager revision. | 
| delete | DELETE /v1alpha/{name}DeleteIntegrationManagerRevision deletes a specific manager revision. | 
| get | GET /v1alpha/{name}GetIntegrationManagerRevision gets a specific manager revision. | 
| list | GET /v1alpha/{parent}/revisionsListIntegrationManagerRevisions lists all manager revisions for a given manager. | 
| rollback | POST /v1alpha/{name}:rollbackRollbackIntegrationManagerRevision rolls back the manager definition to a saved revision. | 
REST Resource: v1alpha.projects.locations.instances.investigations
| Methods | |
|---|---|
| fetchAssociated | GET /v1alpha/{parent}/investigations:fetchAssociatedFetchAssociatedInvestigations is used to fetch all the associated resources for each of the given alerts/cases. | 
| get | GET /v1alpha/{name}GetInvestigation is used to retrieve an investigation. | 
| list | GET /v1alpha/{parent}/investigationsListInvestigations is used to retrieve existing investigations for a given instance. | 
| trigger | POST /v1alpha/{parent}/investigations:triggerCustom method to manually trigger an investigation for a given alert. | 
REST Resource: v1alpha.projects.locations.instances.investigations.investigationComments
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/investigationCommentsCreateInvestigationComment is used to create an investigation comment. | 
| delete | DELETE /v1alpha/{name}DeleteInvestigationComment is used to delete an investigation comment. | 
| get | GET /v1alpha/{name}Retrieves a specific investigation comment. | 
| list | GET /v1alpha/{parent}/investigationCommentsListInvestigationComments is used to retrieve existing investigation comments for a given investigation. | 
| patch | PATCH /v1alpha/{investigationComment.name}UpdateInvestigationComment is used to update an investigation comment. | 
REST Resource: v1alpha.projects.locations.instances.investigations.investigationSteps
| Methods | |
|---|---|
| get | GET /v1alpha/{name}GetInvestigationStep is used to retrieve an investigation step. | 
| list | GET /v1alpha/{parent}/investigationStepsListInvestigationSteps is used to retrieve existing investigation steps for a given investigation. | 
REST Resource: v1alpha.projects.locations.instances.iocAssociations
| Methods | |
|---|---|
| batchGet | GET /v1alpha/{parent}/iocAssociations:batchGetGets a batch (list) of IocAssociations given a list of names and a parent. | 
| fetchRelated | GET /v1alpha/{parent}/iocAssociations:fetchRelatedList related Associations (Threat Actors or Malware Families) for a given threat resource. | 
| fetchRelatedIocAssociations  | GET /v1alpha/{name}:fetchRelatedIocAssociationsList related Ioc Associations for a given Ioc Association. | 
| fetchRelatedThreatCollections  | GET /v1alpha/{name}:fetchRelatedThreatCollectionsList related threat collections for an IocAssociation. | 
| get | GET /v1alpha/{name}Get an Ioc Association by resource name. | 
REST Resource: v1alpha.projects.locations.instances.iocs
| Methods | |
|---|---|
| batchGet | GET /v1alpha/{parent}/iocs:batchGetGets a batch (list) of iocs given a list of names and a parent. | 
| fetchRelated | GET /v1alpha/{parent}/iocs:fetchRelatedList related IOCs for a given threat resource. | 
| find | POST /v1alpha/{parent}/iocs:findGets a list of Iocs given a list of parameters that uniquely identify them. | 
| findFirstAndLastSeen | GET /v1alpha/{name}:findFirstAndLastSeenFindFirstAndLastSeen for an Ioc. | 
| get | GET /v1alpha/{name}Get an Ioc. | 
| getIocState | GET /v1alpha/{name}Gets the status of an ioc | 
| searchCuratedDetectionsForIoc | GET /v1alpha/{name}:searchCuratedDetectionsForIocSearch curated detections for an Ioc. | 
| updateIocState | PATCH /v1alpha/{iocState.name}Update an Ioc state. | 
REST Resource: v1alpha.projects.locations.instances.labsExperiments
| Methods | |
|---|---|
| execute | POST /v1alpha/{parent}:executeExecutes a LabsExperiment. | 
| get | GET /v1alpha/{name}Gets a LabExperiment. | 
| list | GET /v1alpha/{parent}/labsExperimentsLists LabsExperiments. | 
| patch | PATCH /v1alpha/{labsExperiment.name}Update a LabsExperiment. | 
REST Resource: v1alpha.projects.locations.instances.labsExperiments.executions
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Retrieves a specific LabsExperimentExecution resource. | 
| list | GET /v1alpha/{parent}/executionsLists LabsExperimentExecution resources. | 
| patch | PATCH /v1alpha/{labsExperimentExecution.name}Updates a LabsExperimentExecution. | 
REST Resource: v1alpha.projects.locations.instances.legacy
| Methods | |
|---|---|
| legacyBatchGetCases | GET /v1alpha/{instance}/legacy:legacyBatchGetCasesRPC for fetching cases for the given caseNames. | 
| legacyBatchGetCollections | GET /v1alpha/{instance}/legacy:legacyBatchGetCollectionsRPC for getting a batch of collections based on their Collection Ids. | 
| legacyCreateOrUpdateCase | POST /v1alpha/{instance}/legacy:legacyCreateOrUpdateCaseLegacy RPC for creating or updating an existing case. | 
| legacyCreateSoarAlert | POST /v1alpha/{instance}/legacy:legacyCreateSoarAlertRPC for creating a SOAR alert. | 
| legacyFetchAlertsView | GET /v1alpha/{instance}/legacy:legacyFetchAlertsViewLegacy streaming endpoint for getting alerts (and in some cases, non-alerting detections) along with aggregated fields that match the query. | 
| legacyFetchUdmSearchCsv | POST /v1alpha/{instance}/legacy:legacyFetchUdmSearchCsvLegacy endpoint for fetching csv rows for matching UDM search. | 
| legacyFetchUdmSearchView | POST /v1alpha/{instance}/legacy:legacyFetchUdmSearchViewLegacy endpoint for fetching events, filters, and histograms matching UDM search. | 
| legacyFindAssetEvents | GET /v1alpha/{instance}/legacy:legacyFindAssetEventsLegacy endpoint for getting events for an asset indicator. | 
| legacyFindRawLogs | GET /v1alpha/{instance}/legacy:legacyFindRawLogsLegacy endpoint for getting events for a raw log search query. | 
| legacyFindUdmEvents | GET /v1alpha/{instance}/legacy:legacyFindUdmEventsLegacy endpoint for finding UDM/entity events using tokens or ids. | 
| legacyGetAlert | GET /v1alpha/{instance}/legacy:legacyGetAlertRPC for fetching an alert based on its Alert Id. | 
| legacyGetCuratedRulesTrends | GET /v1alpha/{instance}/legacy:legacyGetCuratedRulesTrendsLegacy RPC for listing detection counts and last detection timestamp for a list of Curated Rule ids. | 
| legacyGetDetection | GET /v1alpha/{instance}/legacy:legacyGetDetectionLegacy endpoint for fetching a Detection. | 
| legacyGetEventForDetection | GET /v1alpha/{instance}/legacy:legacyGetEventForDetectionLegacy endpoint for getting event for curated detection. | 
| legacyGetRuleCounts | GET /v1alpha/{instance}/legacy:legacyGetRuleCountsRPC to get rule counts. | 
| legacyGetRulesTrends | GET /v1alpha/{instance}/legacy:legacyGetRulesTrendsLegacy RPC for listing detection counts and last detection timestamp for a list of user-defined rule ids. | 
| legacyRunTestRule | POST /v1alpha/{instance}/legacy:legacyRunTestRuleLegacy RPC to test a rule and stream back the responses. | 
| legacySearchArtifactEvents | GET /v1alpha/{instance}/legacy:legacySearchArtifactEventsLegacy endpoint for getting events for a given artifact. | 
| legacySearchArtifactIoCDetails | GET /v1alpha/{instance}/legacy:legacySearchArtifactIoCDetailsRpc to search for IoC details for a particular artifact. | 
| legacySearchAssetEvents | GET /v1alpha/{instance}/legacy:legacySearchAssetEventsLegacy endpoint for getting events for a given asset. | 
| legacySearchCuratedDetections | GET /v1alpha/{instance}/legacy:legacySearchCuratedDetectionsLegacy endpoint for searcing detections for a Curated Rule. | 
| legacySearchCustomerStats | POST /v1alpha/{instance}/legacy:legacySearchCustomerStatsLegacySearchCustomerStats gets data collection stats about a customer, e.g., the first time data was seen from a customer, the last time, etc. | 
| legacySearchDetections | GET /v1alpha/{instance}/legacy:legacySearchDetectionsLegacy endpoint for searching detections for a rule version. | 
| legacySearchDomainsRecentlyRegistered | GET /v1alpha/{instance}/legacy:legacySearchDomainsRecentlyRegisteredGiven a list of domain names and a time, returns only the domains that were recently registered relative to that time. | 
| legacySearchDomainsTimingStats | GET /v1alpha/{instance}/legacy:legacySearchDomainsTimingStatsGiven a list of domain names, returns time-related statistics for those domains (ex: the first seen in the enterprise time). | 
| legacySearchEnterpriseWideAlerts | GET /v1alpha/{instance}/legacy:legacySearchEnterpriseWideAlertsRPC for getting all alerts in a time range in legacy page site. | 
| legacySearchEnterpriseWideIoCs | GET /v1alpha/{instance}/legacy:legacySearchEnterpriseWideIoCsRPC for listing IoC matches against ingested events. | 
| legacySearchFindings | GET /v1alpha/{instance}/legacy:legacySearchFindingsLegacy endpoint for listing Findings. | 
| legacySearchIngestionStats | POST /v1alpha/{instance}/legacy:legacySearchIngestionStatsLegacySearchIngestionStats gets data ingestion stats about a given customer, e.g. | 
| legacySearchIoCInsights | GET /v1alpha/{instance}/legacy:legacySearchIoCInsightsRpc to list IoC insights on given artifacts. | 
| legacySearchRawLogs | GET /v1alpha/{instance}/legacy:legacySearchRawLogsLegacy endpoint for getting events for a raw log search. | 
| legacySearchRawLogsV2 | GET /v1alpha/{name}/legacy:legacySearchRawLogsV2Legacy endpoint to perform a RawLog search that returns matching events, entities, or unparsed raw logs. | 
| legacySearchRuleDetectionCountBuckets | GET /v1alpha/{instance}/legacy:legacySearchRuleDetectionCountBucketsLegacy endpoint for listing detection count buckets for a Rules Engine rule. | 
| legacySearchRuleDetectionEvents | GET /v1alpha/{instance}/legacy:legacySearchRuleDetectionEventsLegacy RPC for listing events associated with a particular Detection generated by a Rules Engine rule. | 
| legacySearchRuleResults | GET /v1alpha/{instance}/legacy:legacySearchRuleResultsLegacy endpoint for listing aggregated results for a Rules Engine rule. | 
| legacySearchRulesAlerts | GET /v1alpha/{instance}/legacy:legacySearchRulesAlertsRPC to get the list of Rules Engine generated alerts for a customer. | 
| legacySearchUserEvents | GET /v1alpha/{instance}/legacy:legacySearchUserEventsLegacy endpoint for getting events for a given user. | 
| legacyStreamDetectionAlerts | POST /v1alpha/{instance}/legacy:legacyStreamDetectionAlertsLegacy StreamDetectionAlerts continuously streams new detection alerts as they are discovered. | 
| legacyTestRuleStreaming | POST /v1alpha/{instance}/legacy:legacyTestRuleStreamingLegacyTestRuleStreaming tests the given rule text over a specified time range and streams detections/errors back without persisting them. | 
| legacyUpdateAlert | POST /v1alpha/{instance}/legacy:legacyUpdateAlertLegacy endpoint for updating an alert. | 
REST Resource: v1alpha.projects.locations.instances.legacyCaseFederationPlatforms
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/legacyCaseFederationPlatformsLegacy endpoint for creating a case federation platform. | 
| legacyDeleteCaseFederationPlatform | DELETE /v1alpha/{name}Legacy endpoint for deleting a case federation platform. | 
| legacyGetCaseFederationPlatform | GET /v1alpha/{name}Legacy endpoint for getting a case federation platform. | 
REST Resource: v1alpha.projects.locations.instances.legacyConfiguration
| Methods | |
|---|---|
| legacyGetMaximumAlertsGroupingConfiguration | GET /v1alpha/{instance}/legacyConfiguration:legacyGetMaximumAlertsGroupingConfigurationLegacy endpoint for fetching audit logs. | 
REST Resource: v1alpha.projects.locations.instances.legacyFederatedCases
| Methods | |
|---|---|
| legacyBatchPatchFederatedCases | POST /v1alpha/{parent}/legacyFederatedCases:legacyBatchPatchFederatedCasesBatch patch federated cases into the primary platform. | 
| legacyFetchCasesToSync | GET /v1alpha/{parent}/legacyFederatedCases:legacyFetchCasesToSyncLegacy endpoint for fetching cases to sync. | 
| legacyGetFederatedCase | GET /v1alpha/{name}Get a federated case. | 
| legacyListFederatedCases | POST /v1alpha/{parent}/legacyFederatedCases:legacyListFederatedCasesList federated cases. | 
REST Resource: v1alpha.projects.locations.instances.legacyPlaybooks
| Methods | |
|---|---|
| download | GET /v1alpha/{instance}/legacyPlaybooks:legacyExportDefinitionsLegacyPlaybookExportDefinitions exports workflows as a zip file. | 
| exportWorkflowWithBlocksByIdentifier | POST /v1alpha/{instance}/legacyPlaybooks:legacyImportDefinitionsPOST /upload/v1alpha/{instance}/legacyPlaybooks:legacyImportDefinitionsLegacyPlaybookImportDefinitions Import workflows from a zip file. | 
| legacyActionWidgetTemplate | GET /v1alpha/{instance}/legacyPlaybooks:legacyActionWidgetTemplateLegacyPlaybookActionWidgetTemplate returns the action widget template for a given action identifier. | 
| legacyAddOrUpdatePlaybookCategory | POST /v1alpha/{instance}/legacyPlaybooks:legacyAddOrUpdatePlaybookCategoryAdd or update workflow categories. | 
| legacyAiGenerate | POST /v1alpha/{instance}/legacyPlaybooks:legacyAiGenerateGenerates a playbook using AI based on the provided user prompt. | 
| legacyAiGenerateByAlert | POST /v1alpha/{instance}/legacyPlaybooks:legacyAiGenerateByAlertAI Generation of a new playbook based on a given security alert. | 
| legacyAiUpdate | POST /v1alpha/{instance}/legacyPlaybooks:legacyAiUpdateUpdates playbook using AI based on the provided user prompt. | 
| legacyApplyApprovalLink | POST /v1alpha/{instance}/legacyPlaybooks:legacyApplyApprovalLinkLegacyPlaybookApplyApprovalLink applies an approval link to a workflow. | 
| legacyAttachNestedWorkflowToCase | POST /v1alpha/{instance}/legacyPlaybooks:legacyAttachNestedWorkflowToCaseLegacyPlaybookAttachNestedWorkflowToCase attaches a nested workflow to a case. | 
| legacyAttachWorkflowToCase | POST /v1alpha/{instance}/legacyPlaybooks:legacyAttachWorkflowToCaseLegacyPlaybookAttachWorkflowToCase attaches a workflow to a case. | 
| legacyCheckWorkflowNameInDifferentEnvironments | POST /v1alpha/{instance}/legacyPlaybooks:legacyCheckWorkflowNameInDifferentEnvironmentsLegacyPlaybookCheckWorkflowNameInDifferentEnvironments checks if the workflow name is used in different environments. | 
| legacyCloneWorkflow | POST /v1alpha/{instance}/legacyPlaybooks:legacyCloneWorkflowlegacyCloneWorkflow clones a workflow. | 
| legacyCreateFeedback | POST /v1alpha/{instance}/legacyPlaybooks:legacyCreateFeedbackLegacyCreateFeedback creates a feedback for a playbook. | 
| legacyDeleteWorkflow | POST /v1alpha/{instance}/legacyPlaybooks:legacyDeleteWorkflowLegacyPlaybookDeleteWorkflow deletes a workflow definition. | 
| legacyDeleteWorkflows | POST /v1alpha/{instance}/legacyPlaybooks:legacyDeleteWorkflowsDelete workflows. | 
| legacyDuplicateNestedWorkflows | POST /v1alpha/{instance}/legacyPlaybooks:legacyDuplicateNestedWorkflowslegacyDuplicateNestedWorkflows duplicates nested workflows. | 
| legacyDuplicateWorkflow | POST /v1alpha/{instance}/legacyPlaybooks:legacyDuplicateWorkflowlegacyDuplicateWorkflow duplicates a workflow. | 
| legacyDuplicateWorkflows | POST /v1alpha/{instance}/legacyPlaybooks:legacyDuplicateWorkflowslegacyDuplicateWorkflows duplicates workflows. | 
| legacyExecuteManualStep | POST /v1alpha/{instance}/legacyPlaybooks:legacyExecuteManualStepLegacyPlaybookExecuteManualStep executes a manual step. | 
| legacyExecuteStep | POST /v1alpha/{instance}/legacyPlaybooks:legacyExecuteStepLegacyPlaybookExecuteStep executes a step. | 
| legacyFetchActionResultsForSimulation | POST /v1alpha/{instance}/legacyPlaybooks:legacyFetchActionResultsForSimulationLegacyPlaybookFetchActionResultsForSimulation returns action results for workflow instance id filtered by loop iteration. | 
| legacyGetActionResultsOfWFId | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetActionResultsOfWFIdLegacyPlaybookGetActionResultsOfWFId returns action results by workflow (playbook) instance id. | 
| legacyGetAiGenerationStatusByAlert | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetAiGenerationStatusByAlertGet a status of AI generation of a playbook based on a given security alert. | 
| legacyGetCaseEntities | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetCaseEntitiesLegacyPlaybookGetCaseEntities get case entities. | 
| legacyGetContextGroupByKey | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetContextGroupByKeyLegacyPlaybookGetContextGroupByKey returns the context group by key. | 
| legacyGetDebugStepCaseData | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetDebugStepCaseDataLegacyPlaybookGetDebugStepCaseData gets the debug step case data. | 
| legacyGetEnabledWFCards | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetEnabledWFCardsGet enabled workflow cards. | 
| legacyGetEnabledWFNames | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetEnabledWFNamesGet enabled workflow names. | 
| legacyGetHtmlViewPresets | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetHtmlViewPresetsLegacyPlaybookGetHtmlViewPresets gets the html view presets. | 
| legacyGetNestedPlaybookParams | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetNestedPlaybookParamsGet Nested Playbooks by environments as steps. | 
| legacyGetNestedPlaybooksAsSteps | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetNestedPlaybooksAsStepsGet Nested Playbooks as steps. | 
| legacyGetNestedPlaybooksByEnvironmentsAsSteps | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetNestedPlaybooksByEnvironmentsAsStepsGet Nested Playbooks by environments as steps. | 
| legacyGetNestedWorkflowDefaultInputs | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetNestedWorkflowDefaultInputsLegacyPlaybookGetNestedWorkflowDefaultInputs get the latest input values for a nested workflow. | 
| legacyGetOverviewTemplate | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetOverviewTemplateLegacyPlaybookGetOverviewTemplate returns the overview template by template identifier. | 
| legacyGetOverviewTemplates | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetOverviewTemplatesLegacyPlaybookGetOverviewTemplateByPlaybookIdentifier returns the overview template by playbook identifier. | 
| legacyGetPendingStep | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetPendingStepGet legacyGetPendingStep returns a pending step by alert identifier. | 
| legacyGetPendingStepsCountForUser | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetPendingStepsCountForUserGet legacyGetPendingStepsCountForUser returns pending steps count for the user running the request. | 
| legacyGetPendingStepsUserRelated | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetPendingStepsUserRelatedGet legacyGetPendingStepsUserRelated returns pending steps related to the user. | 
| legacyGetPlaybookSimulationEnrichment | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetPlaybookSimulationEnrichmentLegacyPlaybookGetPlaybookSimulationEnrichment returns the playbook simulation enrichment. | 
| legacyGetPlaybookStatsMap | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetPlaybookStatsMapLegacyPlaybookGetPlaybookStatsMap returns statistic data related to the workflow (such as number of runs, distribution by time, etc.). | 
| legacyGetPlaybooksUsingBlocks | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetPlaybooksUsingBlocksGet legacyGetPlaybooksUsingBlocks returns a list of the existing playbooks using blocks based on the block identifiers provided. | 
| legacyGetTriggerTags | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetTriggerTagsLegacyPlaybookGetTriggerTags returns a list of all the tags that are relevant to the trigger type tag. | 
| legacyGetWorkFlowVersionLogs | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkFlowVersionLogsLegacyPlaybookGetWorkFlowVersionLogs gets workflow version logs. | 
| legacyGetWorkflowCategories | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowCategoriesGet workflow categories. | 
| legacyGetWorkflowFullInfoByIdentifier | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowFullInfoByIdentifierGet legacyGetWorkflowFullInfoByIdentifier returns full info of a workflow by identifier. | 
| legacyGetWorkflowFullInfoWithEnvFilterByIdentifier | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowFullInfoWithEnvFilterByIdentifierGet legacyGetWorkflowFullInfoWithEnvFilterByIdentifier returns full info of a workflow by identifier including environment filter. | 
| legacyGetWorkflowInstance | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowInstanceLegacyPlaybookExecuteManualStep returns the Instance (done \ pending) that was created for a given case+alert Identifier combo and the wf identifier. | 
| legacyGetWorkflowInstanceSummary | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowInstanceSummaryLegacyPlaybookGetWorkflowInstanceSummary returns the summary of an executed playbook for a given case including the alert and playbook Identifiers. | 
| legacyGetWorkflowInstancesCards | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowInstancesCardsLegacyPlaybookGetWorkflowInstancesCards returns the workflow instances cards for a given case+alert Identifier combo. | 
| legacyGetWorkflowMenuCard | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowMenuCardGet legacyGetWorkflowMenuCard returns a workflow menu card by identifier. | 
| legacyGetWorkflowMenuCardWithEnvFilter | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowMenuCardWithEnvFilterGet legacyGetWorkflowMenuCardWithEnvFilter returns a workflow menu card by identifier with environment filter. | 
| legacyGetWorkflowMenuCards | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowMenuCardsGet legacyGetWorkflowMenuCards returns a list of the existing playbook cards. | 
| legacyGetWorkflowMenuCardsWithEnvFilter | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowMenuCardsWithEnvFilterGet legacyGetWorkflowMenuCards returns a list of the existing playbook cards with environment filter. | 
| legacyGetWorkflowStepInstance | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowStepInstanceLegacyPlaybookGetWorkflowStepInstance returns a workflow step instance. | 
| legacyGetWorkflowsContainsActionAsync | GET /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowsContainsActionAsyncGet legacyGetWorkflowsContainsActionAsync returns workflows containing a specified action asynchronously. | 
| legacyGetWorkflowsInvolvingAction | POST /v1alpha/{instance}/legacyPlaybooks:legacyGetWorkflowsInvolvingActionLegacyPlaybookGetWorkflowsInvolvingAction returns a list of actions that are part of the workflow. | 
| legacyMoveDefinitionsToCategory | POST /v1alpha/{instance}/legacyPlaybooks:legacyMoveDefinitionsToCategoryLegacyPlaybookMoveDefinitionsToCategory moves the workflow definitions to a selected category. | 
| legacyPermissions | DELETE /v1alpha/{instance}/legacyPlaybooks:legacyPermissionsLegacyPlaybookDeletePermissions Removes all access permissions for the given workflow. | 
| legacyPermissionsOptions | POST /v1alpha/{instance}/legacyPlaybooks:legacyPermissionsOptionsLegacyPlaybookPermissionsOptions return playbook access permission options. | 
| legacyRemoveCategories | POST /v1alpha/{instance}/legacyPlaybooks:legacyRemoveCategoriesRemove workflow categories. | 
| legacyRerunBlock | POST /v1alpha/{instance}/legacyPlaybooks:legacyRerunBlockLegacyPlaybookRerunBlock reruns block on a given alert. | 
| legacyRerunPlaybook | POST /v1alpha/{instance}/legacyPlaybooks:legacyRerunPlaybookLegacyPlaybookRerunPlaybook reruns a playbook on a given alert. | 
| legacyRestoreWorkflowDefinition | POST /v1alpha/{instance}/legacyPlaybooks:legacyRestoreWorkflowDefinitionLegacyPlaybookRestoreWorkflowDefinition restores workflow definition. | 
| legacyRunPlaybookInDebug | POST /v1alpha/{instance}/legacyPlaybooks:legacyRunPlaybookInDebugRun playbook in debug mode. | 
| legacySaveLogVersionOfWorkflowDefinitions | POST /v1alpha/{instance}/legacyPlaybooks:legacySaveLogVersionOfWorkflowDefinitionsLegacyPlaybookSaveLogVersionOfWorkflowDefinitions saves log version of workflow definitions. | 
| legacySaveWorkflowDefinitions | POST /v1alpha/{instance}/legacyPlaybooks:legacySaveWorkflowDefinitionsSave workflow definitions. | 
| legacySkip | POST /v1alpha/{instance}/legacyPlaybooks:legacySkipLegacyPlaybookSkip will skip a pending playbook action, resulting in the execution of the following steps. | 
| legacyTestPipeExample | POST /v1alpha/{instance}/legacyPlaybooks:legacyTestPipeExampleLegacyPlaybookTestPipeExample tests a pipe example. | 
| legacyUpdateDefinitionsPriority | POST /v1alpha/{instance}/legacyPlaybooks:legacyUpdateDefinitionsPriorityLegacyPlaybookUpdateDefinitionsPriority updates the priority of the workflow definitions. | 
REST Resource: v1alpha.projects.locations.instances.legacyPublisher
| Methods | |
|---|---|
| legacyAddConnectorPackage | POST /v1alpha/{instance}/legacyPublisher:legacyAddConnectorPackageLegacy endpoint for uploading a connector package.. | 
| legacyCloudLog | POST /v1alpha/{instance}/legacyPublisher:legacyCloudLogLegacy endpoint for sending a log to the Publisher. | 
| legacyCreateConnectorPackage | POST /v1alpha/{instance}/legacyPublisher:legacyCreateConnectorPackagePOST /upload/v1alpha/{instance}/legacyPublisher:legacyCreateConnectorPackageLegacy endpoint for creating a connector package of an integration. | 
| legacyDeleteIntegration | POST /v1alpha/{instance}/legacyPublisher:legacyDeleteIntegrationLegacy endpoint for deleting integration from Publisher. | 
| legacyGetDependencyFile | GET /v1alpha/{instance}/legacyPublisher:legacyGetDependencyFileLegacy endpoint for getting a dependency file of an integration. | 
| legacyGetHasLocallyScheduledRemoteConnectors | GET /v1alpha/{instance}/legacyPublisher:legacyGetHasLocallyScheduledRemoteConnectorsLegacy endpoint for checking if the integration has locally scheduled remote connectors. | 
| legacyGetInstaller | GET /v1alpha/{instance}/legacyPublisher:legacyGetInstallerLegacy endpoint for downloading the installer file of the remote agent. | 
| legacyGetIntegrationDependencies | GET /v1alpha/{instance}/legacyPublisher:legacyGetIntegrationDependenciesLegacy endpoint for getting all the dependencies of the integration. | 
| legacyGetLatestIntegrationVersion | GET /v1alpha/{instance}/legacyPublisher:legacyGetLatestIntegrationVersionLegacy endpoint for getting the latest version of an integration. | 
| legacyGetTaskData | GET /v1alpha/{instance}/legacyPublisher:legacyGetTaskDataLegacy endpoint for getting a task data. | 
| legacyKeepAlive | POST /v1alpha/{instance}/legacyPublisher:legacyKeepAliveLegacy endpoint for sending keep alive message to Publisher. | 
| legacyListTasks | GET /v1alpha/{instance}/legacyPublisher:legacyListTasksLegacy endpoint for listing remote tasks. | 
| legacyPing | GET /v1alpha/{instance}/legacyPublisher:legacyPingLegacy endpoint for pinging the Publisher server. | 
| legacySetUpgradeInProgress | POST /v1alpha/{instance}/legacyPublisher:legacySetUpgradeInProgressLegacy endpoint for updating upgrade_in_progress status. | 
| legacyUpdateIntegrationStatus | POST /v1alpha/{instance}/legacyPublisher:legacyUpdateIntegrationStatusLegacy endpoint for updating integration status. | 
| legacyUpdateTask | POST /v1alpha/{instance}/legacyPublisher:legacyUpdateTaskLegacy endpoint for updating task status. | 
| legacyUpdateTaskResult | POST /v1alpha/{instance}/legacyPublisher:legacyUpdateTaskResultPOST /upload/v1alpha/{instance}/legacyPublisher:legacyUpdateTaskResultLegacy endpoint for updating a task result. | 
REST Resource: v1alpha.projects.locations.instances.legacySdk
| Methods | |
|---|---|
| legacyAddAgentConnectorLogs | POST /v1alpha/{instance}/legacySdk:legacyAddAgentConnectorLogsLegacy RPC for add agent connector logs. | 
| legacyAddAgentLogs | POST /v1alpha/{instance}/legacySdk:legacyAddAgentLogsLegacy RPC for add agent logs. | 
| legacyAddAttachment | POST /v1alpha/{instance}/legacySdk:legacyAddAttachmentLegacy RPC for add attachment. | 
| legacyAddComment | POST /v1alpha/{instance}/legacySdk:legacyAddCommentLegacy RPC for add comment. | 
| legacyAddEntitiesToCustomList | POST /v1alpha/{instance}/legacySdk:legacyAddEntitiesToCustomListLegacy RPC for add entities to custom list. | 
| legacyAddOrUpdateCaseTask | POST /v1alpha/{instance}/legacySdk:legacyAddOrUpdateCaseTaskLegacy RPC for add or update case task. | 
| legacyAddTag | POST /v1alpha/{instance}/legacySdk:legacyAddTagLegacy RPC for adding tag. | 
| legacyAlertFullDetails | POST /v1alpha/{instance}/legacySdk:legacyAlertFullDetailsLegacy RPC for getting alert full details. | 
| legacyAlertSourceFile | GET /v1alpha/{instance}/legacySdk:legacyAlertSourceFileLegacy RPC for getting alert source file. | 
| legacyAlertsFullDetails | GET /v1alpha/{instance}/legacySdk:legacyAlertsFullDetailsLegacy RPC for getting alerts full details. | 
| legacyAlertsTicketIdsByCaseId | GET /v1alpha/{instance}/legacySdk:legacyAlertsTicketIdsByCaseIdLegacy RPC for getting alerts ticket ids by case id. | 
| legacyAnyEntityInCustomList | POST /v1alpha/{instance}/legacySdk:legacyAnyEntityInCustomListLegacy RPC for check any entity in custom list. | 
| legacyAssignUser | POST /v1alpha/{instance}/legacySdk:legacyAssignUserLegacy RPC for assign user to case. | 
| legacyAttachWorkflowToCase | POST /v1alpha/{instance}/legacySdk:legacyAttachWorkflowToCaseLegacy RPC for attach workflow to case. | 
| legacyAttachmentData | GET /v1alpha/{instance}/legacySdk:legacyAttachmentDataLegacy RPC for getting attachment. | 
| legacyAttachments | GET /v1alpha/{instance}/legacySdk:legacyAttachmentsLegacy RPC for getting attachments. | 
| legacyCaseFullDetails | GET /v1alpha/{instance}/legacySdk:legacyCaseFullDetailsLegacy RPC for getting case full details. | 
| legacyCaseMetadata | GET /v1alpha/{instance}/legacySdk:legacyCaseMetadataLegacy RPC for getting case metadata. | 
| legacyChangeCaseStage | POST /v1alpha/{instance}/legacySdk:legacyChangeCaseStageLegacy RPC for change case stage. | 
| legacyChangePriority | POST /v1alpha/{instance}/legacySdk:legacyChangePriorityLegacy RPC for change case priority. | 
| legacyCloseAlert | POST /v1alpha/{instance}/legacySdk:legacyCloseAlertLegacy RPC for close alert. | 
| legacyCloseCase | POST /v1alpha/{instance}/legacySdk:legacyCloseCaseLegacy RPC for close case. | 
| legacyCreateCase | POST /v1alpha/{instance}/legacySdk:legacyCreateCaseLegacy RPC for create case. | 
| legacyCreateCaseInsight | POST /v1alpha/{instance}/legacySdk:legacyCreateCaseInsightLegacy RPC for creating case insight. | 
| legacyCreateConnectorPackage | POST /v1alpha/{instance}/legacySdk:legacyCreateConnectorPackageLegacy RPC for create connector package. | 
| legacyCreateEntity | POST /v1alpha/{instance}/legacySdk:legacyCreateEntityLegacy RPC for create entity. | 
| legacyGetAgentById | GET /v1alpha/{instance}/legacySdk:legacyGetAgentByIdLegacy RPC for get agent by id. | 
| legacyGetAlertsTicketIdsFromCasesClosedSinceTimestamp | POST /v1alpha/{instance}/legacySdk:legacyGetAlertsTicketIdsFromCasesClosedSinceTimestampLegacy RPC for getting alerts ticket ids from cases closed since timestamp. | 
| legacyGetAlertsToSync | POST /v1alpha/{instance}/legacySdk:legacyGetAlertsToSyncLegacy RPC for get alerts to sync. | 
| legacyGetCaseClosureDetails | POST /v1alpha/{instance}/legacySdk:legacyGetCaseClosureDetailsLegacy RPC for getting case closure details. | 
| legacyGetCaseComments | GET /v1alpha/{instance}/legacySdk:legacyGetCaseCommentsLegacy RPC for getting case comments. | 
| legacyGetCaseTasks | GET /v1alpha/{instance}/legacySdk:legacyGetCaseTasksLegacy RPC for getting case tasks. | 
| legacyGetCasesByFilter | POST /v1alpha/{instance}/legacySdk:legacyGetCasesByFilterLegacy RPC for getting cases by filter. | 
| legacyGetCasesByRequest | POST /v1alpha/{instance}/legacySdk:legacyGetCasesByRequestLegacy RPC for get cases by request. | 
| legacyGetCasesIdByFilter | POST /v1alpha/{instance}/legacySdk:legacyGetCasesIdByFilterLegacy RPC for getting cases id by filter. | 
| legacyGetConnectorParameters | GET /v1alpha/{instance}/legacySdk:legacyGetConnectorParametersLegacy RPC for getting connector parameters. | 
| legacyGetContextProperty | POST /v1alpha/{instance}/legacySdk:legacyGetContextPropertyLegacy RPC for getting context property. | 
| legacyGetCurrentSiemplifyVersion | GET /v1alpha/{instance}/legacySdk:legacyGetCurrentSiemplifyVersionLegacy RPC for getting current siemplify version. | 
| legacyGetCustomListCategories | GET /v1alpha/{instance}/legacySdk:legacyGetCustomListCategoriesLegacy RPC for getting custom list categories. | 
| legacyGetFailedActions | GET /v1alpha/{instance}/legacySdk:legacyGetFailedActionsLegacy RPC for getting failed actions. | 
| legacyGetFailedConnectors | POST /v1alpha/{instance}/legacySdk:legacyGetFailedConnectorsLegacy RPC for getting failed connectors. | 
| legacyGetFailedETLOperations | GET /v1alpha/{instance}/legacySdk:legacyGetFailedETLOperationsLegacy RPC for getting failed ETL operations. | 
| legacyGetFailedJobs | GET /v1alpha/{instance}/legacySdk:legacyGetFailedJobsLegacy RPC for getting failed jobs. | 
| legacyGetIntegrationVersion | GET /v1alpha/{instance}/legacySdk:legacyGetIntegrationVersionLegacy RPC for getting integration version. | 
| legacyGetProxySettings | GET /v1alpha/{instance}/legacySdk:legacyGetProxySettingsLegacy RPC for getting proxy settings. | 
| legacyGetPublisherById | GET /v1alpha/{instance}/legacySdk:legacyGetPublisherByIdLegacy RPC for getting publisher by ID. | 
| legacyGetRemoteConnectorsKeysMap | GET /v1alpha/{instance}/legacySdk:legacyGetRemoteConnectorsKeysMapLegacy RPC for getting remote connectors keys map. | 
| legacyGetSimilarCasesIds | POST /v1alpha/{instance}/legacySdk:legacyGetSimilarCasesIdsLegacy RPC for getting similar cases ids. | 
| legacyGetSyncAlerts | POST /v1alpha/{instance}/legacySdk:legacyGetSyncAlertsLegacy RPC for getting sync alerts. | 
| legacyGetSyncCases | POST /v1alpha/{instance}/legacySdk:legacyGetSyncCasesLegacy RPC for getting sync cases. | 
| legacyGetUpdatedSyncAlertsMetadata | POST /v1alpha/{instance}/legacySdk:legacyGetUpdatedSyncAlertsMetadataLegacy RPC for getting updated sync alerts metadata. | 
| legacyGetUpdatedSyncCasesMetadata | POST /v1alpha/{instance}/legacySdk:legacyGetUpdatedSyncCasesMetadataLegacy RPC for getting updated sync cases metadata. | 
| legacyGetUserFullName | GET /v1alpha/{instance}/legacySdk:legacyGetUserFullNameLegacy RPC for getting user full name. | 
| legacyIntegrationConfiguration | GET /v1alpha/{instance}/legacySdk:legacyIntegrationConfigurationLegacy RPC for getting integration configuration. | 
| legacyMarkAsImportant | POST /v1alpha/{instance}/legacySdk:legacyMarkAsImportantLegacy RPC for mark as important. | 
| legacyRaiseIncident | POST /v1alpha/{instance}/legacySdk:legacyRaiseIncidentLegacy RPC for raise incident. | 
| legacyRemoveEntitiesFromCustomList | POST /v1alpha/{instance}/legacySdk:legacyRemoveEntitiesFromCustomListLegacy RPC for remove entities from custom list. | 
| legacySendEmailWithAttachment | POST /v1alpha/{instance}/legacySdk:legacySendEmailWithAttachmentLegacy RPC for send email with attachment. | 
| legacySendSystemNotification | POST /v1alpha/{instance}/legacySdk:legacySendSystemNotificationLegacy RPC for sending system notification. | 
| legacySetAlertSla | POST /v1alpha/{instance}/legacySdk:legacySetAlertSlaLegacy RPC for setting alert sla. | 
| legacySetCaseSla | POST /v1alpha/{instance}/legacySdk:legacySetCaseSlaLegacy RPC for setting case sla. | 
| legacySetContextProperty | POST /v1alpha/{instance}/legacySdk:legacySetContextPropertyLegacy RPC for setting context property. | 
| legacySystemInfo | GET /v1alpha/{instance}/legacySdk:legacySystemInfoLegacy RPC for getting system info. | 
| legacyTrySetContextProperty | POST /v1alpha/{instance}/legacySdk:legacyTrySetContextPropertyLegacy RPC for setting context property. | 
| legacyUnraiseIncident | POST /v1alpha/{instance}/legacySdk:legacyUnraiseIncidentLegacy RPC for unraising incident. | 
| legacyUpdateAlertPriority | POST /v1alpha/{instance}/legacySdk:legacyUpdateAlertPriorityLegacy RPC for update alert priority. | 
| legacyUpdateAlertsAdditional | POST /v1alpha/{instance}/legacySdk:legacyUpdateAlertsAdditionalLegacy RPC for update alerts additional data. | 
| legacyUpdateBatchCasesExternalCaseIds | POST /v1alpha/{instance}/legacySdk:legacyUpdateBatchCasesExternalCaseIdsLegacy RPC for update batch cases external case ids. | 
| legacyUpdateCaseScore | PATCH /v1alpha/{instance}/legacySdk:legacyUpdateCaseScoreLegacy RPC for updating case score. | 
| legacyUpdateConfigurationProperty | PUT /v1alpha/{instance}/legacySdk:legacyUpdateConfigurationPropertyLegacy RPC for update configuration property. | 
| legacyUpdateConnectorParameter | PUT /v1alpha/{instance}/legacySdk:legacyUpdateConnectorParameterLegacy RPC for update connector parameter. | 
| legacyUpdateEntities | POST /v1alpha/{instance}/legacySdk:legacyUpdateEntitiesLegacy RPC for updating entities. | 
| legacyUpdateNewAlertsSyncStatus | POST /v1alpha/{instance}/legacySdk:legacyUpdateNewAlertsSyncStatusLegacy RPC for updating the sync status of new alerts. | 
REST Resource: v1alpha.projects.locations.instances.legacySoarAudit
| Methods | |
|---|---|
| legacyExportAuditLastWeekAsCsvV2 | POST /v1alpha/{instance}/legacySoarAudit:legacyExportAuditLastWeekAsCsvV2Exports the audit data for the last week as a CSV file. | 
| legacyGetAuditDataV2 | POST /v1alpha/{instance}/legacySoarAudit:legacyGetAuditDataV2Gets the audit data. | 
REST Resource: v1alpha.projects.locations.instances.legacySoarDashboard
| Methods | |
|---|---|
| legacyAddOrUpdateDashboard | POST /v1alpha/{instance}/legacySoarDashboard:legacyAddOrUpdateDashboardAdds a new dashboard or updates an existing one (determined by dashboard identifier). | 
| legacyAddOrUpdateDashboardWidget | POST /v1alpha/{instance}/legacySoarDashboard:legacyAddOrUpdateDashboardWidgetAdds a new dashboard widget or update an existing one (determined by widget identifier). | 
| legacyDeleteDashboard | POST /v1alpha/{instance}/legacySoarDashboard:legacyDeleteDashboardDeletes a dashboard. | 
| legacyDeleteDashboardWidget | POST /v1alpha/{instance}/legacySoarDashboard:legacyDeleteDashboardWidgetDeletes a dashboard widget. | 
| legacyGetCasesTimeToRespond | GET /v1alpha/{instance}/legacySoarDashboard:legacyGetCasesTimeToRespondReturns the time to respond for cases in the dashboard. | 
| legacyGetDashboard | POST /v1alpha/{name}/legacySoarDashboard:legacyGetDashboardReturns a dashboard by id. | 
| legacyGetDashboardCards | GET /v1alpha/{instance}/legacySoarDashboard:legacyGetDashboardCardsReturns the cards of a dashboard. | 
| legacyGetDashboardCustomWidgetCaseIds | POST /v1alpha/{instance}/legacySoarDashboard:legacyGetDashboardCustomWidgetCaseIdsReturns the case ids of a custom widget in a dashboard. | 
| legacyGetDashboardPlaybookRuns | POST /v1alpha/{instance}/legacySoarDashboard:legacyGetDashboardPlaybookRunsReturns the playbook runs of a dashboard. | 
| legacyGetDashboardPlaybooks | GET /v1alpha/{instance}/legacySoarDashboard:legacyGetDashboardPlaybooksReturns the playbooks of a dashboard. | 
| legacyGetDashboardWidgetCaseIds | POST /v1alpha/{instance}/legacySoarDashboard:legacyGetDashboardWidgetCaseIdsReturns the case ids of a widget in a dashboard. | 
| legacyGetDashboardWidgetDefinitions | GET /v1alpha/{instance}/legacySoarDashboard:legacyGetDashboardWidgetDefinitionsReturns the widget definitions of a dashboard. | 
| legacyGetDashboardWidgetValues | POST /v1alpha/{instance}/legacySoarDashboard:legacyGetDashboardWidgetValuesReturns the values of a widget in a dashboard. | 
| legacyGetOpenedAndClosedCasesTrends | GET /v1alpha/{instance}/legacySoarDashboard:legacyGetOpenedAndClosedCasesTrendsReturns the opened and closed cases trends. | 
| legacyGetPlaybookMonitoring | POST /v1alpha/{instance}/legacySoarDashboard:legacyGetPlaybookMonitoringReturns the playbook monitoring data of a dashboard. | 
| legacyImportDashboard | POST /v1alpha/{instance}/legacySoarDashboard:legacyImportDashboardImports a dashboard from a file. | 
| legacySaveDashboardAsReportTemplate | POST /v1alpha/{instance}/legacySoarDashboard:legacySaveDashboardAsReportTemplateSaves a dashboard as a report template. | 
REST Resource: v1alpha.projects.locations.instances.legacySoarIdpMappingGroups
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/legacySoarIdpMappingGroupsCreates a LegacySoarIdpMappingGroup. | 
| delete | DELETE /v1alpha/{name}Deletes a LegacySoarIdpMappingGroup. | 
| get | GET /v1alpha/{name}Gets a LegacySoarIdpMappingGroup. | 
| getExternalProviders | GET /v1alpha/{name}/legacySoarIdpMappingGroups:getExternalProvidersGets the external providers for a LegacySoarIdpMappingGroup. | 
| list | GET /v1alpha/{parent}/legacySoarIdpMappingGroupsLists LegacySoarIdpMappingGroups. | 
| patch | PATCH /v1alpha/{legacySoarIdpMappingGroup.name}Updates a LegacySoarIdpMappingGroup. | 
| updateDefaultAccessSettings | POST /v1alpha/{name}/legacySoarIdpMappingGroups:updateDefaultAccessSettingsPatches the external providers for a LegacySoarIdpMappingGroup. | 
REST Resource: v1alpha.projects.locations.instances.legacySoarSettings
| Methods | |
|---|---|
| legacyAddVisualSummaryRecords | POST /v1alpha/{instance}/legacySoarSettings:legacyAddVisualSummaryRecordsAddVisualSummaryRecords adds visual summary records to the environment. | 
| legacyGetAllPlaybookActionDefinitions | GET /v1alpha/{instance}/legacySoarSettings:legacyGetAllPlaybookActionDefinitionsLegacyGetAllPlaybookActionDefinitions returns all playbook action definitions. | 
| legacyGetCaseAlertPlaybookTriggerFilterValues | GET /v1alpha/{instance}/legacySoarSettings:legacyGetCaseAlertPlaybookTriggerFilterValuesLegacyGetCaseAlertPlaybookTriggerFilterValues returns the case alert playbook trigger filter values. | 
| legacyGetCaseAlertTypeFilterValues | GET /v1alpha/{instance}/legacySoarSettings:legacyGetCaseAlertTypeFilterValuesLegacyGetCaseAlertTypeFilterValues returns the case alert type filter values. | 
| legacyGetCustomActionDetailsById | GET /v1alpha/{instance}/legacySoarSettings:legacyGetCustomActionDetailsByIdLegacyGetCustomActionDetailsById returns the custom action details by id. | 
| legacyGetDataSourcesForGroupingRule | POST /v1alpha/{instance}/legacySoarSettings:legacyGetDataSourcesForGroupingRuleLegacyGetDataSourcesForGroupingRule returns the data sources for grouping rule. | 
| legacyGetEnvironmentActionDefinitions | POST /v1alpha/{instance}/legacySoarSettings:legacyGetEnvironmentActionDefinitionsLegacyGetEnvironmentActionDefinitions returns the environment action definitions. | 
| legacyGetEnvironmentStatistics | POST /v1alpha/{instance}/legacySoarSettings:legacyGetEnvironmentStatisticsLegacyGetEnvironmentStatistics returns the environment statistics. | 
| legacyGetPlaybookActionDefinitions | POST /v1alpha/{instance}/legacySoarSettings:legacyGetPlaybookActionDefinitionsLegacyGetPlaybookActionDefinitions returns the playbook action definitions. | 
| legacyGetProductsForGroupingRule | POST /v1alpha/{instance}/legacySoarSettings:legacyGetProductsForGroupingRuleLegacyGetProductsForGroupingRule returns the products for grouping rule. | 
| legacyGetSystemEventEntityTypes | GET /v1alpha/{instance}/legacySoarSettings:legacyGetSystemEventEntityTypesLegacyGetSystemEventEntityTypes returns the system event entity types. | 
| legacyGetTimeZones | GET /v1alpha/{instance}/legacySoarSettings:legacyGetTimeZonesLegacyGetTimeZones returns the time zones. | 
| legacyGetUserRegistrationSettings | GET /v1alpha/{instance}/legacySoarSettings:legacyGetUserRegistrationSettingsLegacyGetUserRegistrationSettings returns the user registration settings. | 
| legacyGetVisualSummaryRecords | GET /v1alpha/{instance}/legacySoarSettings:legacyGetVisualSummaryRecordsLegacyGetVisualSummaryRecords returns the visual summary records. | 
| legacyIsPermittedToEnvironment | GET /v1alpha/{instance}/legacySoarSettings:legacyIsPermittedToEnvironmentLegacyIsPermittedToEnvironment checks if the user is permitted to the environment. | 
| legacyTestEmailSettings | POST /v1alpha/{instance}/legacySoarSettings:legacyTestEmailSettingsLegacyTestEmailSettings tests the email settings. | 
| legacyUploadCustomActionResultJson | POST /v1alpha/{instance}/legacySoarSettings:legacyUploadCustomActionResultJsonLegacyUploadCustomActionResultJson uploads the custom action result json. | 
REST Resource: v1alpha.projects.locations.instances.legacySoarUsers
| Methods | |
|---|---|
| delete | DELETE /v1alpha/{name}Delete a LegacySoarUser. | 
| get | GET /v1alpha/{name}Get a LegacySoarUser. | 
| getLocalization | GET /v1alpha/{name}Get a user Localization. | 
| getNotificationSettings | GET /v1alpha/{name}Gets the notification settings for a user. | 
| list | GET /v1alpha/{parent}/legacySoarUsersLists LegacySoarUsers. | 
| updateLocalization | PATCH /v1alpha/{userLocalization.name}Update a user localization. | 
| updateNotificationSettings | PATCH /v1alpha/{notificationSettings.name}Updates the notification settings for a user. | 
REST Resource: v1alpha.projects.locations.instances.legacySoarUsers.attachments
| Methods | |
|---|---|
| delete | DELETE /v1alpha/{name}Delete an Attachment. | 
| download | GET /v1alpha/{name}:downloadExport an Attachment. | 
| get | GET /v1alpha/{name}Get an Attachment. | 
| list | GET /v1alpha/{parent}/attachmentsList Attachments. | 
| upload | POST /v1alpha/{parent}/attachments:createPOST /upload/v1alpha/{parent}/attachments:createCreate an Attachment. | 
REST Resource: v1alpha.projects.locations.instances.legacySoarUsers.userNotifications
| Methods | |
|---|---|
| count | GET /v1alpha/{parent}/userNotifications:countCounts UserNotifications for a given user. | 
| get | GET /v1alpha/{name}Get a User UserNotification. | 
| list | GET /v1alpha/{parent}/userNotificationsLists User Notifications. | 
| markAsRead | POST /v1alpha/{parent}/userNotifications:markAsReadMarks UserNotification as read. | 
REST Resource: v1alpha.projects.locations.instances.legacySoarUsers.workdeskContacts
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/workdeskContactsCreate a WorkdeskContact. | 
| delete | DELETE /v1alpha/{name}Delete a WorkdeskContact. | 
| get | GET /v1alpha/{name}Get a SOAR WorkdeskContact. | 
| list | GET /v1alpha/{parent}/workdeskContactsLists SOAR workdeskContacts. | 
| patch | PATCH /v1alpha/{workdeskContact.name}Update a WorkdeskContact. | 
REST Resource: v1alpha.projects.locations.instances.legacySoarUsers.workdeskLinks
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/workdeskLinksCreate a WorkdeskLink. | 
| delete | DELETE /v1alpha/{name}Delete a WorkdeskLink. | 
| get | GET /v1alpha/{name}Get a WorkdeskLink. | 
| list | GET /v1alpha/{parent}/workdeskLinksList page of WorkdeskLinks. | 
| patch | PATCH /v1alpha/{workdeskLink.name}Update a WorkdeskLink. | 
REST Resource: v1alpha.projects.locations.instances.legacySoarUsers.workdeskNotes
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/workdeskNotesCreate a WorkdeskNote. | 
| delete | DELETE /v1alpha/{name}Delete a WorkdeskNote. | 
| get | GET /v1alpha/{name}Get a SOAR WorkdeskNote. | 
| list | GET /v1alpha/{parent}/workdeskNotesLists SOAR WorkdeskNotes. | 
| patch | PATCH /v1alpha/{workdeskNote.name}Update a WorkdeskNote. | 
REST Resource: v1alpha.projects.locations.instances.legacySystem
| Methods | |
|---|---|
| legacyGetLicenseStatus | GET /v1alpha/{instance}/legacySystem:legacyGetLicenseStatusLegacy endpoint for getting the license status. | 
| legacyGetMaximumDataRetentionValue | GET /v1alpha/{instance}/legacySystem:legacyGetMaximumDataRetentionValueLegacy endpoint for getting the maximum data retention value. | 
| legacyGetSystemVersion | GET /v1alpha/{instance}/legacySystem:legacyGetSystemVersionLegacy endpoint for getting the system version. | 
REST Resource: v1alpha.projects.locations.instances.legacySystemMetadata
| Methods | |
|---|---|
| placeholders | GET /v1alpha/{instance}/legacySystemMetadata:placeholdersLegacy Get Placeholder Names. | 
REST Resource: v1alpha.projects.locations.instances.logProcessingPipelines
| Methods | |
|---|---|
| associateStreams | POST /v1alpha/{name}:associateStreamsMaps a set of streams to a log processing pipeline. | 
| create | POST /v1alpha/{parent}/logProcessingPipelinesCreate a new LogProcessingPipeline | 
| delete | DELETE /v1alpha/{name}Deletes a LogProcessingPipeline configuration. | 
| dissociateStreams | POST /v1alpha/{name}:dissociateStreamsUnmaps a set of streams from a log processing pipeline. | 
| fetchAssociatedPipeline | GET /v1alpha/{parent}/logProcessingPipelines:fetchAssociatedPipelineFetch LogProcessingPipeline, if any, is associated with a given stream. | 
| fetchSampleLogsByStreams | POST /v1alpha/{parent}/logProcessingPipelines:fetchSampleLogsByStreamsFetchSampleLogsByStreams previews sample unprocessed logs for a given log processing pipeline. | 
| get | GET /v1alpha/{name}Get details of a specific LogProcessingPipeline. | 
| list | GET /v1alpha/{parent}/logProcessingPipelinesLists LogProcessingPipeline configurations in a given project, location and SecOps instance. | 
| patch | PATCH /v1alpha/{logProcessingPipeline.name}Updates an existing LogProcessingPipeline configuration. | 
| testPipeline | POST /v1alpha/{parent}/logProcessingPipelines:testPipelineTestPipeline previews processed logs for a given log processing pipeline for a given input sample logs. | 
REST Resource: v1alpha.projects.locations.instances.logTypes
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/logTypesCreate LogType. | 
| generateEventTypesSuggestions | POST /v1alpha/{logtype}:generateEventTypesSuggestionsGenerateEventTypesSuggestions generates event types suggestions that can be mapped by a lowcode parser. | 
| getLogTypeSetting | GET /v1alpha/{name}Gets a LogTypeSetting. | 
| legacySubmitParserExtension | POST /v1alpha/{parent}:legacySubmitParserExtensionLegacySubmitParserExtension creates validates and then makes the extension live. | 
| list | GET /v1alpha/{parent}/logTypesLists all LogTypes. | 
| runParser | POST /v1alpha/{logtype}:runParserRunParser runs the parser against a log and returns normalized events or any error that occurred during the normalization. | 
| updateLogTypeSetting | PATCH /v1alpha/{logTypeSetting.name}UpdateLogTypeSetting updates the log type setting for a log type. | 
REST Resource: v1alpha.projects.locations.instances.logTypes.logTypeSettings
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/logTypeSettingsLists all LogTypeSettings. | 
REST Resource: v1alpha.projects.locations.instances.logTypes.logs
| Methods | |
|---|---|
| import | POST /v1alpha/{parent}/logs:importImport log telemetry. | 
| list | GET /v1alpha/{parent}/logsLists all Logs. | 
REST Resource: v1alpha.projects.locations.instances.logTypes.parserExtensions
| Methods | |
|---|---|
| activate | POST /v1alpha/{name}:activateActivateParserExtension switches the customer to use requested parser extension, This will set the extension state to ACTIVE. | 
| create | POST /v1alpha/{parent}/parserExtensionsCreate a parser extension. | 
| delete | DELETE /v1alpha/{name}Delete a parser extension. | 
| get | GET /v1alpha/{name}Get a parser extension. | 
| list | GET /v1alpha/{parent}/parserExtensionsList all parser extensions. | 
REST Resource: v1alpha.projects.locations.instances.logTypes.parserExtensions.extensionValidationReports
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get a parser vaildation report. | 
| list | GET /v1alpha/{parent}/extensionValidationReportsList all parser validation reports for a parser extension. | 
REST Resource: v1alpha.projects.locations.instances.logTypes.parserExtensions.extensionValidationReports.validationErrors
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/validationErrorsList validation errors of a parser extension validation report. | 
REST Resource: v1alpha.projects.locations.instances.logTypes.parserExtensions.validationReports
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get a validation report. | 
REST Resource: v1alpha.projects.locations.instances.logTypes.parserExtensions.validationReports.parsingErrors
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/parsingErrorsList parsing errors of a validation report. | 
REST Resource: v1alpha.projects.locations.instances.logTypes.parsers
| Methods | |
|---|---|
| activate | POST /v1alpha/{name}:activateActivateParser switches the customer to use requested parser, This will set the Parser state to ACTIVE. | 
| activateReleaseCandidateParser | POST /v1alpha/{name}:activateReleaseCandidateParserActivateReleaseCandidateParser makes the release candidate parser live for that customer. | 
| copy | POST /v1alpha/{name}:copyCopyPrebuiltParser makes a copy of a prebuilt parser. | 
| create | POST /v1alpha/{parent}/parsersCreate a parser. | 
| deactivate | POST /v1alpha/{name}:deactivateDeactivateParser deactivates the requested parser, and activates the prebuilt release parser. | 
| delete | DELETE /v1alpha/{name}Delete a parser. | 
| fetchParserCandidates | GET /v1alpha/{name}/parsers:fetchParserCandidatesFetchParserCandidates fetches the parser candidates for a given log type. | 
| get | GET /v1alpha/{name}Get a parser. | 
| list | GET /v1alpha/{parent}/parsersList all parsers. | 
| patch | PATCH /v1alpha/{parser.name}Update a parser. | 
REST Resource: v1alpha.projects.locations.instances.logTypes.parsers.validationReports
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get a validation report. | 
REST Resource: v1alpha.projects.locations.instances.logTypes.parsers.validationReports.parsingErrors
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/parsingErrorsList parsing errors of a validation report. | 
REST Resource: v1alpha.projects.locations.instances.logs
| Methods | |
|---|---|
| classify | POST /v1alpha/{parent}/logs:classifyClassify the logs to the corresponding logType. | 
REST Resource: v1alpha.projects.locations.instances.marketplaceIntegrations
| Methods | |
|---|---|
| fetchCommercialDiff | GET /v1alpha/{name}:fetchCommercialDiffFetches the diff between the commercial and the marketplace integration. | 
| get | GET /v1alpha/{name}Gets a MarketplaceIntegration. | 
| install | POST /v1alpha/{parent}:installInstalls a MarketplaceIntegration. | 
| list | GET /v1alpha/{parent}/marketplaceIntegrationsLists MarketplaceIntegrations. | 
| uninstall | POST /v1alpha/{name}:uninstallUninstalls a MarketplaceIntegration. | 
REST Resource: v1alpha.projects.locations.instances.moduleSettings
| Methods | |
|---|---|
| get | GET /v1alpha/{name}Get a ModuleSettings. | 
| list | GET /v1alpha/{parent}/moduleSettingsList ModuleSettings. | 
| rebrandingSettings | GET /v1alpha/{parent}/moduleSettings:rebrandingSettingsThe method returns the rebranding settings. | 
REST Resource: v1alpha.projects.locations.instances.moduleSettings.properties
| Methods | |
|---|---|
| batchUpdate | POST /v1alpha/{parent}/properties:batchUpdateBatch update ModuleSettingsProperties. | 
| get | GET /v1alpha/{name}Get a ModuleSettingsProperty. | 
| list | GET /v1alpha/{parent}/propertiesList ModuleSettingsProperties. | 
| patch | PATCH /v1alpha/{moduleSettingsProperty.name}Update a ModuleSettingsProperty. | 
| testSettings | POST /v1alpha/{parent}/properties:testSettingsThe method tests the configured module settings, and by this ensures that all settings of the module were configured properly. | 
REST Resource: v1alpha.projects.locations.instances.nativeDashboards
| Methods | |
|---|---|
| addChart | POST /v1alpha/{name}:addChartAdd chart in a dashboard. | 
| create | POST /v1alpha/{parent}/nativeDashboardsCreate a dashboard. | 
| delete | DELETE /v1alpha/{name}Delete a dashboard. | 
| duplicate | POST /v1alpha/{name}:duplicateDuplicate a dashboard. | 
| duplicateChart | POST /v1alpha/{name}:duplicateChartDuplicate chart in a dashboard. | 
| editChart | POST /v1alpha/{name}:editChartEdit chart in a dashboard. | 
| export | POST /v1alpha/{parent}/nativeDashboards:exportExports the dashboards. | 
| get | GET /v1alpha/{name}Get a dashboard. | 
| import | POST /v1alpha/{parent}/nativeDashboards:importImports the dashboards. | 
| list | GET /v1alpha/{parent}/nativeDashboardsList all dashboards. | 
| patch | PATCH /v1alpha/{nativeDashboard.name}Update a dashboard. | 
| removeChart | POST /v1alpha/{name}:removeChartRemove chart from a dashboard. | 
REST Resource: v1alpha.projects.locations.instances.notebooks
| Methods | |
|---|---|
| get | GET /v1alpha/{name}GetNotebook is used to retrieve an notebook. | 
| list | GET /v1alpha/{parent}/notebooksListNotebooks is used to retrieve existing notebooks for a given instance. | 
REST Resource: v1alpha.projects.locations.instances.ontologyRecords
| Methods | |
|---|---|
| delete | DELETE /v1alpha/{name}Delete an ontology record. | 
| export | POST /v1alpha/{parent}/ontologyRecords:exportExport ontology records. | 
| get | GET /v1alpha/{name}Get specific ontology record. | 
| import | POST /v1alpha/{parent}/ontologyRecords:importImport ontology records. | 
| list | GET /v1alpha/{parent}/ontologyRecordsList all ontology records. | 
| patch | PATCH /v1alpha/{ontologyRecord.name}Update an ontology record. | 
| statistics | GET /v1alpha/{parent}/ontologyRecords:statisticsGet ontology records statistics. | 
REST Resource: v1alpha.projects.locations.instances.ontologyRecords.mappingRules
| Methods | |
|---|---|
| delete | DELETE /v1alpha/{name}Delete a MappingRule. | 
| fetchAll | GET /v1alpha/{parent}/mappingRules:fetchAllFetch all mapping rules, existing and candidates. | 
| get | GET /v1alpha/{name}Get a MappingRule. | 
| list | GET /v1alpha/{parent}/mappingRulesLists MappingRules. | 
| patch | PATCH /v1alpha/{mappingRule.name}Update a MappingRule. | 
| save | POST /v1alpha/{parent}/mappingRules:saveSave a mapping rule. | 
| test | POST /v1alpha/{name}:testTest a MappingRule. | 
REST Resource: v1alpha.projects.locations.instances.ontologyRecords.visualFamilies
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/visualFamiliesCreates a new VisualFamily. | 
| delete | DELETE /v1alpha/{name}Deletes a VisualFamily. | 
| export | POST /v1alpha/{parent}/visualFamilies:exportExports VisualFamilies. | 
| get | GET /v1alpha/{name}Gets a VisualFamily. | 
| import | POST /v1alpha/{parent}/visualFamilies:importImports VisualFamilies. | 
| list | GET /v1alpha/{parent}/visualFamiliesLists VisualFamilies in a given ontology record. | 
| patch | PATCH /v1alpha/{visualFamily.name}Updates a VisualFamily. | 
REST Resource: v1alpha.projects.locations.instances.operations
| Methods | |
|---|---|
| cancel | POST /v1alpha/{name}:cancelStarts asynchronous cancellation on a long-running operation. | 
| delete | DELETE /v1alpha/{name}Deletes a long-running operation. | 
| get | GET /v1alpha/{name}Gets the latest state of a long-running operation. | 
| list | GET /v1alpha/{name}/operationsLists operations that match the specified filter in the request. | 
| streamSearch | GET /v1alpha/{name}:streamSearchStreams the results of an in-progress search operation, or returns the final results of a completed operation. | 
REST Resource: v1alpha.projects.locations.instances.propertySchemaDefinitions
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/propertySchemaDefinitionsCreate a PropertySchemaDefinition. | 
| delete | DELETE /v1alpha/{name}Delete a PropertySchemaDefinition. | 
| get | GET /v1alpha/{name}Get a PropertySchemaDefinition. | 
| list | GET /v1alpha/{parent}/propertySchemaDefinitionsLists PropertySchemaDefinitions. | 
| patch | PATCH /v1alpha/{propertySchemaDefinition.name}Update a PropertySchemaDefinition. | 
REST Resource: v1alpha.projects.locations.instances.referenceLists
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/referenceListsCreates a new reference list. | 
| get | GET /v1alpha/{name}Gets a single reference list. | 
| list | GET /v1alpha/{parent}/referenceListsLists a collection of reference lists. | 
| patch | PATCH /v1alpha/{referenceList.name}Updates an existing reference list. | 
REST Resource: v1alpha.projects.locations.instances.remoteAgents
| Methods | |
|---|---|
| connectorValidRemoteAgents | GET /v1alpha/{parent}/remoteAgents:connectorValidRemoteAgentsReturns a list of all remote agents, including their availability state with respect to this specific connector. | 
| create | POST /v1alpha/{parent}/remoteAgentsCreates a SOAR remote agent. | 
| delete | DELETE /v1alpha/{name}Deletes a SOAR remote agent. | 
| fetchEditableRemoteAgents | GET /v1alpha/{parent}/remoteAgents:fetchEditableRemoteAgentsReturns a list of all the remote agents that the user can edit. | 
| fetchInstallationCommand | GET /v1alpha/{name}:fetchInstallationCommandFetches the installation command of the remote agent. | 
| fetchInstallerFile | GET /v1alpha/{name}:fetchInstallerFileReturns the installer file of the remote agent. | 
| fetchRedeployStatus | GET /v1alpha/{name}:fetchRedeployStatusReturns the redeploy status of the integrations in the remote agent. | 
| fetchRemoteAgentsCompatibleWithJobs | GET /v1alpha/{parent}/remoteAgents:fetchRemoteAgentsCompatibleWithJobsReturn a list of all the remote agents with availability status for jobs on specific integration. | 
| fetchRemoteAgentsInformation | POST /v1alpha/{parent}/remoteAgents:fetchRemoteAgentsInformationReturns a list of all remote agents, including their advanced information. | 
| get | GET /v1alpha/{name}Gets a SOAR remote agent. | 
| list | GET /v1alpha/{parent}/remoteAgentsLists SOAR remote agents. | 
| migrateConnectors | POST /v1alpha/{name}:migrateConnectorsMigrates legacy connector from remote to local scheduling. | 
| patch | PATCH /v1alpha/{remoteAgent.name}Updates an existing remote agent. | 
| redeployRemoteAgent | POST /v1alpha/{parent}/remoteAgents:redeployRemoteAgentRedeploys remote agent from an already existing remote agent. | 
| sendRemoteAgentInstaller | POST /v1alpha/{name}:sendRemoteAgentInstallerSends the remote agent installer to the recipients. | 
| upgradeRemoteAgent | POST /v1alpha/{name}:upgradeRemoteAgentUpgrades remote agent to the latest version. | 
REST Resource: v1alpha.projects.locations.instances.requestTemplates
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/requestTemplatesCreates a RequestTemplate. | 
| delete | DELETE /v1alpha/{name}Deletes a RequestTemplate. | 
| get | GET /v1alpha/{name}Gets a RequestTemplate. | 
| list | GET /v1alpha/{parent}/requestTemplatesLists RequestTemplates. | 
| patch | PATCH /v1alpha/{requestTemplate.name}Updates a RequestTemplate. | 
REST Resource: v1alpha.projects.locations.instances.ruleExecutionErrors
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/ruleExecutionErrorsLists rule execution errors. | 
REST Resource: v1alpha.projects.locations.instances.rules
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/rulesCreates a new Rule. | 
| delete | DELETE /v1alpha/{name}Deletes a Rule. | 
| get | GET /v1alpha/{name}Gets a Rule. | 
| getDeployment | GET /v1alpha/{name}Gets a RuleDeployment. | 
| list | GET /v1alpha/{parent}/rulesLists Rules. | 
| listRevisions | GET /v1alpha/{name}:listRevisionsLists all revisions of the rule. | 
| patch | PATCH /v1alpha/{rule.name}Updates a Rule. | 
| updateDeployment | PATCH /v1alpha/{ruleDeployment.name}Updates a RuleDeployment. | 
REST Resource: v1alpha.projects.locations.instances.rules.deployments
| Methods | |
|---|---|
| list | GET /v1alpha/{parent}/deploymentsLists RuleDeployments across all Rules. | 
REST Resource: v1alpha.projects.locations.instances.rules.retrohunts
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/retrohuntsCreate a Retrohunt. | 
| get | GET /v1alpha/{name}Get a Retrohunt. | 
| list | GET /v1alpha/{parent}/retrohuntsList Retrohunts. | 
REST Resource: v1alpha.projects.locations.instances.savedColumnSets
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/savedColumnSetsEndpoint for adding a new saved column set to the specified instance. | 
| delete | DELETE /v1alpha/{name}Endpoint for deleting a saved column set. | 
| get | GET /v1alpha/{name}Endpoint for getting a user's saved column set. | 
| list | GET /v1alpha/{parent}/savedColumnSetsEndpoint for listing the saved column sets. | 
| patch | PATCH /v1alpha/{savedColumnSet.name}Endpoint for updating user data saved column set | 
REST Resource: v1alpha.projects.locations.instances.slaDefinitions
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/slaDefinitionsCreates a SlaDefinition. | 
| delete | DELETE /v1alpha/{name}Deletes a SlaDefinition. | 
| export | GET /v1alpha/{parent}/slaDefinitions:exportExports a SlaDefinitions. | 
| get | GET /v1alpha/{name}Gets a SlaDefinition. | 
| import | POST /v1alpha/{parent}/slaDefinitions:importImports a SlaDefinitions. | 
| list | GET /v1alpha/{parent}/slaDefinitionsLists a SlaDefinitions. | 
| patch | PATCH /v1alpha/{slaDefinition.name}Updates a SlaDefinition. | 
REST Resource: v1alpha.projects.locations.instances.soarDomains
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/soarDomainsCreate a SoarDomain. | 
| delete | DELETE /v1alpha/{name}Delete a SoarDomain. | 
| export | GET /v1alpha/{parent}/soarDomains:exportExport SoarDomains. | 
| get | GET /v1alpha/{name}Get a SoarDomain. | 
| import | POST /v1alpha/{parent}/soarDomains:importImport SoarDomains. | 
| list | GET /v1alpha/{parent}/soarDomainsLists soar domains. | 
| patch | PATCH /v1alpha/{soarDomain.name}Update a SoarDomain. | 
REST Resource: v1alpha.projects.locations.instances.soarNetworks
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/soarNetworksCreate a SoarNetwork. | 
| delete | DELETE /v1alpha/{name}Delete a SoarNetwork. | 
| deleteAll | DELETE /v1alpha/{parent}/soarNetworks:allDelete a SoarNetwork. | 
| export | GET /v1alpha/{parent}/soarNetworks:exportExport SoarNetworks. | 
| get | GET /v1alpha/{name}Get a SoarNetwork. | 
| import | POST /v1alpha/{parent}/soarNetworks:importImport SoarNetworks. | 
| list | GET /v1alpha/{parent}/soarNetworksLists SOAR SoarNetworks. | 
| patch | PATCH /v1alpha/{soarNetwork.name}Update a SoarNetwork. | 
REST Resource: v1alpha.projects.locations.instances.socRoles
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/socRolesCreates a SocRole. | 
| delete | DELETE /v1alpha/{name}Deletes a SocRole. | 
| get | GET /v1alpha/{name}Gets a SocRole. | 
| list | GET /v1alpha/{parent}/socRolesLists SocRoles. | 
| patch | PATCH /v1alpha/{socRole.name}Updates a SocRole. | 
REST Resource: v1alpha.projects.locations.instances.tasks
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/tasksCreate a Task. | 
| delete | DELETE /v1alpha/{name}Delete a Task. | 
| get | GET /v1alpha/{name}Get a Task. | 
| list | GET /v1alpha/{parent}/tasksLists soar tasks. | 
| patch | PATCH /v1alpha/{task.name}Update a Task. | 
REST Resource: v1alpha.projects.locations.instances.threatCollections
| Methods | |
|---|---|
| fetchEntityMetadata | GET /v1alpha/{name}:fetchEntityMetadataGets a list of entity metadata for a threat collection. | 
| fetchIocMatchMetadata | GET /v1alpha/{parent}/threatCollections:fetchIocMatchMetadataGets a batch (list) of ioc match metadata for a list of threat collections. | 
| fetchRelated | GET /v1alpha/{parent}/threatCollections:fetchRelatedList related threat collections for a threat artifact. | 
| fetchRuleMetadata | GET /v1alpha/{parent}/threatCollections:fetchRuleMetadataGets a batch (list) of rule metadata for a list of threat collections. | 
| get | GET /v1alpha/{name}Gets a threat collection by resource name. | 
| list | GET /v1alpha/{parent}/threatCollectionsLists threat collections, which contain reports and tracked threat campaigns from Google Threat Intelligence. | 
REST Resource: v1alpha.projects.locations.instances.uniqueEntities
| Methods | |
|---|---|
| addNote | POST /v1alpha/{parent}/uniqueEntities:addNoteAdds a note to a UniqueEntity. | 
| download | GET /v1alpha/{name}/uniqueEntities:generateReportDownloads a unique entity report. | 
| fetchFull | POST /v1alpha/{parent}/uniqueEntities:fetchFullFetches a full UniqueEntity. | 
| get | GET /v1alpha/{name}Get a UniqueEntity. | 
| list | GET /v1alpha/{parent}/uniqueEntitiesLists UniqueEntities. | 
| patch | PATCH /v1alpha/{uniqueEntity.name}Update a UniqueEntity. | 
REST Resource: v1alpha.projects.locations.instances.users
| Methods | |
|---|---|
| clearConversationHistory | POST /v1alpha/{name}:clearConversationHistoryClearConversationHistory deletes all the user's data (messages and conversations) except of feedbacks. | 
| getPreferenceSet | GET /v1alpha/{name}Endpoint for getting a user's PreferenceSet | 
| updatePreferenceSet | PATCH /v1alpha/{preferenceSet.name}Endpoint for updating user data saved query | 
REST Resource: v1alpha.projects.locations.instances.users.conversations
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/conversationsCreateConversation is used to create a new conversation. | 
| delete | DELETE /v1alpha/{name}DeleteConversation is used to delete a conversation. | 
| get | GET /v1alpha/{name}GetConversation is used to retrieve an existing conversation. | 
| list | GET /v1alpha/{parent}/conversationsListConversations is used to retrieve existing conversations. | 
| patch | PATCH /v1alpha/{conversation.name}UpdateConversation is used to update an existing conversation. | 
REST Resource: v1alpha.projects.locations.instances.users.conversations.messages
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/messagesCreateMessage is used to create a new message in a conversation. | 
| delete | DELETE /v1alpha/{name}DeleteMessage is used to delete a message. | 
| get | GET /v1alpha/{name}GetMessage is used to retrieve a message. | 
| list | GET /v1alpha/{parent}/messagesListMessages is used to retrieve existing messages for a conversation. | 
| patch | PATCH /v1alpha/{message.name}UpdateMessage is used to update an existing message. | 
REST Resource: v1alpha.projects.locations.instances.users.savedColumnSets
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/savedColumnSetsEndpoint for adding a new saved column set to the specified instance. | 
| delete | DELETE /v1alpha/{name}Endpoint for deleting a saved column set. | 
| get | GET /v1alpha/{name}Endpoint for getting a user's saved column set. | 
| list | GET /v1alpha/{parent}/savedColumnSetsEndpoint for listing the saved column sets. | 
| patch | PATCH /v1alpha/{savedColumnSet.name}Endpoint for updating user data saved column set | 
REST Resource: v1alpha.projects.locations.instances.users.searchQueries
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/searchQueriesEndpoint for adding a new entry to the specified collection of user data | 
| delete | DELETE /v1alpha/{name}Endpoint for deleting a user data saved query entry | 
| get | GET /v1alpha/{name}Endpoint for getting a user's Saved query entry | 
| list | GET /v1alpha/{parent}/searchQueriesEndpoint for listing the user data saved queries owned by the specified user | 
| patch | PATCH /v1alpha/{searchQuery.name}Endpoint for updating user data saved query | 
REST Resource: v1alpha.projects.locations.instances.watchlists
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/watchlistsCreates a watchlist for the given instance. | 
| delete | DELETE /v1alpha/{name}Deletes the watchlist for the given instance. | 
| get | GET /v1alpha/{name}Gets watchlist details for the given watchlist ID. | 
| list | GET /v1alpha/{parent}/watchlistsLists all watchlists for the given instance. | 
| listEntities | GET /v1alpha/{parent}:listEntitiesLists all entities for the given watchlist. | 
| patch | PATCH /v1alpha/{watchlist.name}Updates the watchlist for the given instance. | 
REST Resource: v1alpha.projects.locations.instances.watchlists.entities
| Methods | |
|---|---|
| add | POST /v1alpha/{parent}/entities:addAdds an entity in watchlist. | 
| batchAdd | POST /v1alpha/{parent}/entities:batchAddAdds a batch of entities under watchlist. | 
| batchRemove | POST /v1alpha/{parent}/entities:batchRemoveRemoves entities in batch in the given watchlist. | 
| remove | POST /v1alpha/{name}:removeRemoves the entity in the given watchlist. | 
REST Resource: v1alpha.projects.locations.instances.webhooks
| Methods | |
|---|---|
| create | POST /v1alpha/{parent}/webhooksCreate a SOAR webhook configuration. | 
| delete | DELETE /v1alpha/{name}Delete a webhook. | 
| exportLogs | POST /v1alpha/{name}:exportLogsExports logs for a given webhook. | 
| get | GET /v1alpha/{name}Get a single webhook. | 
| getLogs | GET /v1alpha/{name}:getLogsGet a log for a given webhook. | 
| getStatistics | GET /v1alpha/{name}:getStatisticsGet statistics for a given webhook. | 
| ingest | POST /v1alpha/{name}:ingestIngest data for a given webhook. | 
| list | GET /v1alpha/{parent}/webhooksLists existing SOAR webhooks. | 
| patch | PATCH /v1alpha/{webhook.name}Update a webhook. | 
| revokeUrl | POST /v1alpha/{name}:revokeUrlRevokeUrl revokes a previously registered webhook URL, invalidating it and preventing further access. | 
REST Resource: v1.projects.locations.instances
| Methods | |
|---|---|
| generateCollectionAgentAuth | POST /v1/{name}:generateCollectionAgentAuthGenerateCollectionAgentAuth generates an auth json file for the collection agent. | 
| get | GET /v1/{name}Gets a Instance. | 
REST Resource: v1.projects.locations.instances.dataAccessLabels
| Methods | |
|---|---|
| create | POST /v1/{parent}/dataAccessLabelsCreates a data access label. | 
| delete | DELETE /v1/{name}Deletes a data access label. | 
| get | GET /v1/{name}Gets a data access label. | 
| list | GET /v1/{parent}/dataAccessLabelsLists all data access labels for the customer. | 
| patch | PATCH /v1/{dataAccessLabel.name}Updates a data access label. | 
REST Resource: v1.projects.locations.instances.dataAccessScopes
| Methods | |
|---|---|
| create | POST /v1/{parent}/dataAccessScopesCreates a data access scope. | 
| delete | DELETE /v1/{name}Deletes a data access scope. | 
| get | GET /v1/{name}Retrieves an existing data access scope. | 
| list | GET /v1/{parent}/dataAccessScopesLists all existing data access scopes for the customer. | 
| patch | PATCH /v1/{dataAccessScope.name}Updates a data access scope. | 
REST Resource: v1.projects.locations.instances.operations
| Methods | |
|---|---|
| cancel | POST /v1/{name}:cancelStarts asynchronous cancellation on a long-running operation. | 
| delete | DELETE /v1/{name}Deletes a long-running operation. | 
| get | GET /v1/{name}Gets the latest state of a long-running operation. | 
| list | GET /v1/{name}/operationsLists operations that match the specified filter in the request. | 
REST Resource: v1.projects.locations.instances.referenceLists
| Methods | |
|---|---|
| create | POST /v1/{parent}/referenceListsCreates a new reference list. | 
| get | GET /v1/{name}Gets a single reference list. | 
| list | GET /v1/{parent}/referenceListsLists a collection of reference lists. | 
| patch | PATCH /v1/{referenceList.name}Updates an existing reference list. | 
REST Resource: v1.projects.locations.instances.rules
| Methods | |
|---|---|
| create | POST /v1/{parent}/rulesCreates a new Rule. | 
| delete | DELETE /v1/{name}Deletes a Rule. | 
| get | GET /v1/{name}Gets a Rule. | 
| getDeployment | GET /v1/{name}Gets a RuleDeployment. | 
| list | GET /v1/{parent}/rulesLists Rules. | 
| listRevisions | GET /v1/{name}:listRevisionsLists all revisions of the rule. | 
| patch | PATCH /v1/{rule.name}Updates a Rule. | 
| updateDeployment | PATCH /v1/{ruleDeployment.name}Updates a RuleDeployment. | 
REST Resource: v1.projects.locations.instances.rules.deployments
| Methods | |
|---|---|
| list | GET /v1/{parent}/deploymentsLists RuleDeployments across all Rules. | 
REST Resource: v1.projects.locations.instances.rules.retrohunts
| Methods | |
|---|---|
| create | POST /v1/{parent}/retrohuntsCreate a Retrohunt. | 
| get | GET /v1/{name}Get a Retrohunt. | 
| list | GET /v1/{parent}/retrohuntsList Retrohunts. | 
REST Resource: v1.projects.locations.instances.watchlists
| Methods | |
|---|---|
| create | POST /v1/{parent}/watchlistsCreates a watchlist for the given instance. | 
| delete | DELETE /v1/{name}Deletes the watchlist for the given instance. | 
| get | GET /v1/{name}Gets watchlist details for the given watchlist ID. | 
| list | GET /v1/{parent}/watchlistsLists all watchlists for the given instance. | 
| patch | PATCH /v1/{watchlist.name}Updates the watchlist for the given instance. |