Help Center/ SecMaster/ API Reference/ SecMaster APIs (Excluding APIs for Security Analysis V2)/ Layouts/ Deleting a Layout
Updated on 2025-10-29 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Deleting a Layout

Function

Delete Layout.

Calling Method

For details, see Calling APIs.

URI

DELETE /v1/{project_id}/workspaces/{workspace_id}/soc/layouts

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 Request body parameters

Parameter

Mandatory

Type

Description

ids

Yes

Array of strings

id list

is_delete

No

Boolean

Whether to delete the layout. true: It will be deleted. If it is used, the deletion will fail.

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

Response code.

message

String

Response message.

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

Delete a layout.

{
  "ids" : [ "909494e3-558e-46b6-a9eb-07a8e18ca62f" ],
  "is_delete" : true
}

Example Responses

Status code: 200

Response of delete layout

{
  "code" : "909494e3-558e-46b6-a9eb-07a8e18ca62f",
  "message" : "",
  "success" : true
}

Status Codes

Status Code

Description

200

Response of delete layout

400

Error response

Error Codes

See Error Codes.

Parent topic: Layouts