templates/{id}

'Get,Update and delete client scoped Templates'

Note

  • This endpoint applies only to G2 templates.
  • For New UI (V2) payloads, include the Monitoring-Version: V2 header.

Get template details

Path Parameters

  • idstringrequired

    Template uuid

  • clientIdstringrequired

    Describes the client unique identifier of the tenant

Responses

  • idstring

    Template uuid

  • namestringrequired

    Template name

  • descriptionstring

    Template details

  • collectorTypestringrequired

    Collector Type

  • resourceTypestringrequired

    Template applicable for native type resources.

  • generationintegerrequired

    Template generation

  • tagsstring

    Tag

  • createdDatestring

    Template creation timestamp.

  • updatedDatestring

    Template last update timestamp.

  • scopestring

    Template scope such as GLOBAL, PARTNER, or CLIENT.

  • templateFamilystring

    Template family

  • notesstring

    Brief details

  • prerequisitesstring

    Pre-requisite details needed before applying the template.

  • deploymentTypestring

    Template deployment type.

  • appNamestring

    Application name associated with the template.

  • nativeTypestring

    Native type associated with the template.

  • assignedToResourcesboolean

    Indicates whether template is assigned to resources.

  • templateTypearray of strings

    Template category list.

  • metricGroupsarray

    Metric groups for G2 and advanced templates.

  • sdkTagstring

    SDK tag associated with exported template payloads.

  • monTemplateVerinteger

    Monitoring template version.

  • monitorsarray

    Template monitors

  • statusobject

Loading Examples...

Update a template configuration

Path Parameters

  • idstringrequired

    Template uuid

  • clientIdstringrequired

    Describes the client unique identifier of the tenant

Request Body

application/json

  • namestring

    Template name

  • descriptionstring

    Template Details

  • statusobject

  • tagsstring

    Template tag

  • templateFamilystring

    Template family

  • notesstring

  • monitorsarray

    Template monitors

Loading Examples...

Responses

  • idstring

    Template uuid

  • namestringrequired

    Template name

  • descriptionstring

    Template details

  • collectorTypestringrequired

    Collector Type

  • resourceTypestringrequired

    Template applicable for native type resources.

  • generationintegerrequired

    Template generation

  • tagsstring

    Tag

  • createdDatestring

    Template creation timestamp.

  • updatedDatestring

    Template last update timestamp.

  • scopestring

    Template scope such as GLOBAL, PARTNER, or CLIENT.

  • templateFamilystring

    Template family

  • notesstring

    Brief details

  • prerequisitesstring

    Pre-requisite details needed before applying the template.

  • deploymentTypestring

    Template deployment type.

  • appNamestring

    Application name associated with the template.

  • nativeTypestring

    Native type associated with the template.

  • assignedToResourcesboolean

    Indicates whether template is assigned to resources.

  • templateTypearray of strings

    Template category list.

  • metricGroupsarray

    Metric groups for G2 and advanced templates.

  • sdkTagstring

    SDK tag associated with exported template payloads.

  • monTemplateVerinteger

    Monitoring template version.

  • monitorsarray

    Template monitors

  • statusobject

Loading Examples...

Deletes a template or removes template attributes

Notes

  • Users cannot delete assigned templates.
  • Removes unassigned templates only.

Path Parameters

  • idstringrequired

    Template uuid

  • clientIdstringrequired

    Describes the client unique identifier of the tenant

Responses

200OK

Loading Examples...