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. | |
| Creating a Collection Channel | hcloud SecMaster CreateCollectorChannel/v1 | This API is used to create a collection channel. | |
| Querying the Collection Channel Group List | hcloud SecMaster ListCollectorChannelGroup/v1 | This API is used to query the list of collection channel groups. | |
| Creating a Collection Channel Group | hcloud SecMaster CreateCollectorChannelGroup/v1 | This API is used to create a collection channel group. | |
| Updating a Collection Channel Group | hcloud SecMaster UpdateCollectorChannelGroup/v1 | This API is used to update a collection channel group. | |
| Deleting a Collection Channel Group | hcloud SecMaster DeleteCollectorChannelGroup/v1 | This API is used to delete a collection channel group. | |
| Querying the Collection Channel Instance List | hcloud SecMaster ListCollectorInstances/v1 | This API is used to query the list of collection channel instances. | |
| Displaying Collection Channels | hcloud SecMaster ShowCollectorChannel/v1 | This API is used to display collection channels. | |
| Modifying a Collection Channel | hcloud SecMaster UpdateCollectorChannel/v1 | This API is used to modify a collection channel. | |
| Deleting a Collection Channel | hcloud SecMaster DeleteCollectorChannel/v1 | This API is used to delete a collection channel. | |
| Executing a Collection Channel Operation | hcloud SecMaster CreateCollectorChannelOperation/v1 | This API is used to execute a collection channel operation. | |
| Querying the Collection Connection List | hcloud SecMaster ListCollectorConnections/v1 | This API is used to query the list of collection connections. | |
| Creating a Collection Connection | hcloud SecMaster CreateCollectorConnection/v1 | This API is used to create a collection connection. | |
| Querying Collection Connection Details | hcloud SecMaster ShowCollectorConnection/v1 | This API is used to query collection connection details. | |
| Updating a Collection Connection | hcloud SecMaster UpdateCollectorConnection/v1 | This API is used to update a collection connection. | |
| Deleting a Collection Connection | hcloud SecMaster DeleteCollectorConnection/v1 | This API is used to delete a collection connection. | |
| Installing a Collection Channel File | hcloud SecMaster CreateCollectorFiles/v1 | This API is used to installing a collection channel file. | |
| Querying Collection Parsers | hcloud SecMaster ListCollectorParsers/v1 | This API is used to query collection parsers. | |
| Creating a Collection Parser | hcloud SecMaster CreateCollectorParser/v1 | This API is used to create a collection parser. | |
| Exporting a Collection Parser | hcloud SecMaster ExportCollectorParser/v1 | This API is used to export a collection parser. | |
| Importing a Collection Parser | hcloud SecMaster ImportCollectorParser/v1 | This API is used to import a collection parser. | |
| Querying the Collection Parser Template List | hcloud SecMaster ListCollectorParserTemplate/v1 | This API is used to query the list of collection parser templates. | |
| Querying Collection Parser Details | hcloud SecMaster ShowCollectorParser/v1 | This API is used to query collection parser details. | |
| Deleting a Collection Parser | hcloud SecMaster DeleteCollectorParser/v1 | This API is used to delete a collection parser. | |
| Querying the Parser List | hcloud SecMaster ListCollectorModuleTemplate/v1 | This API is used to list parsers. | |
| Querying the Parser Rule List | hcloud SecMaster ListCollectorModuleRestrictions/v1 | This API is used to query the list of parser rules. | |
| Querying the Collection Node List | hcloud SecMaster ListCollectorNode/v1 | This API is used to query the collection node list. |
Node Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Component Information by Node ID | hcloud SecMaster ListNodes/v1 | Node to be queried. | |
| Deleting a Node by Node ID | hcloud SecMaster DeleteNode/v1 | This API is used to delete a node. | |
| Querying the Installation Script List | hcloud SecMaster ListInstallation/v1 | This API is used to query the installation script list. | |
| Querying the VPCEP Description | hcloud SecMaster ListVpcEndpointService/v1 | This API is used to list VPCEP services. | |
| Updating VPCEP Description | hcloud SecMaster UpdateVpcEndpointService/v1 | This API is used to update VPCEP. | |
| Updating Node Information | hcloud SecMaster UpdateNode/v1 | This API is used to update node information. |
Component Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Component List | hcloud SecMaster ListIsapComponents/v1 | This API is used to query the component list. | |
| Displaying the Component Details | hcloud SecMaster ShowIsapComponent/v1 | This API is used to display component details. | |
| Querying Component Configurations | hcloud SecMaster ListComponentConfiguration/v1 | This API is used to query component configurations. | |
| Saving Component Configuration | hcloud SecMaster UpdateComponentConfiguration/v1 | This API is used to save component configuration. | |
| Creating a Configuration Application | hcloud SecMaster CreateConfigurationApplication/v1 | This API is used to create a configuration application. | |
| 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. | |
| Querying the Running Node List | hcloud SecMaster ListRunningNodes/v1 | This API is used to query the list of running nodes. | |
| Querying the Component Template List | hcloud SecMaster ListComponentTemplate/v1 | This API is used to query the list of component templates. |
Alert Rule Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Listing Alert Rules | hcloud SecMaster ListAlertRules/v1 | This API is used to list alert rules. | |
| Creating an Alert Rule | hcloud SecMaster CreateAlertRule/v1 | This API is used to create an alert rule. | |
| Deleting an Alert Rule | hcloud SecMaster DeleteAlertRule/v1 | This API is used to delete an alert rule. | |
| Disabling an Alert Rule | hcloud SecMaster DisableAlertRule/v1 | This API is used to disable an alert rule. | |
| Enabling an Alert Rule | hcloud SecMaster EnableAlertRule/v1 | This API is used to enable an alert rule. | |
| Querying Alert Rules | hcloud SecMaster ListAlertRuleMetrics/v1 | This API is used to query alert rules. | |
| Simulating an Alert Rule | hcloud SecMaster CreateAlertRuleSimulation/v1 | This API is used to simulate an alert rule. | |
| Querying the Alert Rule Template List | hcloud SecMaster ListAlertRuleTemplates/v1 | This API is used to query the alert rule template list. | |
| Querying Alert Template Overview | hcloud SecMaster ListAlertRuleTemplateMetrics/v1 | This API is used to querying alert template overview. | |
| Viewing Alert Rule Templates | hcloud SecMaster ShowAlertRuleTemplate/v1 | This API is used to view alert rule templates. | |
| Querying an Alert Rule | hcloud SecMaster ShowAlertRule/v1 | This API is used to query an alert rule. | |
| Updating an Alert Rule | hcloud SecMaster UpdateAlertRule/v1 | This API is used to update an alert rule. |
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. | |
| Creating a Data Space | hcloud SecMaster CreateDataspace/v1 | This API is used to create a data space. | |
| Obtaining Data Space Details | hcloud SecMaster ShowDataspace/v1 | This API is used to obtain data space details. | |
| Modifying a Data Space | hcloud SecMaster UpdateDataspace/v1 | This API is used to modify a data space. | |
| Deleting a Data Space | hcloud SecMaster DeleteDataspace/v1 | This API is used to delete a data space. |
Pipeline Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Creating a Data Pipeline | hcloud SecMaster CreatePipe/v1 | This API is used to create a data pipeline. |
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. | |
| Saving Cloud Service Log Collection Configuration | hcloud SecMaster CreateCollectConfig/v1 | This API is used to save cloud service collection configurations. | |
| Querying the Region List | hcloud SecMaster ListRegions/v1 | This API is used to query the region list. |
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. | |
| Listing Cloud Log Resources | hcloud SecMaster ListCloudLogResources/v1 | This API is used to list cloud log resources. | |
| Creating Cloud Log Resources | hcloud SecMaster CreateResourceConfig/v1 | This API is used to create cloud log resources. | |
| Query the Industry Monitoring Status | hcloud SecMaster ShowCloudLogTenantWhitelist/v1 | This API is used to query whether industry monitoring is enabled. | |
| Querying the List of Platform Industry Monitoring Accounts | hcloud SecMaster ListCloudLogPlatform/v1 | List Cloud Log Resources | |
| Querying the List of Industry Monitoring Accounts | hcloud SecMaster ListCloudLogManages/v1 | This API is used to list cloud log resources. | |
| Deleting LTS Log Subscription | hcloud SecMaster DeleteLtsCloudLog/v1 | This API is used to list cloud log resources. | |
| Querying the List of Pipeline Aliases | hcloud SecMaster ListCloudLogAlias/v1 | This API is used to list cloud log resources. |
Monitoring
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining Metric Statistics | hcloud SecMaster ShowMoniterMetricStats/v1 | This API is used to obtain metric statistics. |
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. | |
| Obtaining Data Pipeline Details | hcloud SecMaster ShowPipe/v1 | This API is used to obtain data pipeline details. | |
| Modifying a Data Pipeline | hcloud SecMaster UpdatePipe/v1 | This API is used to modify a data pipeline. | |
| Deleting a Data Pipeline | hcloud SecMaster DeletePipe/v1 | This API is used to deleting a data pipeline. | |
| Querying Real-Time Consumption Configurations | hcloud SecMaster ShowPipeConsumption/v1 | Querying Real-Time Consumption Configurations | |
| Enabling Real-time Consumption | hcloud SecMaster CreatePipeConsumption/v1 | Enabling Real-time Consumption | |
| Disabling Real-Time Consumption | hcloud SecMaster DeletePipeConsumption/v1 | This API is used to disable real-time consumption. | |
| Obtaining Index Information | hcloud SecMaster ShowPipeIndex/v1 | This API is used to obtain index information. | |
| Modifying Indexes | hcloud SecMaster UpdatePipeIndex/v1 | This API is used to modify indexes. |
Query and Analysis
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. | |
| Creating Search Criteria | hcloud SecMaster CreateSearchCondition/v1 | This API is used to create search criteria. | |
| This API is used to query search criteria details. | hcloud SecMaster ShowSearchCondition/v1 | Querying Search Criteria Details | |
| Modifying Search Criteria | hcloud SecMaster UpdateSearchCondition/v1 | This API is used to modify search criteria. | |
| Deleting Search Criteria | hcloud SecMaster DeleteSearchCondition/v1 | This API is used to delete search criteria. |
Data Delivery
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Delivery Information | hcloud SecMaster ListShippers/v1 | This API is used to query delivery information. | |
| Creating a Data Delivery | hcloud SecMaster CreateShipper/v1 | This API is used to create a data delivery. | |
| Deleting Delivery Information | hcloud SecMaster DeleteShipper/v1 | This API is used to delete delivery information. | |
| Obtaining the Delivery Authorization List | hcloud SecMaster ListShipperAuthorizations/v1 | This API is used to obtain the delivery authorization list. | |
| Handling Authorization Requests | hcloud SecMaster HandleShipperAuthorization/v1 | This API is used to handle authorization requests. | |
| Obtaining Agency Permissions | hcloud SecMaster ShowShipperDelegateAuth/v1 | This API is used to obtain agency permissions. | |
| Creating Agency Permissions | hcloud SecMaster CreateShipperDelegateAuth/v1 | This API is used to create agency permissions. | |
| Querying Parameters | hcloud SecMaster ShowShipperParam/v1 | This API is used to query parameters. | |
| Querying Delivery Rule Details | hcloud SecMaster ShowShipper/v1 | This API is used to query delivery rule details. | |
| Performing Authorization Again | hcloud SecMaster RetryShipperAuthorization/v1 | This API is used to perform authorization again. | |
| Suspending a Delivery | hcloud SecMaster PauseShipper/v1 | This API is used to suspend a delivery. | |
| Starting a Delivery | hcloud SecMaster ResumeShipper/v1 | This API is used to start a delivery. | |
| Restarting a Delivery | hcloud SecMaster RetryShipper/v1 | This API is used to restart a delivery. |
Analysis and Query
| API Name | Command | Description | Operation |
|---|---|---|---|
| Executing Analysis | hcloud SecMaster CreateSearchAnalysis/v1 | This API is used to execute analysis. |
Workflow Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Workflow List | hcloud SecMaster ListWorkflows/v1 | This API is used to query the workflow list. | |
| Creating a Workflow | hcloud SecMaster CreateAopWorkflow/v1 | This API is used to create a workflow. | |
| Querying Workflow Details | hcloud SecMaster ShowAopWorkflow/v1 | This API is used to query workflow details. | |
| Updating a Workflow | hcloud SecMaster UpdateAopWorkflow/v1 | This API is used to update a workflow. | |
| Deleting a Workflow | hcloud SecMaster DeleteAopWorkflow/v1 | This API is used to delete a workflow. |
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. | |
| Creating a Workflow Version | hcloud SecMaster CreateAopWorkflowVersion/v1 | This API is used to create a workflow version. | |
| Querying Workflow Version Details | hcloud SecMaster ShowAopWorkflowVersion/v1 | This API is used to query workflow version details. | |
| Updating the Workflow Version Information | hcloud SecMaster UpdateAopWorkflowVersion/v1 | This API is used to update the workflow version information. | |
| Deleting a Workflow Version | hcloud SecMaster DeleteAopWorkflowVersion/v1 | This API is used to delete a workflow version. | |
| Reviewing the Workflow Version for Release | hcloud SecMaster CreateAopWorkflowVersionApprovel/v1 | This API is used to review a workflow version. | |
| Verifying a Workflow Version | hcloud SecMaster ValidateAopWorkflowVersion/v1 | This API is used to verify a workflow version. |
Workflow Packaging Management
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. | |
| Querying the Workflow Instance List | hcloud SecMaster ListAopWorkflowInstance/v1 | This API is used to query workflow instance list. | |
| Querying the Details of a Workflow Instance | hcloud SecMaster ShowAopWorkflowInstance/v1 | This API is used to query the details of a workflow instance. | |
| Updating a Workflow Instance | hcloud SecMaster UpdateWorkflowInstance/v1 | This API is used to update a workflow instance. |
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. | |
| Enabling or Configuring SecMaster Subscription | hcloud SecMaster CreateSubscriptionOrder/v1 | This API is used to enable or configure the subscription to SecMaster. | |
| Updating a Resource | hcloud SecMaster UpdateSubscriptionOrder/v1 | This API is used to update a subscribed resource. | |
| 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. | |
| 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. | |
| Querying the List of Purchased Resources | hcloud SecMaster ListSubscriptionGlobalOrder/v1 | This API is used to query the list of purchased resources. |
Metric Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Batch Querying Metrics | hcloud SecMaster BatchSearchMetricHits/v1 | This API is used to batch query metrics. |
Comment
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Comment List | hcloud SecMaster ListNotes/v1 | This API is used to query the comment list. | |
| Creating a Comment | hcloud SecMaster CreateNote/v1 | This API is used to create comments. | |
| Deleting a Comment | hcloud SecMaster DeleteNotes/v1 | This API is used to delete a comment. |
Dictionary Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying Dictionary Information | hcloud SecMaster ListConfigurationDictionaries/v1 | This API is used to query dictionary information. | |
| Creating a Dictionary | hcloud SecMaster CreateConfigurationDictionaries/v1 | This API is used to create dictionary data. | |
| Updating a Dictionary | hcloud SecMaster UpdateConfigurationDictionaries/v1 | This API is used to update dictionary data. | |
| Deleting a Dictionary | hcloud SecMaster DeleteConfigurationDictionaries/v1 | This API is used to delete dictionary data. |
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. | |
| Querying Plug-in Details | hcloud SecMaster ShowComponent/v1 | This API is used to query plug-in details. | |
| Querying the Plug-in Action List | hcloud SecMaster ListComponentActions/v1 | This API is used to query the plug-in function, connector, and manager list | |
| Querying Plug-in Action Details | hcloud SecMaster ShowComponentAction/v1 | This API is used to query plug-in action details. |
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. | |
| Creating an Operation Connection | hcloud SecMaster CreateConnection/v1 | This API is used to create an operation connection. | |
| Querying Operation Connection Details | hcloud SecMaster ShowConnection/v1 | This API is used to query operation connection details. | |
| Updating an Operation Connection | hcloud SecMaster UpdateConnection/v1 | This API is used to update an operation connection. | |
| Deleting an Operation Connection | hcloud SecMaster DeleteConnection/v1 | This API is used to delete an operation connection. |
Attachment Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Uploading an Attachment | hcloud SecMaster UploadAttachment/v1 | This API is used to upload an attachment to OBS. | |
| Downloading an Attachment | hcloud SecMaster DownloadAttachment/v1 | This API is used to download an attachment from OBS. | |
| Obtaining Attachment Details | hcloud SecMaster ShowAttachment/v1 | This API is used to obtain attachment details. |
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. | |
| Creating a Plugin Configuration Template | hcloud SecMaster CreateComponentTemplate/v1 | This API is used to create a plugin configuration template during workflow configuration. | |
| Querying Plugin Configuration Template Details | hcloud SecMaster ShowComponentTemplate/v1 | This API is used to query the plugin configuration template details during workflow configuration. | |
| Updating a Plugin Configuration Template | hcloud SecMaster UpdateComponentTemplate/v1 | This API is used to update a plugin configuration template during workflow configuration. | |
| Deleting a Plugin Configuration Template | hcloud SecMaster DeleteComponentTemplate/v1 | This API is used to delete a plugin configuration template during workflow configuration. |
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. | |
| Querying the Field List | hcloud SecMaster ListDataclassFields/v1 | This API is used to query the field list. | |
| Querying Data Class Details | hcloud SecMaster ShowDataClassInfo/v1 | This API is used to query data class details. |
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. | |
| Deleting a Data Class Type | hcloud SecMaster DeleteDataclassType/v1 | This API is used to delete a data class type. | |
| Enabling/Disabling a Data Class Type | hcloud SecMaster EnableDataclassType/v1 | This API is used to disable or enable a data class type. |
Alert Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Alert List | hcloud SecMaster ListAlerts/v1 | This API is used to query the alert list. | |
| Creating an Alert | hcloud SecMaster CreateAlert/v1 | This API is used to create an alert. | |
| Deleting an Alert | hcloud SecMaster DeleteAlert/v1 | This API is used to delete an alert. | |
| Converting an Alert into an Incident | hcloud SecMaster CreateBatchOrderAlerts/v1 | This API is used to convert alerts into incidents. | |
| Obtain Alert Details | hcloud SecMaster ShowAlert/v1 | This API is used to obtain alert details. | |
| 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. | |
| 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. | |
| Batch Deleting Alerts | hcloud SecMaster DeleteAlerts/v1 | This API is used to batch delete alerts. | |
| 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. | |
| 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. | |
| 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. |
Incident Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Incident List | hcloud SecMaster ListIncidents/v1 | This API is used to query the incident list. | |
| Creating an Incident | hcloud SecMaster CreateIncident/v1 | This API is used to create an incident. | |
| Deleting an Incident | hcloud SecMaster DeleteIncident/v1 | This API is used to delete an incident. | |
| Querying Details About an Incident | hcloud SecMaster ShowIncident/v1 | This API is used to obtain the details about an incident. | |
| 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. | |
| 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. | |
| Batch Deleting Incidents | hcloud SecMaster DeleteIncidents/v1 | This API is used to batch delete incidents. | |
| 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. | |
| 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. | |
| 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. |
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. | |
| Creating a Threat Indicator | hcloud SecMaster CreateIndicator/v1 | This API is used to create a threat indicator. | |
| Deleting a Threat Indicator | hcloud SecMaster DeleteIndicator/v1 | Deleting a Threat Indicator | |
| Querying Details About a Threat Indicator | hcloud SecMaster ShowIndicatorDetail/v1 | This API is used to query the details about a threat indicator. | |
| Updating a Threat Indicator | hcloud SecMaster UpdateIndicator/v1 | This API is used to update a threat indicator. | |
| 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. | |
| 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. | |
| 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. |
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. | |
| Associating a Data Object | hcloud SecMaster CreateDataobjectRelation/v1 | This API is used to associate a data object. | |
| Canceling Association with a Data Object | hcloud SecMaster DeleteDataobjectRelation/v1 | This API is used to cancel association with a data object. | |
| Batch Associating Data Objects | hcloud SecMaster BatchCreateDataobjectRelations/v1 | This API is used to batch associate data objects. |
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. | |
| Creating a Data Object | hcloud SecMaster CreateDataobject/v1 | This API is used to create data objects. | |
| Batch Deleting Data Objects | hcloud SecMaster DeleteDataobjects/v1 | This API is used to batch delete data objects. | |
| Querying a Data Object | hcloud SecMaster ShowDataobject/v1 | This API is used to query a data object. | |
| Editing a Data Object | hcloud SecMaster UpdateDataobject/v1 | This API is used to update a data object. | |
| Exporting a Data Object | hcloud SecMaster ExportDataobjects/v1 | This API is used to export data objects. | |
| Importing a Data Object | hcloud SecMaster ImportDataobjects/v1 | This API is used to import data objects. |
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. | |
| Querying a Data Plane Object | hcloud SecMaster ShowDatapanelObject/v1 | This API is used to query details about managed data objects on the data plane. | |
| 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. |
Layouts
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Layout List | hcloud SecMaster ListLayout/v1 | This API is used to query the layout list. | |
| Creating a Layout | hcloud SecMaster CreateLayout/v1 | This API is used to create a layout. | |
| Deleting a Layout | hcloud SecMaster DeleteLayouts/v1 | This API is used to delete a layout. | |
| Querying Layout Details | hcloud SecMaster ShowLayout/v1 | This API is used to query layout details. | |
| Modifying a Layout | hcloud SecMaster UpdateLayout/v1 | This API is used to modify a layout. | |
| Managing Layouts | hcloud SecMaster ExecuteLayout/v1 | This API is used to manage a layout. | |
| Querying the Layout Page List | hcloud SecMaster ListLayoutWizards/v1 | This API is used to query all layouts. | |
| Creating a Layout Page | hcloud SecMaster CreateLayoutWizard/v1 | This API is used to create a layout. | |
| Querying Layout Page Details | hcloud SecMaster ShowLayoutWizardByField/v1 | This API is used to query layout page details. | |
| Batch Updating Layout Pages | hcloud SecMaster UpdateLayoutWizards/v1 | This API is used to update a layout. | |
| Querying the Layout Page | hcloud SecMaster ShowLayoutWizard/v1 | This API is used to query the layout page. | |
| Deleting a Layout Page | hcloud SecMaster DeleteLayoutWizard/v1 | This API is used to delete a layout. | |
| Querying the Module List | hcloud SecMaster ListModules/v1 | This API is used to query all modules. | |
| Creating a Module | hcloud SecMaster CreateModule/v1 | This API is used to create a module. | |
| Querying Module Details | hcloud SecMaster ShowModule/v1 | This API is used to query module details. | |
| Updating a Layout Module | hcloud SecMaster UpdateModule/v1 | This API is used to update a layout module. | |
| Deleting a Module | hcloud SecMaster DeleteModule/v1 | This API is used to delete a module. |
Security Reports
| API Name | Command | Description | Operation |
|---|---|---|---|
| Managing Security Reports | hcloud SecMaster ExecuteReportAction/v1 | This API is used to manage a security report. | |
| Obtaining Security Report Details | hcloud SecMaster ShowReportInfo/v1 | This API is used to obtain report details. | |
| Updating a Security Report | hcloud SecMaster UpdateReport/v1 | This API is used to update a security report. | |
| Deleting a Security Report | hcloud SecMaster DeleteReport/v1 | This API is used to delete a security report. | |
| Querying the Security Report List | hcloud SecMaster ListReports/v1 | This API is used to obtain the report list. | |
| Creating a Security Report | hcloud SecMaster CreateReport/v1 | This API is used to create a security report. | |
| Updating the Recipient Email Address Status | hcloud SecMaster UpdateRecipientsEmailStatus/v1 | This API is used to update the email address status of a recipient. | |
| Querying the Recipient Status | hcloud SecMaster ListRecipientsStatus/v1 | This API is used to query the status of a recipient. |
Directory Customization
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Directory List | hcloud SecMaster ListAllSecondCatalogue/v1 | This API is used to query the directory list. | |
| Creating a Custom Directory | hcloud SecMaster CreateCatalogue/v1 | This API is used to create a custom directory. | |
| Batch Deleting Directories | hcloud SecMaster DeleteCatalogue/v1 | This API is used to batch delete directories. | |
| Modifying a Custom Directory | hcloud SecMaster UpdateCatalogue/v1 | This API is used to modify a custom directory. | |
| 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. | |
| Batch Modifying Directories | hcloud SecMaster BatchUpdateCatalogue/v1 | This API is used to batch modify custom directories. |
Metric Definitions
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Metric List | hcloud SecMaster ListMetrics/v1 | This API is used to query the metric list. | |
| Creating a Metric | hcloud SecMaster CreateMetric/v1 | This API is used to create a metric. | |
| Obtaining Metric Metadata | hcloud SecMaster ShowMetricMetaData/v1 | This API is used to obtain metric metadata. | |
| Updating a Metric Definition | hcloud SecMaster UpdateMetrics/v1 | This API is used to update a metric definition. | |
| Deleting a Metric | hcloud SecMaster DeleteMetrics/v1 | This API is used to delete a metric. |
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. | |
| Querying Classification & Mapping Functions | hcloud SecMaster ShowMappingFunction/v1 | This API is used to query functions used for classifications and mappings. | |
| Copying a Mapping | hcloud SecMaster CopyMapping/v1 | This API is used to copy a mapping. | |
| Deleting Mapping Information | hcloud SecMaster DeleteMappingInfo/v1 | This API is used to delete mapping information. | |
| Modifying the Status of a Mapping | hcloud SecMaster UpdateMappingInfoStatus/v1 | This API is used to modifying the status of a categorical mapping. | |
| Adding a Classification | hcloud SecMaster CreateClassifier/v1 | This API is used to add a classification. | |
| Querying Classification Details | hcloud SecMaster ShowClassifierInfo/v1 | This API is used to query classification details. | |
| Modifying a Classification | hcloud SecMaster UpdateClassifier/v1 | This API is used to modify a classification. | |
| Deleting a Classification | hcloud SecMaster DeleteClassifier/v1 | This API is used to delete a classification. | |
| Adding a Mapping | hcloud SecMaster CreateMapper/v1 | This API is used to add a mapping. | |
| Querying the Mapping List | hcloud SecMaster ShowMapperList/v1 | This API is used to query the mapping list. | |
| Querying Mapping Details | hcloud SecMaster ShowMapperDetail/v1 | This API is used to query mapping details. | |
| Modifying a Mapping | hcloud SecMaster UpdateMapper/v1 | Modifying a Mapping | |
| Deleting a Mapping | hcloud SecMaster DeleteSingleMapper/v1 | This API is used to delete a mapping. | |
| Creating a Preprocessing Rule | hcloud SecMaster CreatePreProcessRules/v1 | This API is used to create a preprocessing rule. | |
| Querying Preprocessing Rules | hcloud SecMaster ShowPreProcessRulesList/v1 | This API is used to query preprocessing rules. |
Playbook Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Monitoring Playbook Running | hcloud SecMaster ShowPlaybookMonitors/v1 | Playbook Running Monitoring (Offline Soon) | |
| Querying Playbook Statistics Data | hcloud SecMaster ShowPlaybookStatistics/v1 | Playbook Statistics (Offline Soon) | |
| Querying the Playbook List | hcloud SecMaster ListPlaybooks/v1 | This API is used to query the playbook list. | |
| Creating a Playbook | hcloud SecMaster CreatePlaybook/v1 | This API is used to create a playbook. | |
| Querying Playbook Details | hcloud SecMaster ShowPlaybook/v1 | This API is used to query details about a playbook. | |
| Modifying a Playbook | hcloud SecMaster UpdatePlaybook/v1 | This API is used to modify a playbook. | |
| Deleting a Playbook | hcloud SecMaster DeletePlaybook/v1 | This API is used to delete a playbook. |
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) | |
| Querying the Playbook Version List | hcloud SecMaster ListPlaybookVersions/v1 | This API is used to query the version list of a playbook. | |
| Creating a Playbook Version | hcloud SecMaster CreatePlaybookVersion/v1 | This API is used to create a playbook version. | |
| Querying Playbook Version Details | hcloud SecMaster ShowPlaybookVersion/v1 | This API is used to query playbook version details. | |
| Updating a Playbook Version | hcloud SecMaster UpdatePlaybookVersion/v1 | This API is used to update a playbook version. | |
| Deleting a Playbook Version | hcloud SecMaster DeletePlaybookVersion/v1 | This API is used to delete a playbook version. |
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. | |
| Querying Playbook Rule Details | hcloud SecMaster ShowPlaybookRule/v1 | This API is used to query details about a playbook rule. | |
| Updating a Playbook Rule | hcloud SecMaster UpdatePlaybookRule/v1 | This API is used to update a playbook rule. | |
| Deleting a Playbook Rule | hcloud SecMaster DeletePlaybookRule/v1 | This API is used to delete a playbook rule. |
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. | |
| Querying Details About a Playbook Instance | hcloud SecMaster ShowPlaybookInstance/v1 | This API is used to query details about a playbook instance. | |
| Operating a Playbook Instance | hcloud SecMaster ChangePlaybookInstance/v1 | Operating a Playbook Instance | |
| Querying the Playbook Topology | hcloud SecMaster ShowPlaybookTopology/v1 | Querying the Playbook Topology | |
| Querying Review Logs of a Playbook Instance | hcloud SecMaster ListPlaybookAuditLogs/v1 | Querying Review Logs of a Playbook Instance |
Playbook Review Management
Playbook Action Management (Offline Soon)
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Playbook Workflow | hcloud SecMaster ListPlaybookActions/v1 | Querying the Playbook Workflow List | |
| Creating a Playbook Workflow | hcloud SecMaster CreatePlaybookAction/v1 | This API is used to create a playbook workflow. | |
| Updating a Playbook Workflow | hcloud SecMaster UpdatePlaybookAction/v1 | This API is used to update a playbook workflow. | |
| Deleting a Playbook Workflow | hcloud SecMaster DeletePlaybookAction/v1 | This API is used to delete a playbook workflow. |
Playbook Packaging Management
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. | |
| Querying Policy View Objects | hcloud SecMaster ShowPolicy/v1 | This API is used to query policy view objects. | |
| Batch Deleting Emergency Policies | hcloud SecMaster DeletePolicies/v1 | This API is used to batch delete emergency policies. | |
| Querying the Policy View List | hcloud SecMaster SearchPolicy/v1 | This API is used to query the policy view list. | |
| Querying the Task View List | hcloud SecMaster SearchPolicyRecord/v1 | This API is used to query the task view list. | |
| 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. |
Resource Manager
| API Name | Command | Description | Operation |
|---|---|---|---|
| Querying the Resource List | hcloud SecMaster ListResources/v1 | This API is used to query the resource list. | |
| Deleting a Resource | hcloud SecMaster DeleteResource/v1 | This API is used to delete a resource. | |
| Obtaining Resource Details | hcloud SecMaster ShowResource/v1 | This API is used to obtain resource details. | |
| 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. | |
| 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. | |
| Exporting the Resource List | hcloud SecMaster ExportResources/v1 | This API is used to export the resource list. | |
| Downloading the Resource Import Template | hcloud SecMaster DownloadResourceTemplate/v1 | This API is used to download the resource import template. |
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. | |
| Querying Details About a To-Do Task | hcloud SecMaster ShowTask/v1 | This API is used to query details about a to-do task. | |
| Updating To-Do Task Information | hcloud SecMaster UpdateTask/v1 | This API is used to update to-do task information. |
Vulnerability Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Obtaining Vulnerability Details | hcloud SecMaster ShowVulnerability/v1 | This API is used to obtain vulnerability details. | |
| Querying the Vulnerability List | hcloud SecMaster ListVulnerabilities/v1 | This API is used to query the list of detected vulnerabilities. | |
| Exporting Vulnerabilities | hcloud SecMaster ExportVulnerabilities/v1 | This API is used to export vulnerability details. | |
| 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. | |
| 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. |
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. | |
| Batch Deleting Resource Tags | hcloud SecMaster BatchUntagResources/v1 | This API is used to batch delete tags from a specified instance. | |
| Updating a Tag Value | hcloud SecMaster UpdateTagValue/v1 | This API is used to update a tag value. | |
| Querying Resource Tags | hcloud SecMaster ListResourceTag/v1 | This API is used to query tags of a specific resource. | |
| Querying Tags in a Project | hcloud SecMaster ListProjectTag/v1 | This API is used to query tags of all resources in a specified project. | |
| Batch Adding tags to a Resource | hcloud SecMaster BatchTagResources/v1 | This API is used to batch add tags for a specified instance. |
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. | |
| Querying the Number of Resource Instances | hcloud SecMaster CountResourceInstance/v1 | This API is used to query the number of resource instances by tag. |
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. | |
| 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. | |
| 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. | |
| Updating a Workspace | hcloud SecMaster UpdateWorkspace/v1 | This API is used to update the name, description, and other information of a workspace. | |
| Deleting a Workspace | hcloud SecMaster DeleteWorkspace/v1 | This API is used to delete a workspace. |
Agency Management
| API Name | Command | Description | Operation |
|---|---|---|---|
| Viewing Agency Information | hcloud SecMaster ListServiceAgency/v1 | check service linked agency | |
| 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. |
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot