# Listener Templates

## GET /api/v2/listener-templates

> Get Listener Templates

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/listener-templates":{"get":{"tags":["listener-templates"],"summary":"Get Listener Templates","operationId":"get_listener_templates_api_v2_listener_templates_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListenerTemplates"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}}}}}},"components":{"schemas":{"ListenerTemplates":{"properties":{"records":{"items":{"$ref":"#/components/schemas/ListenerTemplate"},"type":"array","title":"Records"}},"type":"object","required":["records"],"title":"ListenerTemplates"},"ListenerTemplate":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Category"},"comments":{"items":{"type":"string"},"type":"array","title":"Comments"},"tactics":{"items":{"type":"string"},"type":"array","title":"Tactics"},"techniques":{"items":{"type":"string"},"type":"array","title":"Techniques"},"software":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Software"},"options":{"additionalProperties":{"$ref":"#/components/schemas/CustomOptionSchema"},"type":"object","title":"Options"}},"type":"object","required":["id","name","authors","description","category","comments","tactics","techniques","options"],"title":"ListenerTemplate"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"CustomOptionSchema":{"properties":{"description":{"type":"string","title":"Description"},"required":{"type":"boolean","title":"Required"},"value":{"type":"string","title":"Value"},"suggested_values":{"items":{"type":"string"},"type":"array","title":"Suggested Values"},"strict":{"type":"boolean","title":"Strict"},"editable":{"type":"boolean","title":"Editable","default":true},"value_type":{"$ref":"#/components/schemas/ValueType"},"internal":{"type":"boolean","title":"Internal"},"depends_on":{"items":{"$ref":"#/components/schemas/DependentOption"},"type":"array","title":"Depends On","default":[]}},"type":"object","required":["description","required","value","suggested_values","strict","value_type","internal"],"title":"CustomOptionSchema"},"ValueType":{"type":"string","enum":["STRING","FLOAT","INTEGER","BOOLEAN","FILE"],"title":"ValueType"},"DependentOption":{"properties":{"name":{"type":"string","title":"Name"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values"}},"type":"object","required":["name","values"],"title":"DependentOption"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"}}}}
```

## GET /api/v2/listener-templates/{uid}

> Get Listener Template

```json
{"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"paths":{"/api/v2/listener-templates/{uid}":{"get":{"tags":["listener-templates"],"summary":"Get Listener Template","operationId":"get_listener_template_api_v2_listener_templates__uid__get","parameters":[{"name":"uid","in":"path","required":true,"schema":{"type":"string","title":"Uid"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListenerTemplate"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestResponse"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ListenerTemplate":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"authors":{"items":{"$ref":"#/components/schemas/Author"},"type":"array","title":"Authors"},"description":{"type":"string","title":"Description"},"category":{"type":"string","title":"Category"},"comments":{"items":{"type":"string"},"type":"array","title":"Comments"},"tactics":{"items":{"type":"string"},"type":"array","title":"Tactics"},"techniques":{"items":{"type":"string"},"type":"array","title":"Techniques"},"software":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Software"},"options":{"additionalProperties":{"$ref":"#/components/schemas/CustomOptionSchema"},"type":"object","title":"Options"}},"type":"object","required":["id","name","authors","description","category","comments","tactics","techniques","options"],"title":"ListenerTemplate"},"Author":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"handle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Handle"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","title":"Author"},"CustomOptionSchema":{"properties":{"description":{"type":"string","title":"Description"},"required":{"type":"boolean","title":"Required"},"value":{"type":"string","title":"Value"},"suggested_values":{"items":{"type":"string"},"type":"array","title":"Suggested Values"},"strict":{"type":"boolean","title":"Strict"},"editable":{"type":"boolean","title":"Editable","default":true},"value_type":{"$ref":"#/components/schemas/ValueType"},"internal":{"type":"boolean","title":"Internal"},"depends_on":{"items":{"$ref":"#/components/schemas/DependentOption"},"type":"array","title":"Depends On","default":[]}},"type":"object","required":["description","required","value","suggested_values","strict","value_type","internal"],"title":"CustomOptionSchema"},"ValueType":{"type":"string","enum":["STRING","FLOAT","INTEGER","BOOLEAN","FILE"],"title":"ValueType"},"DependentOption":{"properties":{"name":{"type":"string","title":"Name"},"values":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Values"}},"type":"object","required":["name","values"],"title":"DependentOption"},"BadRequestResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"BadRequestResponse"},"NotFoundResponse":{"properties":{"detail":{"type":"string","title":"Detail"}},"type":"object","required":["detail"],"title":"NotFoundResponse"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://bc-security.gitbook.io/empire-wiki/restful-api/listener-templates.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.