templates/{id}

Get,Update and delete client scoped Templates

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

    Enum:
    agentgatewaysynthetics
  • resourceTypestringrequired

    Template applicable for native type resources.

  • generationintegerrequired

    Template generation

  • tagsstring

    Tag

  • createdDatestring

  • updatedDatestring

  • templateFamilystring

    Template family

  • notesstring

    Brief details

  • 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

    Enum:
    agentgatewaysynthetics
  • resourceTypestringrequired

    Template applicable for native type resources.

  • generationintegerrequired

    Template generation

  • tagsstring

    Tag

  • createdDatestring

  • updatedDatestring

  • templateFamilystring

    Template family

  • notesstring

    Brief details

  • 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...