Help Center/ SecMaster/ API Reference/ SecMaster APIs (V1)/ Layouts/ Managing Layouts
Updated on 2026-02-05 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Managing Layouts

Function

This API is used to manage a layout.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/workspaces/{workspace_id}/soc/layouts/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID, which is used to specify the project that a resource belongs to. You can query the resources of a project by project ID. You can obtain the project ID from the API or console. Obtaining the Project ID

Constraints

N/A

Range

N/A

Default Value

N/A

workspace_id

Yes

String

Definition

Workspace ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. You can obtain it by calling the IAM API for obtaining a user token. The user token is the value of X-Subject-Token in the response header. Obtaining a User Token

Constraints

N/A

Range

N/A

Default Value

N/A

content-type

Yes

String

Definition

Content type.

  • application/json;charset=UTF-8: common API request type

Constraints

N/A

Range

  • application/json;charset=UTF-8

Default Value

N/A
Table 3 FormData parameters

Parameter

Mandatory

Type

Description

action

Yes

String

The operation you want to perform for the layout.

VERIFY: checking the imported layout package

IMPORT: importing the layout package

EXPORT: exporting the layout

ids

No

String

IDs of layouts you want to operate.

uploadFile

No

File

File to be uploaded.

Response Parameters

Status code: 200

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.
Table 5 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Status code: 400

Table 6 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID. Format: request_uuid-timestamp-hostname.
Table 7 Response body parameters

Parameter

Type

Description

code

String

Definition

Error code.

Range

N/A

message

String

Definition

Error description.

Range

N/A

Example Requests

Check whether the imported layout file is valid.

{
  "uploadFile" : "Test.zip",
  "action" : "verify"
}

Example Responses

Status code: 200

Request successful

{
  "code" : "00000000",
  "message" : "success"
}

Status Codes

Status Code

Description

200

Request successful

400

Error response.

Error Codes

See Error Codes.

Parent Topic: Layouts