Skip to main content
API Explorer|API Explorer
Infrastructure/Agents
GETAgentSince 1.0SynchronousAuth Required

ListLabelTemplates

List all label templates stored in the system

Execution Availability

Try It Out

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

Request Inputs

This API requires no request parameters.

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 label template

      Example: tmpl-001-abc

    • nameString

      Human-readable name of the label template

      Example: production-baseline

    • descriptionString

      Description of the label template's intended usage

      Example: Standard labels for production agents

    • labelsLinkedHashMap

      Key-value labels attached to this resource

      Example: (nested object)

    • createdAtString

      Created at

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

  • totalInteger

    Total number of label templates available

    Example: 10

  • limitInteger

    Maximum number of templates returned

    Example: 20

  • offsetInteger

    Number of templates skipped for pagination

    Example: 20

Endpoint

GET/api/v1/agent/label-templates

/api/v1/agent/label-templates

Operation ID

ListLabelTemplates

Permalink

Request Example

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

Response Example

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

Change History

This API has no change history records yet.

View all change history