Listing Templates

Function

This API is used to filter and query launch template information in the database based on the request conditions.

URI

GET /v3/{project_id}/launch-templates

Table 1 describes the parameters in the URI.

**Table 1** Path parameters
Parameter	Mandatory	Description
project_id	Yes	Specifies the project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Specifies the maximum number of templates that can be returned. A maximum of 100 templates can be returned.
marker	No	String	Specifies the template ID to which the marker corresponds. The query will start from the next ID. This parameter must be used together with the parameter limit.
launch_template_id	No	Array of strings	Specifies the template ID.
name	No	Array of strings	Specifies the template name.

Request

None

Response

Table 3 describes the response parameters.

**Table 3** Response parameters
Parameter	Type	Description
launch_templates	Arrays Of Object	Specifies the template information. For details, see Table 4.
page_info	Object	Specifies the pagination information. For details, see Table 5.

**Table 4** **launch_template** parameters
Parameter	Type	Description
id	String	Specifies the template ID.
name	String	Specifies the template name.
description	String	Specifies the template description.
created_at	String	Specifies the time when the template was created.
updated_at	String	Specifies the time when the template was updated.
default_version	Integer	Specifies the default version of the template.
latest_version	Integer	Specifies the latest version of the template.

**Table 5** **page_info** parameters
Parameter	Type	Description
next_marker	String	Specifies the start index ID of the next page.
previous_marker	String	Specifies the start index ID of the previous page.

Example Request

List templates.

GET https://{endpoint}/v3/{projectId}/launch-templates

Example Response

{   
    "launch_templates": [     
       {       
         "id": "e6b99563-xxxx-xxxx-xxxx-1820d4fd2a67",   
         "name": "my-template",     
         "description": "this template is used for XXXXXX", 
         "created_at": "XXXXX-XX-XX",     
         "updated_at": "XXXXX-XX-XX",     
         "default_version": 2,      
         "latest_version": 3   
        }
      ], 
     "page_info": { 
        "next_marker": "string" 
      }
 }