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

Querying the Template List

Function

This API is used to query the template list of a Logstash cluster.

Calling Method

For details, see Calling APIs.

URI

GET /v1.0/{project_id}/lgsconf/template

**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

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
type	No	String	Definition Template type. Constraints N/A Range custom: custom template system: system template Default Value N/A

Request Parameters

None

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
systemTemplates	Array of systemTemplates objects	Definition List of system templates, including the content of system templates.
customTemplates	Array of customTemplates objects	Definition List of custom templates, including the content of custom templates.

**Table 4** systemTemplates
Parameter	Type	Description
id	String	Definition Configuration file ID. Range N/A
name	String	Definition Configuration file name. Range N/A
confContent	String	Definition Configuration file content. Range N/A
desc	String	Definition Configuration file description. Range N/A

**Table 5** customTemplates
Parameter	Type	Description
id	String	Definition Configuration file ID. Range N/A
name	String	Definition Configuration file name. Range N/A
confContent	String	Definition Configuration file content. Range N/A
desc	String	Definition Configuration file description. Range N/A

Example Requests

Query the template list.

GET https://{Endpoint}/v1.0/{project_id}/lgsconf/template?type=custom

Example Responses

Status code: 200

Request succeeded.

{
  "systemTemplates" : [ {
    "id" : "a03b1791-6dc6-453d-961d-88939adc82aa",
    "name" : "elasticsearch",
    "confContent" : "xxxxxxxx",
    "desc" : "logstash config for es"
  } ],
  "customTemplates" : [ {
    "id" : "2e16fbba-49bf-4690-93af-3f89025c6523",
    "name" : "es_to_https_es",
    "confContent" : "xxxxxxxx",
    "desc" : "From ES to an ES security cluster"
  } ]
}

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