Help Center/ SecMaster/ CLI Reference/ CLI Command Reference/ CLI Command Reference (V1)
Updated on 2026-08-27 GMT+08:00

CLI Command Reference (V1)

Tenant Collection

API Name

Command

Description

Operation

Querying the Collection Channel List

hcloud SecMaster ListCollectorChannels/v1

This API is used to query the list of collection channels.

Go debug

Creating a Collection Channel

hcloud SecMaster CreateCollectorChannel/v1

This API is used to create a collection channel.

Go debug

Querying the Collection Channel Group List

hcloud SecMaster ListCollectorChannelGroup/v1

This API is used to query the list of collection channel groups.

Go debug

Creating a Collection Channel Group

hcloud SecMaster CreateCollectorChannelGroup/v1

This API is used to create a collection channel group.

Go debug

Updating a Collection Channel Group

hcloud SecMaster UpdateCollectorChannelGroup/v1

This API is used to update a collection channel group.

Go debug

Deleting a Collection Channel Group

hcloud SecMaster DeleteCollectorChannelGroup/v1

This API is used to delete a collection channel group.

Go debug

Querying the Collection Channel Instance List

hcloud SecMaster ListCollectorInstances/v1

This API is used to query the list of collection channel instances.

Go debug

Displaying Collection Channels

hcloud SecMaster ShowCollectorChannel/v1

This API is used to display collection channels.

Go debug

Modifying a Collection Channel

hcloud SecMaster UpdateCollectorChannel/v1

This API is used to modify a collection channel.

Go debug

Deleting a Collection Channel

hcloud SecMaster DeleteCollectorChannel/v1

This API is used to delete a collection channel.

Go debug

Executing a Collection Channel Operation

hcloud SecMaster CreateCollectorChannelOperation/v1

This API is used to execute a collection channel operation.

Go debug

Querying the Collection Connection List

hcloud SecMaster ListCollectorConnections/v1

This API is used to query the list of collection connections.

Go debug

Creating a Collection Connection

hcloud SecMaster CreateCollectorConnection/v1

This API is used to create a collection connection.

Go debug

Querying Collection Connection Details

hcloud SecMaster ShowCollectorConnection/v1

This API is used to query collection connection details.

Go debug

Updating a Collection Connection

hcloud SecMaster UpdateCollectorConnection/v1

This API is used to update a collection connection.

Go debug

Deleting a Collection Connection

hcloud SecMaster DeleteCollectorConnection/v1

This API is used to delete a collection connection.

Go debug

Installing a Collection Channel File

hcloud SecMaster CreateCollectorFiles/v1

This API is used to installing a collection channel file.

Go debug

Querying Collection Parsers

hcloud SecMaster ListCollectorParsers/v1

This API is used to query collection parsers.

Go debug

Creating a Collection Parser

hcloud SecMaster CreateCollectorParser/v1

This API is used to create a collection parser.

Go debug

Exporting a Collection Parser

hcloud SecMaster ExportCollectorParser/v1

This API is used to export a collection parser.

Go debug

Importing a Collection Parser

hcloud SecMaster ImportCollectorParser/v1

This API is used to import a collection parser.

Go debug

Querying the Collection Parser Template List

hcloud SecMaster ListCollectorParserTemplate/v1

This API is used to query the list of collection parser templates.

Go debug

Querying Collection Parser Details

hcloud SecMaster ShowCollectorParser/v1

This API is used to query collection parser details.

Go debug

Deleting a Collection Parser

hcloud SecMaster DeleteCollectorParser/v1

This API is used to delete a collection parser.

Go debug

Querying the Parser List

hcloud SecMaster ListCollectorModuleTemplate/v1

This API is used to list parsers.

Go debug

Querying the Parser Rule List

hcloud SecMaster ListCollectorModuleRestrictions/v1

This API is used to query the list of parser rules.

Go debug

Querying the Collection Node List

hcloud SecMaster ListCollectorNode/v1

This API is used to query the collection node list.

Go debug

Node Management

API Name

Command

Description

Operation

Querying Component Information by Node ID

hcloud SecMaster ListNodes/v1

Node to be queried.

Go debug

Deleting a Node by Node ID

hcloud SecMaster DeleteNode/v1

This API is used to delete a node.

Go debug

Querying the Installation Script List

hcloud SecMaster ListInstallation/v1

This API is used to query the installation script list.

Go debug

Querying the VPCEP Description

hcloud SecMaster ListVpcEndpointService/v1

This API is used to list VPCEP services.

Go debug

Updating VPCEP Description

hcloud SecMaster UpdateVpcEndpointService/v1

This API is used to update VPCEP.

Go debug

Updating Node Information

hcloud SecMaster UpdateNode/v1

This API is used to update node information.

Go debug

Component Management

API Name

Command

Description

Operation

Querying the Component List

hcloud SecMaster ListIsapComponents/v1

This API is used to query the component list.

Go debug

Displaying the Component Details

hcloud SecMaster ShowIsapComponent/v1

This API is used to display component details.

Go debug

Querying Component Configurations

hcloud SecMaster ListComponentConfiguration/v1

This API is used to query component configurations.

Go debug

Saving Component Configuration

hcloud SecMaster UpdateComponentConfiguration/v1

This API is used to save component configuration.

Go debug

Creating a Configuration Application

hcloud SecMaster CreateConfigurationApplication/v1

This API is used to create a configuration application.

Go debug

Obtaining the Configuration Data of a Historical Component Version

hcloud SecMaster ListHistoryComponentConfiguration/v1

This API is used to obtain the configuration data of historical component versions.

Go debug

Querying the Running Node List

hcloud SecMaster ListRunningNodes/v1

This API is used to query the list of running nodes.

Go debug

Querying the Component Template List

hcloud SecMaster ListComponentTemplate/v1

This API is used to query the list of component templates.

Go debug

Alert Rule Management

API Name

Command

Description

Operation

Listing Alert Rules

hcloud SecMaster ListAlertRules/v1

This API is used to list alert rules.

Go debug

Creating an Alert Rule

hcloud SecMaster CreateAlertRule/v1

This API is used to create an alert rule.

Go debug

Deleting an Alert Rule

hcloud SecMaster DeleteAlertRule/v1

This API is used to delete an alert rule.

Go debug

Disabling an Alert Rule

hcloud SecMaster DisableAlertRule/v1

This API is used to disable an alert rule.

Go debug

Enabling an Alert Rule

hcloud SecMaster EnableAlertRule/v1

This API is used to enable an alert rule.

Go debug

Querying Alert Rules

hcloud SecMaster ListAlertRuleMetrics/v1

This API is used to query alert rules.

Go debug

Simulating an Alert Rule

hcloud SecMaster CreateAlertRuleSimulation/v1

This API is used to simulate an alert rule.

Go debug

Querying the Alert Rule Template List

hcloud SecMaster ListAlertRuleTemplates/v1

This API is used to query the alert rule template list.

Go debug

Querying Alert Template Overview

hcloud SecMaster ListAlertRuleTemplateMetrics/v1

This API is used to querying alert template overview.

Go debug

Viewing Alert Rule Templates

hcloud SecMaster ShowAlertRuleTemplate/v1

This API is used to view alert rule templates.

Go debug

Querying an Alert Rule

hcloud SecMaster ShowAlertRule/v1

This API is used to query an alert rule.

Go debug

Updating an Alert Rule

hcloud SecMaster UpdateAlertRule/v1

This API is used to update an alert rule.

Go debug

Data Space Management

API Name

Command

Description

Operation

Obtaining the Data Space List

hcloud SecMaster ListDataspaces/v1

This API is used to obtain the data space list.

Go debug

Creating a Data Space

hcloud SecMaster CreateDataspace/v1

This API is used to create a data space.

Go debug

Obtaining Data Space Details

hcloud SecMaster ShowDataspace/v1

This API is used to obtain data space details.

Go debug

Modifying a Data Space

hcloud SecMaster UpdateDataspace/v1

This API is used to modify a data space.

Go debug

Deleting a Data Space

hcloud SecMaster DeleteDataspace/v1

This API is used to delete a data space.

Go debug

Pipeline Management

API Name

Command

Description

Operation

Creating a Data Pipeline

hcloud SecMaster CreatePipe/v1

This API is used to create a data pipeline.

Go debug

Cloud Service Access

API Name

Command

Description

Operation

Obtaining Cloud Service Log Collection Configuration

hcloud SecMaster ListCollectConfig/v1

This API is used to obtain cloud service log collection configuration.

Go debug

Saving Cloud Service Log Collection Configuration

hcloud SecMaster CreateCollectConfig/v1

This API is used to save cloud service collection configurations.

Go debug

Querying the Region List

hcloud SecMaster ListRegions/v1

This API is used to query the region list.

Go debug

Cloud Log Resources

API Name

Command

Description

Operation

Obtaining the Industry Monitoring Information

hcloud SecMaster ShowPlatformManaged/v1

This API is used to obtain the industry monitoring information.

Go debug

Listing Cloud Log Resources

hcloud SecMaster ListCloudLogResources/v1

This API is used to list cloud log resources.

Go debug

Creating Cloud Log Resources

hcloud SecMaster CreateResourceConfig/v1

This API is used to create cloud log resources.

Go debug

Query the Industry Monitoring Status

hcloud SecMaster ShowCloudLogTenantWhitelist/v1

This API is used to query whether industry monitoring is enabled.

Go debug

Querying the List of Platform Industry Monitoring Accounts

hcloud SecMaster ListCloudLogPlatform/v1

List Cloud Log Resources

Go debug

Querying the List of Industry Monitoring Accounts

hcloud SecMaster ListCloudLogManages/v1

This API is used to list cloud log resources.

Go debug

Deleting LTS Log Subscription

hcloud SecMaster DeleteLtsCloudLog/v1

This API is used to list cloud log resources.

Go debug

Querying the List of Pipeline Aliases

hcloud SecMaster ListCloudLogAlias/v1

This API is used to list cloud log resources.

Go debug

Monitoring

API Name

Command

Description

Operation

Obtaining Metric Statistics

hcloud SecMaster ShowMoniterMetricStats/v1

This API is used to obtain metric statistics.

Go debug

Data Pipelines

API Name

Command

Description

Operation

Obtaining the Data Pipeline List

hcloud SecMaster ListPipes/v1

This API is used to obtain the data pipeline list.

Go debug

Obtaining Data Pipeline Details

hcloud SecMaster ShowPipe/v1

This API is used to obtain data pipeline details.

Go debug

Modifying a Data Pipeline

hcloud SecMaster UpdatePipe/v1

This API is used to modify a data pipeline.

Go debug

Deleting a Data Pipeline

hcloud SecMaster DeletePipe/v1

This API is used to deleting a data pipeline.

Go debug

Querying Real-Time Consumption Configurations

hcloud SecMaster ShowPipeConsumption/v1

Querying Real-Time Consumption Configurations

Go debug

Enabling Real-time Consumption

hcloud SecMaster CreatePipeConsumption/v1

Enabling Real-time Consumption

Go debug

Disabling Real-Time Consumption

hcloud SecMaster DeletePipeConsumption/v1

This API is used to disable real-time consumption.

Go debug

Obtaining Index Information

hcloud SecMaster ShowPipeIndex/v1

This API is used to obtain index information.

Go debug

Modifying Indexes

hcloud SecMaster UpdatePipeIndex/v1

This API is used to modify indexes.

Go debug

Query and Analysis

API Name

Command

Description

Operation

Obtaining the Data Distribution Histogram

hcloud SecMaster ListSearchHistograms/v1

This QPI is used to obtain the data distribution histogram.

Go debug

Obtaining Search Data

hcloud SecMaster ListSearchLogs/v1

This API is used to obtain search data.

Go debug

Query Conditions

API Name

Command

Description

Operation

Querying the Search Criteria List

hcloud SecMaster ListSearchConditions/v1

This API is used to query the search criteria list.

Go debug

Creating Search Criteria

hcloud SecMaster CreateSearchCondition/v1

This API is used to create search criteria.

Go debug

This API is used to query search criteria details.

hcloud SecMaster ShowSearchCondition/v1

Querying Search Criteria Details

Go debug

Modifying Search Criteria

hcloud SecMaster UpdateSearchCondition/v1

This API is used to modify search criteria.

Go debug

Deleting Search Criteria

hcloud SecMaster DeleteSearchCondition/v1

This API is used to delete search criteria.

Go debug

Data Delivery

API Name

Command

Description

Operation

Querying Delivery Information

hcloud SecMaster ListShippers/v1

This API is used to query delivery information.

Go debug

Creating a Data Delivery

hcloud SecMaster CreateShipper/v1

This API is used to create a data delivery.

Go debug

Deleting Delivery Information

hcloud SecMaster DeleteShipper/v1

This API is used to delete delivery information.

Go debug

Obtaining the Delivery Authorization List

hcloud SecMaster ListShipperAuthorizations/v1

This API is used to obtain the delivery authorization list.

Go debug

Handling Authorization Requests

hcloud SecMaster HandleShipperAuthorization/v1

This API is used to handle authorization requests.

Go debug

Obtaining Agency Permissions

hcloud SecMaster ShowShipperDelegateAuth/v1

This API is used to obtain agency permissions.

Go debug

Creating Agency Permissions

hcloud SecMaster CreateShipperDelegateAuth/v1

This API is used to create agency permissions.

Go debug

Querying Parameters

hcloud SecMaster ShowShipperParam/v1

This API is used to query parameters.

Go debug

Querying Delivery Rule Details

hcloud SecMaster ShowShipper/v1

This API is used to query delivery rule details.

Go debug

Performing Authorization Again

hcloud SecMaster RetryShipperAuthorization/v1

This API is used to perform authorization again.

Go debug

Suspending a Delivery

hcloud SecMaster PauseShipper/v1

This API is used to suspend a delivery.

Go debug

Starting a Delivery

hcloud SecMaster ResumeShipper/v1

This API is used to start a delivery.

Go debug

Restarting a Delivery

hcloud SecMaster RetryShipper/v1

This API is used to restart a delivery.

Go debug

Analysis and Query

API Name

Command

Description

Operation

Executing Analysis

hcloud SecMaster CreateSearchAnalysis/v1

This API is used to execute analysis.

Go debug

Workflow Management

API Name

Command

Description

Operation

Querying the Workflow List

hcloud SecMaster ListWorkflows/v1

This API is used to query the workflow list.

Go debug

Creating a Workflow

hcloud SecMaster CreateAopWorkflow/v1

This API is used to create a workflow.

Go debug

Querying Workflow Details

hcloud SecMaster ShowAopWorkflow/v1

This API is used to query workflow details.

Go debug

Updating a Workflow

hcloud SecMaster UpdateAopWorkflow/v1

This API is used to update a workflow.

Go debug

Deleting a Workflow

hcloud SecMaster DeleteAopWorkflow/v1

This API is used to delete a workflow.

Go debug

Workflow Version Management

API Name

Command

Description

Operation

Querying the Workflow Version List

hcloud SecMaster ListAopWorkflowVersions/v1

This API is used to query the workflow version list.

Go debug

Creating a Workflow Version

hcloud SecMaster CreateAopWorkflowVersion/v1

This API is used to create a workflow version.

Go debug

Querying Workflow Version Details

hcloud SecMaster ShowAopWorkflowVersion/v1

This API is used to query workflow version details.

Go debug

Updating the Workflow Version Information

hcloud SecMaster UpdateAopWorkflowVersion/v1

This API is used to update the workflow version information.

Go debug

Deleting a Workflow Version

hcloud SecMaster DeleteAopWorkflowVersion/v1

This API is used to delete a workflow version.

Go debug

Reviewing the Workflow Version for Release

hcloud SecMaster CreateAopWorkflowVersionApprovel/v1

This API is used to review a workflow version.

Go debug

Verifying a Workflow Version

hcloud SecMaster ValidateAopWorkflowVersion/v1

This API is used to verify a workflow version.

Go debug

Workflow Packaging Management

API Name

Command

Description

Operation

Exporting a Workflow

hcloud SecMaster ExportAopworkflow/v1

This API is used to export workflows.

Go debug

Importing Workflow Information

hcloud SecMaster ImportAopworkflow/v1

This API is used to import workflows.

Go debug

Workflow Instance Management

API Name

Command

Description

Operation

Creating a Workflow Instance

hcloud SecMaster CreateWorkflowInstance/v1

This API is used to create a workflow instance.

Go debug

Querying the Workflow Instance List

hcloud SecMaster ListAopWorkflowInstance/v1

This API is used to query workflow instance list.

Go debug

Querying the Details of a Workflow Instance

hcloud SecMaster ShowAopWorkflowInstance/v1

This API is used to query the details of a workflow instance.

Go debug

Updating a Workflow Instance

hcloud SecMaster UpdateWorkflowInstance/v1

This API is used to update a workflow instance.

Go debug

Metering and Billing

API Name

Command

Description

Operation

Querying Subscribed Resources of a User

hcloud SecMaster ListSubscriptionOrder/v1

This API is used to query details about a subscribed resource. Note that the purchase, usage, and smn parameters are mutually exclusive. Only one request parameter can be matched at a time. The priority is as follows: smn > usage > purchase.

Go debug

Enabling or Configuring SecMaster Subscription

hcloud SecMaster CreateSubscriptionOrder/v1

This API is used to enable or configure the subscription to SecMaster.

Go debug

Updating a Resource

hcloud SecMaster UpdateSubscriptionOrder/v1

This API is used to update a subscribed resource.

Go debug

Unsubscribing from a Resource

hcloud SecMaster DeleteSubscriptionOrder/v1

This API is used to cancel subscriptions to SecMaster resources. This API is supported only in pay-per-use scenarios.

Go debug

Querying the SecMaster Offerings Available at the Current Site

hcloud SecMaster ListSubscriptionProduct/v1

This API is used to query the SecMaster offerings available at the current site.

Go debug

Querying the List of Purchased Resources

hcloud SecMaster ListSubscriptionGlobalOrder/v1

This API is used to query the list of purchased resources.

Go debug

Metric Management

API Name

Command

Description

Operation

Batch Querying Metrics

hcloud SecMaster BatchSearchMetricHits/v1

This API is used to batch query metrics.

Go debug

Comment

API Name

Command

Description

Operation

Querying the Comment List

hcloud SecMaster ListNotes/v1

This API is used to query the comment list.

Go debug

Creating a Comment

hcloud SecMaster CreateNote/v1

This API is used to create comments.

Go debug

Deleting a Comment

hcloud SecMaster DeleteNotes/v1

This API is used to delete a comment.

Go debug

Dictionary Management

API Name

Command

Description

Operation

Querying Dictionary Information

hcloud SecMaster ListConfigurationDictionaries/v1

This API is used to query dictionary information.

Go debug

Creating a Dictionary

hcloud SecMaster CreateConfigurationDictionaries/v1

This API is used to create dictionary data.

Go debug

Updating a Dictionary

hcloud SecMaster UpdateConfigurationDictionaries/v1

This API is used to update dictionary data.

Go debug

Deleting a Dictionary

hcloud SecMaster DeleteConfigurationDictionaries/v1

This API is used to delete dictionary data.

Go debug

Plug-in Management

API Name

Command

Description

Operation

Querying the Plug-in Definition List

hcloud SecMaster ListComponents/v1

This API is used to query the plug-in definition list.

Go debug

Querying Plug-in Details

hcloud SecMaster ShowComponent/v1

This API is used to query plug-in details.

Go debug

Querying the Plug-in Action List

hcloud SecMaster ListComponentActions/v1

This API is used to query the plug-in function, connector, and manager list

Go debug

Querying Plug-in Action Details

hcloud SecMaster ShowComponentAction/v1

This API is used to query plug-in action details.

Go debug

Operation Connection Management

API Name

Command

Description

Operation

Querying the Operation Connection List

hcloud SecMaster ListConnections/v1

This API is used to query the operation connection list.

Go debug

Creating an Operation Connection

hcloud SecMaster CreateConnection/v1

This API is used to create an operation connection.

Go debug

Querying Operation Connection Details

hcloud SecMaster ShowConnection/v1

This API is used to query operation connection details.

Go debug

Updating an Operation Connection

hcloud SecMaster UpdateConnection/v1

This API is used to update an operation connection.

Go debug

Deleting an Operation Connection

hcloud SecMaster DeleteConnection/v1

This API is used to delete an operation connection.

Go debug

Attachment Management

API Name

Command

Description

Operation

Uploading an Attachment

hcloud SecMaster UploadAttachment/v1

This API is used to upload an attachment to OBS.

Go debug

Downloading an Attachment

hcloud SecMaster DownloadAttachment/v1

This API is used to download an attachment from OBS.

Go debug

Obtaining Attachment Details

hcloud SecMaster ShowAttachment/v1

This API is used to obtain attachment details.

Go debug

Plugin Configuration Template Management

API Name

Command

Description

Operation

Querying Plugin Configuration Templates

hcloud SecMaster ListComponentTemplates/v1

This API is used to query the plugin configuration template list during workflow configuration.

Go debug

Creating a Plugin Configuration Template

hcloud SecMaster CreateComponentTemplate/v1

This API is used to create a plugin configuration template during workflow configuration.

Go debug

Querying Plugin Configuration Template Details

hcloud SecMaster ShowComponentTemplate/v1

This API is used to query the plugin configuration template details during workflow configuration.

Go debug

Updating a Plugin Configuration Template

hcloud SecMaster UpdateComponentTemplate/v1

This API is used to update a plugin configuration template during workflow configuration.

Go debug

Deleting a Plugin Configuration Template

hcloud SecMaster DeleteComponentTemplate/v1

This API is used to delete a plugin configuration template during workflow configuration.

Go debug

Data Class Management

API Name

Command

Description

Operation

Querying the Data Class List

hcloud SecMaster ListDataclass/v1

This API is used to query the data class list.

Go debug

Querying the Field List

hcloud SecMaster ListDataclassFields/v1

This API is used to query the field list.

Go debug

Querying Data Class Details

hcloud SecMaster ShowDataClassInfo/v1

This API is used to query data class details.

Go debug

Data Class Types

API Name

Command

Description

Operation

Adding a Data Class Type

hcloud SecMaster CreateDataclassType/v1

This API is used to add a data type.

Go debug

Deleting a Data Class Type

hcloud SecMaster DeleteDataclassType/v1

This API is used to delete a data class type.

Go debug

Enabling/Disabling a Data Class Type

hcloud SecMaster EnableDataclassType/v1

This API is used to disable or enable a data class type.

Go debug

Alert Management

API Name

Command

Description

Operation

Querying the Alert List

hcloud SecMaster ListAlerts/v1

This API is used to query the alert list.

Go debug

Creating an Alert

hcloud SecMaster CreateAlert/v1

This API is used to create an alert.

Go debug

Deleting an Alert

hcloud SecMaster DeleteAlert/v1

This API is used to delete an alert.

Go debug

Converting an Alert into an Incident

hcloud SecMaster CreateBatchOrderAlerts/v1

This API is used to convert alerts into incidents.

Go debug

Obtain Alert Details

hcloud SecMaster ShowAlert/v1

This API is used to obtain alert details.

Go debug

Updating an Alert

hcloud SecMaster ChangeAlert/v1

This API is used to update alerts based on attribute changes. The update works on only changed columns.

Go debug

Batch Updating Alerts

hcloud SecMaster ChangeAlerts/v1

This API is used to batch update alerts based on attribute changes. The update works on only changed columns.

Go debug

Batch Deleting Alerts

hcloud SecMaster DeleteAlerts/v1

This API is used to batch delete alerts.

Go debug

Importing Alerts

hcloud SecMaster ImportAlerts/v1

This API is used to batch import alerts. You need to fill in the downloaded template based on the data object types and descriptions specified for security incidents. Mandatory fields cannot be left empty. The backend will verify all fields during import.

Go debug

Downloading an Alert Import Template

hcloud SecMaster DownloadAlertTemplate/v1

This API is used to download the alert import template. The template is organized based on the standard data class field attributes. The default alert example will be downloaded.

Go debug

Exporting Alerts

hcloud SecMaster ExportAlerts/v1

This API is used to export alerts. If the field is of the object type, the content of the entire subobject is exported.

Go debug

Incident Management

API Name

Command

Description

Operation

Querying the Incident List

hcloud SecMaster ListIncidents/v1

This API is used to query the incident list.

Go debug

Creating an Incident

hcloud SecMaster CreateIncident/v1

This API is used to create an incident.

Go debug

Deleting an Incident

hcloud SecMaster DeleteIncident/v1

This API is used to delete an incident.

Go debug

Querying Details About an Incident

hcloud SecMaster ShowIncident/v1

This API is used to obtain the details about an incident.

Go debug

Updating an Incident

hcloud SecMaster ChangeIncident/v1

This API is used to update an incident based on its attribute changes. The update works on only changed columns.

Go debug

Batch Updating Incidents

hcloud SecMaster ChangeIncidents/v1

This API is used to update an incident based on its attribute changes. The update works on only changed columns.

Go debug

Batch Deleting Incidents

hcloud SecMaster DeleteIncidents/v1

This API is used to batch delete incidents.

Go debug

Importing Incidents

hcloud SecMaster ImportIncidents/v1

This API is used to import incidents. You need to fill in the downloaded template based on the data object types and descriptions specified for security incidents. Mandatory fields cannot be left empty. The backend will verify all fields during import.

Go debug

Downloading an Incident Import Template

hcloud SecMaster DownloadIncidentTemplate/v1

This API is used to download the incident import template. The template is organized based on the standard data class field attributes. The default incident example will be downloaded.

Go debug

Exporting Incidents

hcloud SecMaster ExportIncidents/v1

This API is used to export the incident list. If the field is of the object type, the content of the entire subobject will be exported.

Go debug

Threat Indicator Management

API Name

Command

Description

Operation

Querying the Indicator List

hcloud SecMaster ListIndicators/v1

This API is used to query the indicator list.

Go debug

Creating a Threat Indicator

hcloud SecMaster CreateIndicator/v1

This API is used to create a threat indicator.

Go debug

Deleting a Threat Indicator

hcloud SecMaster DeleteIndicator/v1

Deleting a Threat Indicator

Go debug

Querying Details About a Threat Indicator

hcloud SecMaster ShowIndicatorDetail/v1

This API is used to query the details about a threat indicator.

Go debug

Updating a Threat Indicator

hcloud SecMaster UpdateIndicator/v1

This API is used to update a threat indicator.

Go debug

Downloading an Indicator Template

hcloud SecMaster DownloadIndicatorTemplate/v1

This API is used to download the indicator import template. The template is organized based on the standard data class field attributes. The default indicator example will be downloaded.

Go debug

Exporting Indicators

hcloud SecMaster ExportIndicators/v1

This API is used to export indicators. If the field is of the object type, the content of the entire subobject will be exported.

Go debug

Importing Indicators

hcloud SecMaster ImportIndicators/v1

This API is used to import indicators in batches. You need to fill in the downloaded template based on the data object types and descriptions specified for indicators. Mandatory fields cannot be left empty. The backend will verify all fields during import.

Go debug

Incident Relationship Management

API Name

Command

Description

Operation

Querying the Associated Data Object List

hcloud SecMaster ListDataobjectRelations/v1

This API is used to query the associated data object list.

Go debug

Associating a Data Object

hcloud SecMaster CreateDataobjectRelation/v1

This API is used to associate a data object.

Go debug

Canceling Association with a Data Object

hcloud SecMaster DeleteDataobjectRelation/v1

This API is used to cancel association with a data object.

Go debug

Batch Associating Data Objects

hcloud SecMaster BatchCreateDataobjectRelations/v1

This API is used to batch associate data objects.

Go debug

General Security Application

API Name

Command

Description

Operation

Querying the Data Object List

hcloud SecMaster ListDataobjects/v1

This API is used to query the data object list.

Go debug

Creating a Data Object

hcloud SecMaster CreateDataobject/v1

This API is used to create data objects.

Go debug

Batch Deleting Data Objects

hcloud SecMaster DeleteDataobjects/v1

This API is used to batch delete data objects.

Go debug

Querying a Data Object

hcloud SecMaster ShowDataobject/v1

This API is used to query a data object.

Go debug

Editing a Data Object

hcloud SecMaster UpdateDataobject/v1

This API is used to update a data object.

Go debug

Exporting a Data Object

hcloud SecMaster ExportDataobjects/v1

This API is used to export data objects.

Go debug

Importing a Data Object

hcloud SecMaster ImportDataobjects/v1

This API is used to import data objects.

Go debug

Data Object Management

API Name

Command

Description

Operation

Batch Creating Data Objects

hcloud SecMaster BatchCreateDatapanelObjects/v1

This API is used to create data objects managed by data classes in batches on the data plane.

Go debug

Querying a Data Plane Object

hcloud SecMaster ShowDatapanelObject/v1

This API is used to query details about managed data objects on the data plane.

Go debug

Querying the Data Object List

hcloud SecMaster ListDatapanelObjects/v1

This API is used to query data objects managed by data classes on the data plane.

Go debug

Layouts

API Name

Command

Description

Operation

Querying the Layout List

hcloud SecMaster ListLayout/v1

This API is used to query the layout list.

Go debug

Creating a Layout

hcloud SecMaster CreateLayout/v1

This API is used to create a layout.

Go debug

Deleting a Layout

hcloud SecMaster DeleteLayouts/v1

This API is used to delete a layout.

Go debug

Querying Layout Details

hcloud SecMaster ShowLayout/v1

This API is used to query layout details.

Go debug

Modifying a Layout

hcloud SecMaster UpdateLayout/v1

This API is used to modify a layout.

Go debug

Managing Layouts

hcloud SecMaster ExecuteLayout/v1

This API is used to manage a layout.

Go debug

Querying the Layout Page List

hcloud SecMaster ListLayoutWizards/v1

This API is used to query all layouts.

Go debug

Creating a Layout Page

hcloud SecMaster CreateLayoutWizard/v1

This API is used to create a layout.

Go debug

Querying Layout Page Details

hcloud SecMaster ShowLayoutWizardByField/v1

This API is used to query layout page details.

Go debug

Batch Updating Layout Pages

hcloud SecMaster UpdateLayoutWizards/v1

This API is used to update a layout.

Go debug

Querying the Layout Page

hcloud SecMaster ShowLayoutWizard/v1

This API is used to query the layout page.

Go debug

Deleting a Layout Page

hcloud SecMaster DeleteLayoutWizard/v1

This API is used to delete a layout.

Go debug

Querying the Module List

hcloud SecMaster ListModules/v1

This API is used to query all modules.

Go debug

Creating a Module

hcloud SecMaster CreateModule/v1

This API is used to create a module.

Go debug

Querying Module Details

hcloud SecMaster ShowModule/v1

This API is used to query module details.

Go debug

Updating a Layout Module

hcloud SecMaster UpdateModule/v1

This API is used to update a layout module.

Go debug

Deleting a Module

hcloud SecMaster DeleteModule/v1

This API is used to delete a module.

Go debug

Security Reports

API Name

Command

Description

Operation

Managing Security Reports

hcloud SecMaster ExecuteReportAction/v1

This API is used to manage a security report.

Go debug

Obtaining Security Report Details

hcloud SecMaster ShowReportInfo/v1

This API is used to obtain report details.

Go debug

Updating a Security Report

hcloud SecMaster UpdateReport/v1

This API is used to update a security report.

Go debug

Deleting a Security Report

hcloud SecMaster DeleteReport/v1

This API is used to delete a security report.

Go debug

Querying the Security Report List

hcloud SecMaster ListReports/v1

This API is used to obtain the report list.

Go debug

Creating a Security Report

hcloud SecMaster CreateReport/v1

This API is used to create a security report.

Go debug

Updating the Recipient Email Address Status

hcloud SecMaster UpdateRecipientsEmailStatus/v1

This API is used to update the email address status of a recipient.

Go debug

Querying the Recipient Status

hcloud SecMaster ListRecipientsStatus/v1

This API is used to query the status of a recipient.

Go debug

Directory Customization

API Name

Command

Description

Operation

Querying the Directory List

hcloud SecMaster ListAllSecondCatalogue/v1

This API is used to query the directory list.

Go debug

Creating a Custom Directory

hcloud SecMaster CreateCatalogue/v1

This API is used to create a custom directory.

Go debug

Batch Deleting Directories

hcloud SecMaster DeleteCatalogue/v1

This API is used to batch delete directories.

Go debug

Modifying a Custom Directory

hcloud SecMaster UpdateCatalogue/v1

This API is used to modify a custom directory.

Go debug

Querying the List of Directories by Condition

hcloud SecMaster ListCatalogue/v1

This API is used to query the list of directories based on specified conditions.

Go debug

Batch Modifying Directories

hcloud SecMaster BatchUpdateCatalogue/v1

This API is used to batch modify custom directories.

Go debug

Metric Definitions

API Name

Command

Description

Operation

Querying the Metric List

hcloud SecMaster ListMetrics/v1

This API is used to query the metric list.

Go debug

Creating a Metric

hcloud SecMaster CreateMetric/v1

This API is used to create a metric.

Go debug

Obtaining Metric Metadata

hcloud SecMaster ShowMetricMetaData/v1

This API is used to obtain metric metadata.

Go debug

Updating a Metric Definition

hcloud SecMaster UpdateMetrics/v1

This API is used to update a metric definition.

Go debug

Deleting a Metric

hcloud SecMaster DeleteMetrics/v1

This API is used to delete a metric.

Go debug

Classifications & Mappings

API Name

Command

Description

Operation

Querying Classifications & Mappings

hcloud SecMaster ShowMappingInfoList/v1

This API is used to query the list of classifications & mappings.

Go debug

Querying Classification & Mapping Functions

hcloud SecMaster ShowMappingFunction/v1

This API is used to query functions used for classifications and mappings.

Go debug

Copying a Mapping

hcloud SecMaster CopyMapping/v1

This API is used to copy a mapping.

Go debug

Deleting Mapping Information

hcloud SecMaster DeleteMappingInfo/v1

This API is used to delete mapping information.

Go debug

Modifying the Status of a Mapping

hcloud SecMaster UpdateMappingInfoStatus/v1

This API is used to modifying the status of a categorical mapping.

Go debug

Adding a Classification

hcloud SecMaster CreateClassifier/v1

This API is used to add a classification.

Go debug

Querying Classification Details

hcloud SecMaster ShowClassifierInfo/v1

This API is used to query classification details.

Go debug

Modifying a Classification

hcloud SecMaster UpdateClassifier/v1

This API is used to modify a classification.

Go debug

Deleting a Classification

hcloud SecMaster DeleteClassifier/v1

This API is used to delete a classification.

Go debug

Adding a Mapping

hcloud SecMaster CreateMapper/v1

This API is used to add a mapping.

Go debug

Querying the Mapping List

hcloud SecMaster ShowMapperList/v1

This API is used to query the mapping list.

Go debug

Querying Mapping Details

hcloud SecMaster ShowMapperDetail/v1

This API is used to query mapping details.

Go debug

Modifying a Mapping

hcloud SecMaster UpdateMapper/v1

Modifying a Mapping

Go debug

Deleting a Mapping

hcloud SecMaster DeleteSingleMapper/v1

This API is used to delete a mapping.

Go debug

Creating a Preprocessing Rule

hcloud SecMaster CreatePreProcessRules/v1

This API is used to create a preprocessing rule.

Go debug

Querying Preprocessing Rules

hcloud SecMaster ShowPreProcessRulesList/v1

This API is used to query preprocessing rules.

Go debug

Playbook Management

API Name

Command

Description

Operation

Monitoring Playbook Running

hcloud SecMaster ShowPlaybookMonitors/v1

Playbook Running Monitoring (Offline Soon)

Go debug

Querying Playbook Statistics Data

hcloud SecMaster ShowPlaybookStatistics/v1

Playbook Statistics (Offline Soon)

Go debug

Querying the Playbook List

hcloud SecMaster ListPlaybooks/v1

This API is used to query the playbook list.

Go debug

Creating a Playbook

hcloud SecMaster CreatePlaybook/v1

This API is used to create a playbook.

Go debug

Querying Playbook Details

hcloud SecMaster ShowPlaybook/v1

This API is used to query details about a playbook.

Go debug

Modifying a Playbook

hcloud SecMaster UpdatePlaybook/v1

This API is used to modify a playbook.

Go debug

Deleting a Playbook

hcloud SecMaster DeletePlaybook/v1

This API is used to delete a playbook.

Go debug

Playbook Version Management

API Name

Command

Description

Operation

Cloning a Playbook and Its Version

hcloud SecMaster CopyPlaybookVersion/v1

Cloning a Playbook and Version (Offline Soon)

Go debug

Querying the Playbook Version List

hcloud SecMaster ListPlaybookVersions/v1

This API is used to query the version list of a playbook.

Go debug

Creating a Playbook Version

hcloud SecMaster CreatePlaybookVersion/v1

This API is used to create a playbook version.

Go debug

Querying Playbook Version Details

hcloud SecMaster ShowPlaybookVersion/v1

This API is used to query playbook version details.

Go debug

Updating a Playbook Version

hcloud SecMaster UpdatePlaybookVersion/v1

This API is used to update a playbook version.

Go debug

Deleting a Playbook Version

hcloud SecMaster DeletePlaybookVersion/v1

This API is used to delete a playbook version.

Go debug

Playbook Rule Management (Offline Soon)

API Name

Command

Description

Operation

Creating a Playbook Rule

hcloud SecMaster CreatePlaybookRule/v1

This API is used to create a playbook rule.

Go debug

Querying Playbook Rule Details

hcloud SecMaster ShowPlaybookRule/v1

This API is used to query details about a playbook rule.

Go debug

Updating a Playbook Rule

hcloud SecMaster UpdatePlaybookRule/v1

This API is used to update a playbook rule.

Go debug

Deleting a Playbook Rule

hcloud SecMaster DeletePlaybookRule/v1

This API is used to delete a playbook rule.

Go debug

Playbook Instance Management

API Name

Command

Description

Operation

Querying the Playbook Instance List

hcloud SecMaster ListPlaybookInstances/v1

This API is used to query the playbook instance list.

Go debug

Querying Details About a Playbook Instance

hcloud SecMaster ShowPlaybookInstance/v1

This API is used to query details about a playbook instance.

Go debug

Operating a Playbook Instance

hcloud SecMaster ChangePlaybookInstance/v1

Operating a Playbook Instance

Go debug

Querying the Playbook Topology

hcloud SecMaster ShowPlaybookTopology/v1

Querying the Playbook Topology

Go debug

Querying Review Logs of a Playbook Instance

hcloud SecMaster ListPlaybookAuditLogs/v1

Querying Review Logs of a Playbook Instance

Go debug

Playbook Review Management

API Name

Command

Description

Operation

Reviewing a Playbook

hcloud SecMaster CreatePlaybookApprove/v1

This API is used to review a playbook.

Go debug

Querying the Playbook Review Result

hcloud SecMaster ListPlaybookApproves/v1

This API is used to query the playbook review result.

Go debug

Playbook Action Management (Offline Soon)

API Name

Command

Description

Operation

Querying the Playbook Workflow

hcloud SecMaster ListPlaybookActions/v1

Querying the Playbook Workflow List

Go debug

Creating a Playbook Workflow

hcloud SecMaster CreatePlaybookAction/v1

This API is used to create a playbook workflow.

Go debug

Updating a Playbook Workflow

hcloud SecMaster UpdatePlaybookAction/v1

This API is used to update a playbook workflow.

Go debug

Deleting a Playbook Workflow

hcloud SecMaster DeletePlaybookAction/v1

This API is used to delete a playbook workflow.

Go debug

Playbook Packaging Management

API Name

Command

Description

Operation

Exporting Playbooks

hcloud SecMaster ExportPlaybook/v1

This API is used to export playbooks.

Go debug

Importing Playbooks

hcloud SecMaster ImportPlaybook/v1

This API is used to import playbooks.

Go debug

Emergency Policies

API Name

Command

Description

Operation

Creating a Retry Emergency Policy

hcloud SecMaster CreateRetryPolicy/v1

This API is used to create a retry emergency policy.

Go debug

Querying Policy View Objects

hcloud SecMaster ShowPolicy/v1

This API is used to query policy view objects.

Go debug

Batch Deleting Emergency Policies

hcloud SecMaster DeletePolicies/v1

This API is used to batch delete emergency policies.

Go debug

Querying the Policy View List

hcloud SecMaster SearchPolicy/v1

This API is used to query the policy view list.

Go debug

Querying the Task View List

hcloud SecMaster SearchPolicyRecord/v1

This API is used to query the task view list.

Go debug

Querying Historical Records by Policy ID

hcloud SecMaster SearchPolicyRecordByPolicyId/v1

This API is used to query the historical records of a policy by policy ID.

Go debug

Resource Manager

API Name

Command

Description

Operation

Querying the Resource List

hcloud SecMaster ListResources/v1

This API is used to query the resource list.

Go debug

Deleting a Resource

hcloud SecMaster DeleteResource/v1

This API is used to delete a resource.

Go debug

Obtaining Resource Details

hcloud SecMaster ShowResource/v1

This API is used to obtain resource details.

Go debug

Updating Resource Information

hcloud SecMaster ChangeResource/v1

This API is used to update a resource based on its attribute changes. The update works on only changed columns.

Go debug

Importing Resources

hcloud SecMaster ImportResource/v1

This API is used to import resources. You need to fill in the downloaded template based on the data object types and descriptions specified for resources. Mandatory fields cannot be left empty. The backend will verify all fields during import.

Go debug

Exporting the Resource List

hcloud SecMaster ExportResources/v1

This API is used to export the resource list.

Go debug

Downloading the Resource Import Template

hcloud SecMaster DownloadResourceTemplate/v1

This API is used to download the resource import template.

Go debug

Task Center

API Name

Command

Description

Operation

Querying the To-Do List

hcloud SecMaster ListTasks/v1

This API is used to query the to-do list.

Go debug

Querying Details About a To-Do Task

hcloud SecMaster ShowTask/v1

This API is used to query details about a to-do task.

Go debug

Updating To-Do Task Information

hcloud SecMaster UpdateTask/v1

This API is used to update to-do task information.

Go debug

Vulnerability Management

API Name

Command

Description

Operation

Obtaining Vulnerability Details

hcloud SecMaster ShowVulnerability/v1

This API is used to obtain vulnerability details.

Go debug

Querying the Vulnerability List

hcloud SecMaster ListVulnerabilities/v1

This API is used to query the list of detected vulnerabilities.

Go debug

Exporting Vulnerabilities

hcloud SecMaster ExportVulnerabilities/v1

This API is used to export vulnerability details.

Go debug

Import Vulnerabilities

hcloud SecMaster ImportVulnerabilities/v1

This API is used to import vulnerabilities in batches. You need to fill in the downloaded template based on the data object types and descriptions specified for vulnerabilities. Mandatory fields cannot be left empty. The backend will verify all fields during import.

Go debug

Downloading a Vulnerability Import Template

hcloud SecMaster DownloadVulnerabilityTemplate/v1

This API is used to download the vulnerability import template. The template is organized based on the standard data class field attributes.

Go debug

Resource Tag Management

API Name

Command

Description

Operation

Deleting a Resource Tag

hcloud SecMaster DeleteTags/v1

This API is used to batch delete tags from a specified instance.

Go debug

Batch Deleting Resource Tags

hcloud SecMaster BatchUntagResources/v1

This API is used to batch delete tags from a specified instance.

Go debug

Updating a Tag Value

hcloud SecMaster UpdateTagValue/v1

This API is used to update a tag value.

Go debug

Querying Resource Tags

hcloud SecMaster ListResourceTag/v1

This API is used to query tags of a specific resource.

Go debug

Querying Tags in a Project

hcloud SecMaster ListProjectTag/v1

This API is used to query tags of all resources in a specified project.

Go debug

Batch Adding tags to a Resource

hcloud SecMaster BatchTagResources/v1

This API is used to batch add tags for a specified instance.

Go debug

Resource Instance Management

API Name

Command

Description

Operation

Querying the Resource Instance List

hcloud SecMaster ListResourceInstance/v1

This API is used to query the resource instance list by tag.

Go debug

Querying the Number of Resource Instances

hcloud SecMaster CountResourceInstance/v1

This API is used to query the number of resource instances by tag.

Go debug

Workspace Management

API Name

Command

Description

Operation

Querying the Workspace List

hcloud SecMaster ListWorkspaces/v1

This API is used to query the workspace list. You can filter workspaces by workspace name, workspace description, and creation time.

Go debug

Creating a Workspace

hcloud SecMaster CreateWorkspace/v1

Before using the baseline inspection, alert management, security analysis, and security orchestration in SecMaster, you need to create at least one workspace first. You can use workspaces to group your resources by application scenario. This will make security operations more efficient.

Go debug

Querying Details About a Workspace

hcloud SecMaster ShowWorkspace/v1

This API is used to query details about a workspace, such as the workspace name and description.

Go debug

Updating a Workspace

hcloud SecMaster UpdateWorkspace/v1

This API is used to update the name, description, and other information of a workspace.

Go debug

Deleting a Workspace

hcloud SecMaster DeleteWorkspace/v1

This API is used to delete a workspace.

Go debug

Agency Management

API Name

Command

Description

Operation

Viewing Agency Information

hcloud SecMaster ListServiceAgency/v1

check service linked agency

Go debug

Creating an Agency and Granting Permissions to It

hcloud SecMaster CreateServiceAgency/v1

This API is used to create an agency based on the role and scope in the body and assign the policy to the agency.

Go debug