Updating the Identification Template Information

Function

This API is used to update details about a scan template based on the specified template ID and project ID, including the template name, description, and whether the template is the default template.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/scan-templates/{template_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID, which is used to identify a specific project.
template_id	Yes	String	Template ID, which is used to identify a specific scan template.

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
is_default	No	Boolean	Whether the default template is used.
template_desc	No	String	Template description, which briefly describes the template function.
template_name	No	String	Template name, which is used to identify and manage templates.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
msg	String	Returned message, which is used to describe the operation result or status information.
status	String	Returned status, which indicates whether the operation is successful. For example, 200 indicates that the operation is successful, and 400 indicates that the request is invalid.

Status code: 201

Template updated.

Example Requests

PUT /v1/{project_id}/scan-templates/{template_id}

{
  "is_default" : true,
  "template_desc" : "string",
  "template_name" : "string"
}

Example Responses

None

Status Codes

Status Code	Description
200	Request succeeded. The update result is returned.
201	Template updated.
401	Unauthorized. The user is not logged in or the token is invalid.
403	Unauthorized to access the resource.
404	The specified template is not found.