Updated on 2026-09-02 GMT+08:00

Adding a Custom Template

Function

This API is used to add the configuration file of a Logstash cluster to a custom template.

Calling Method

For details, see Calling APIs.

URI

POST /v1.0/{project_id}/clusters/{cluster_id}/lgsconf/favorite

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition Project ID. For details about how to obtain the project ID and name, see Obtaining the Project ID and Name. Constraints N/A Range Project ID of an account. The value contains 32 characters, consisting of lowercase letters and digits. Default Value N/A
cluster_id	Yes	String	Definition ID of the cluster where a custom template is to be added. For details about how to obtain the cluster ID, see Obtaining the Cluster ID. Constraints N/A Range The value is a UUID containing 36 characters. Default Value N/A

Request Parameters

**Table 2** Request body parameters
Parameter	Mandatory	Type	Description
name	Yes	String	Definition Configuration file name. Constraints N/A Range N/A Default Value N/A
template	Yes	AddFavoriteReqTemplate object	Definition Custom template entity object. Constraints N/A

**Table 3** AddFavoriteReqTemplate
Parameter	Mandatory	Type	Description
templateName	Yes	String	Definition Custom template name. Constraints N/A Range The name can contain 4 to 32 characters and must start with a letter. Only letters, digits, hyphens (-), and underscores (_) are allowed. Default Value N/A
desc	No	String	Definition Template description. Constraints N/A Range The value can contain at most 256 characters. Default Value N/A

Response Parameters

Status code: 200

Request succeeded.

None

Example Requests

Configure a user-defined template.

POST https://{Endpoint}/v1.0/{project_id}/clusters/4f3deec3-efa8-4598-bf91-560aad1377a3/lgsconf/favorite

{
  "name" : "conf1",
  "template" : {
    "templateName" : "template1",
    "desc" : "Custom template"
  }
}

Example Responses

None

Status Codes

Status Code	Description
200	Request succeeded.
400	Invalid request. The client should modify the request instead of re-initiating it.
409	The request cannot be processed due to a conflict. This status code indicates that the resource that the client attempts to create already exits, or the requested update failed due to a conflict.
412	The server did not meet one of the preconditions contained in the request.

Error Codes

See Error Codes.

Parent topic: Logstash