Skip to main content
API Explorer|API Explorer
Infrastructure/Collects
GETInfrastructureSince 1.0SynchronousAuth Required

ListTemplates

List all available collect configuration templates from the marketplace.

Execution Availability

Try It Out

Submit a mock request using the current auth context and example-driven inputs.

Query Parameters

Request Inputs

Query Parameters

  • categoryString

    Filter templates by category; empty returns all categories Filter templates by category; empty returns all categories

Responses

200 OK

On success, this API returns the following response structure.

  • itemsList

    Collection of result items

    Example: (nested array)

    • idString

      Unique identifier of the template

      Example: tmpl-nginx-001

    • nameString

      Human-readable name of the template

      Example: Nginx Access Log Collector

    • descriptionString

      Description of what this template collects and how it works

      Example: Collects Nginx access logs and parses common log format

    • categoryString

      Category grouping for the template (e.g. web, database, os)

      Example: web

    • authorString

      Author or organization that created this template

      Example: zstack

    • downloadsInteger

      Number of times this template has been downloaded

      Example: 120

    • ratingLong

      Average user rating of this template on a scale of 1 to 5

      Example: 4.5

    • configObject

      Configuration data as key-value pairs

      Example: (nested object)

    • variablesLinkedHashMap

      Template variables for parameter substitution

      Example: (nested object)

    • createDateString

      Create date

      Example: 2026-01-15T08:00:00Z

  • totalInteger

    Total number of matching templates

    Example: 15

  • limitInteger

    Maximum number of templates returned per page

    Example: 20

  • offsetInteger

    Number of templates skipped from the start

    Example: 20

Endpoint

GET/api/v1/collects/templates

/api/v1/collects/templates

Operation ID

ListTemplates

Permalink

Request Example

curl -X GET '{host}/api/v1/collects/templates' -H 'Authorization: Bearer {token}'

Response Example

200
{
  "items": [
    {}
  ],
  "total": 15,
  "limit": 20,
  "offset": 20
}

Change History

This API has no change history records yet.

View all change history