templates

Creates, imports, or clones templates based on the request payload.

Defines the template details for creation, import, or cloning operations. The required fields vary depending on the type of operation being performed.

  • Pre-requisites
    • Existing Metrics
    • Existing Monitors
    • For Synthetic templates
      • Protocol info is must

Note

  • This endpoint applies only to G2 templates.
  • For New UI (V2) payloads, include the Monitoring-Version: V2 header.
  • For New UI (V2), import a single monitoring template using a JSON file.
  • To preserve the parent template relationship during import, include the parentUUID field in the exported JSON file.

Path Parameters

  • tenantIdstringrequired

    Describes the clientId or mspId of tenant

Request Body

application/json

  • namestringrequired

    Template name

  • descriptionstring

    Template details

  • collectorTypestringrequired

    Collector Type

    Enum:
    SyntheticsOpsRamp AgentOpsRamp Gateway
  • resourceTypestringrequired

    Template applicable for native type resources.

    Enum:
    DEVICESYNTHETIC

    Default: DEVICE

  • checkTypestring

    Support Synthetics protocol for which template is configured for monitoring. This attribute is must have a value when synthetic templates are created.

    Enum:
    HTTPSHTTPDNSIMAPPINGRTTPOP3SCRIPTSMTPSSLTCPUDPFTPSIP

    Default: HTTPS

  • statusobjectrequired

    Template activity status

  • tagsstring

    Tag

  • generationintegerrequired

    Template generation

    Default: 2

  • templateFamilystring

    Template family

  • notesstring

    Brief details

  • createdDatestring

    Template creation timestamp.

  • updatedDatestring

    Template last update timestamp.

  • prerequisitesstring

    Pre-requisite details needed before applying the template.

  • deploymentTypestring

    Template deployment type.

  • applicationTypearray of strings

    Application types associated with the template.

  • templateTypearray of strings

    Template category list.

  • monitorsarray

    Template monitors

  • metricGroupsarray

    Metric groups for G2 templates.

Loading Examples...

Responses

Loading Examples...