Skip to main content

Get

Description#

Retrieve a private template

Request#

HTTP Method: GET

Query ParameterDescription
N/A
Path ParameterDescription
template-idThe template id.
curl -X GET \  https://<tenant-domain>/api/v1/admin/templates/<template-id> \  -H 'content-type: application/json' \  -H 'x-user-email: <email-address>' \  -H 'x-user-token: <api-token>'

Response#

A successful request will return a private template.

Field description#

ParameterDescription
idTemplate ID.
nameTemplate name.
descriptionTemplate description.
agent typeType of action associated with the template.
agent optionsAction options.
vendorVendor name.
productProduct name.

Sample response#

{   "id": "472463921472463921",   "name": Extract some text,   "description": "test",   "agent_type": "Event Transformation",   "agent_options": {       "mode": "extract",       "matchers": [           {               "path": "",               "regexp": "\\b[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,4}\\b",               "to": "email_addresses"           },           {               "path": "",               "regexp": "https?:\\/\\/[\\S]+",               "to": "urls"           }       ],       "message": "This is an optional message"   },   "vendor": "API",   "product": "API"}