Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Component Management/ Saving Component Configuration
Updated on 2025-12-18 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Saving Component Configuration

Function

This API is used to save component configuration.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/components/{component_id}/configurations

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

component_id

Yes

String

Component ID.

workspace_id

Yes

String

Workspace ID.

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

configuration

No

Array of ConfigurationDetail objects

Node configuration information.
Table 3 ConfigurationDetail

Parameter

Mandatory

Type

Description

config_status

No

String

Definition

Node deployment status.

  • UN_SAVED: to be saved

  • SAVE_AND_UN_APPLY: to be applied

  • MOVE_AND_UN_APPLY: to be removed

  • APPLYING: being applied

  • FAIL_APPLY: failed to be applied

  • APPLIED: applied

Constraints

N/A

Range

  • UN_SAVED

  • SAVE_AND_UN_APPLY

  • MOVE_AND_UN_APPLY

  • APPLYING

  • FAIL_APPLY

  • APPLIED

Default Value

N/A

list

Yes

Array of FileConfiguration objects

File configuration list.

node_id

No

String

Node ID.

node_name

No

String

Node name.

specification

No

String

Specifications.
Table 4 FileConfiguration

Parameter

Mandatory

Type

Description

file_name

No

String

File name.

file_type

Yes

String

Definition

File type.

  • JVM JVM configuration file type.

  • LOG4J2: Log4j2 log configuration file type

  • YML: YAML configuration file type

Constraints

N/A

Range

  • JVM

  • LOG4J2

  • YML

Default Value

N/A

node_id

No

String

Node ID.

param

Yes

Map<String,String>

Parameter.

type

No

String

Definition

Configuration type.

  • HISTORY: historical versions

  • CURRENT_SAVE: currently saved

  • CURRENT_APPLY: currently applied

Constraints

N/A

Range

  • HISTORY

  • CURRENT_SAVE

  • CURRENT_APPLY

Default Value

N/A

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

message

String

Result details.

result

String

Result.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

Successful.

Error Codes

See Error Codes.

Parent topic: Component Management