---
updatedAt: 2026-06-16T13:14:01.000Z
---

# Retrieve the configuration for a Site Collector agent by template ID

Retrieve the log collection attributes and configuration values of a template with a given template ID.

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Site Collectors",
    "description": "API for Site Collectors and Collectors management",
    "version": "v1"
  },
  "servers": [
    {
      "url": "https://api.us-west.exabeam.cloud"
    },
    {
      "url": "https://api.us-east.exabeam.cloud"
    },
    {
      "url": "https://api.sg.exabeam.cloud"
    },
    {
      "url": "https://api.jp.exabeam.cloud"
    },
    {
      "url": "https://api.eu.exabeam.cloud"
    },
    {
      "url": "https://api.au.exabeam.cloud"
    },
    {
      "url": "https://api.ca.exabeam.cloud"
    },
    {
      "url": "https://api.ch.exabeam.cloud"
    },
    {
      "url": "https://api.sa.exabeam.cloud"
    },
    {
      "url": "https://api.uk.exabeam.cloud"
    }
  ],
  "security": [
    {
      "oAuth2ClientCredentials": []
    }
  ],
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true,
    "samples-languages": [
      "python",
      "powershell",
      "curl",
      "go",
      "javascript",
      "java",
      "cplusplus",
      "csharp",
      "node",
      "node-simple"
    ]
  },
  "paths": {
    "/site-collectors/v1/templates/{templateId}": {
      "get": {
        "tags": [
          "Templates"
        ],
        "summary": "Retrieve the configuration for a Site Collector agent by template ID",
        "description": "Retrieve the log collection attributes and configuration values of a template with a given template ID.",
        "operationId": "site-collector-template-get-details",
        "parameters": [
          {
            "name": "templateId",
            "description": "Site Collector template ID. This ID is returned when you [Create a new Site Collector template](site-collector-template-create).",
            "in": "path",
            "required": true,
            "schema": {
              "type": "string",
              "format": "uuid"
            },
            "example": "030cee78-c95a-4121-8fd3-867a40e8e3b8"
          }
        ],
        "responses": {
          "200": {
            "description": "Success",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/TemplateExternalResponse"
                },
                "examples": {
                  "ArchiveLinux Template response": {
                    "description": "ArchiveLinux Template response",
                    "value": {
                      "id": "1093e9c7-c63a-4827-855b-f7bfcea8af88",
                      "name": "My ArchiveLinux Template",
                      "type": "ArchiveLinux",
                      "settings": {
                        "includePaths": [
                          "/home/exabeam/ngsc_qa/gz_files/*.gz",
                          "/home/exabeam/ngsc_qa/zip_files/*.zip",
                          "/home/exabeam/ngsc_qa/tar_files/*.tar"
                        ],
                        "excludePaths": [
                          "/home/exabeam/ngsc_qa/*.csv",
                          "/home/exabeam/ngsc_qa/*.log",
                          "/home/exabeam/ngsc_qa/*.txt"
                        ]
                      },
                      "collectorsCount": 0,
                      "createdDate": "2023-07-09T09:53:57Z",
                      "modifiedDate": "2023-07-09T09:53:57Z"
                    }
                  },
                  "ArchiveWindows Template response": {
                    "description": "ArchiveWindows Template response",
                    "value": {
                      "id": "0b2c4c7b-a321-41de-ace6-c1390cec1399",
                      "name": "New ArchiveWindows Template",
                      "type": "ArchiveWindows",
                      "settings": {
                        "includePaths": [
                          "C:\\Users\\exabeam\\*.tar"
                        ]
                      },
                      "collectorsCount": 0,
                      "createdDate": "2024-03-14T07:53:55Z",
                      "modifiedDate": "2024-03-14T07:53:55Z"
                    }
                  },
                  "FileLinux Template response": {
                    "description": "FileLinux Template response",
                    "value": {
                      "id": "f1a0eff7-fe85-4769-b77e-f9404057c8a0",
                      "name": "My FileLinux Template",
                      "type": "FileLinux",
                      "settings": {
                        "includePaths": [
                          "/home/exabeam/*.txt",
                          "/home/exabeam/*.log",
                          "/home/exabeam/*.csv"
                        ],
                        "excludePaths": [
                          "/home/exabeam/*.exe",
                          "/home/exabeam/*.jar",
                          "/home/exabeam/*.zip"
                        ]
                      },
                      "collectorsCount": 0,
                      "createdDate": "2024-06-06T09:56:52Z",
                      "modifiedDate": "2024-06-06T09:56:52Z"
                    }
                  },
                  "FileWindows Template response": {
                    "description": "FileWindows Template response",
                    "value": {
                      "id": "6f709bac-9909-45be-a557-9745ea1a02bc",
                      "name": "My FileWindows Template",
                      "type": "FileWindows",
                      "settings": {
                        "includePaths": [
                          "C:\\users\\exabeam\\ngsc_qa\\csv_files\\*.csv",
                          "C:\\users\\exabeam\\ngsc_qa\\log_files\\*.log",
                          "C:\\users\\exabeam\\ngsc_qa\\txt_files\\*.txt"
                        ],
                        "excludePaths": [
                          "C:\\users\\exabeam\\ngsc_qa\\gz_files\\*.gz",
                          "C:\\users\\exabeam\\ngsc_qa\\tar_files\\*.tar",
                          "C:\\users\\exabeam\\ngsc_qa\\zip_files\\*.zip"
                        ]
                      },
                      "collectorsCount": 0,
                      "createdDate": "2023-07-09T09:55:00Z",
                      "modifiedDate": "2023-07-09T09:55:00Z"
                    }
                  },
                  "Windows Template response": {
                    "description": "Windows Template response",
                    "value": {
                      "id": "068839d5-b439-414a-ae9f-91807864f04f",
                      "name": "Application-All",
                      "type": "Windows",
                      "settings": {
                        "categories": [
                          {
                            "name": "Application",
                            "consumeRange": "all"
                          }
                        ],
                        "messageFormat": "Both",
                        "inactivePolicy": "24h"
                      },
                      "collectorsCount": 0,
                      "createdDate": "2024-03-06T14:25:14Z",
                      "modifiedDate": "2024-03-06T14:25:14Z"
                    }
                  },
                  "DaaWindows Template response": {
                    "description": "DaaWindows Template response",
                    "value": {
                      "id": "2b3c4d5e-6f70-8901-bcde-f12345678901",
                      "name": "My DaaWindows Template",
                      "type": "DaaWindows",
                      "settings": {
                        "categories": [
                          {
                            "name": "Application",
                            "consumeRange": "all"
                          }
                        ],
                        "messageFormat": "Both",
                        "inactivePolicy": "24h"
                      },
                      "collectorsCount": 0,
                      "createdDate": "2024-06-05T10:41:31Z",
                      "modifiedDate": "2024-06-05T10:41:31Z"
                    }
                  }
                }
              }
            }
          },
          "400": {
            "$ref": "#/components/responses/400"
          },
          "401": {
            "$ref": "#/components/responses/401"
          },
          "403": {
            "$ref": "#/components/responses/403"
          },
          "404": {
            "$ref": "#/components/responses/404"
          },
          "406": {
            "$ref": "#/components/responses/406"
          },
          "500": {
            "$ref": "#/components/responses/500"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "TemplateCollectorsType": {
        "description": "Type of Site Collector agent for which the template applies.",
        "enum": [
          "ArchiveLinux",
          "ArchiveWindows",
          "FileLinux",
          "FileWindows",
          "Windows"
        ],
        "type": "string"
      },
      "TemplateExternalResponse": {
        "properties": {
          "id": {
            "description": "Template ID.",
            "type": "string"
          },
          "name": {
            "description": "Name of the template.",
            "type": "string"
          },
          "type": {
            "oneOf": [
              {
                "$ref": "#/components/schemas/TemplateCollectorsType"
              },
              {
                "$ref": "#/components/schemas/TemplateDaaCollectorsType"
              }
            ]
          },
          "collectorsCount": {
            "description": "Number of collectors to which the template applies.",
            "format": "int32",
            "type": "integer"
          },
          "createdDate": {
            "description": "Date at which the template was created (ISO-8601 format).",
            "type": "string",
            "format": "date-time"
          },
          "modifiedDate": {
            "description": "Date at which the template was modified (ISO-8601 format).",
            "type": "string",
            "format": "date-time"
          },
          "settings": {
            "$ref": "#/components/schemas/TemplateExternalSettings"
          }
        }
      },
      "TemplateExternalSettings": {
        "type": "object",
        "description": "A set of attributes to configure for the template. Note that some attributes are relevant only for certain Collector types."
      },
      "TemplateDaaCollectorsType": {
        "description": "Type of Direct Access Agent (DAA) collector.",
        "enum": [
          "DaaWindows"
        ],
        "type": "string"
      },
      "NgscError": {
        "type": "object",
        "properties": {
          "code": {
            "type": "string",
            "description": "Error code"
          },
          "message": {
            "type": "string",
            "description": "Error message"
          },
          "messageParams": {
            "type": "object",
            "description": "Error message parameters",
            "additionalProperties": {
              "type": "object"
            }
          },
          "fields": {
            "type": "array",
            "description": "Error message fields",
            "items": {
              "type": "object"
            }
          }
        }
      },
      "NgscHttpError": {
        "type": "object",
        "properties": {
          "traceId": {
            "type": "string"
          },
          "errors": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/NgscError"
            }
          }
        }
      }
    },
    "securitySchemes": {
      "oAuth2ClientCredentials": {
        "type": "oauth2",
        "description": "Manage your Site Collector instances.",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "auth/v1/token",
            "scopes": {}
          }
        }
      }
    },
    "responses": {
      "400": {
        "description": "Bad Request",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/NgscHttpError"
            }
          }
        }
      },
      "401": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/NgscHttpError"
            }
          }
        }
      },
      "403": {
        "description": "Permission Denied",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/NgscHttpError"
            }
          }
        }
      },
      "404": {
        "description": "Not Found",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/NgscHttpError"
            }
          }
        }
      },
      "406": {
        "description": "Not Acceptable",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/NgscHttpError"
            }
          }
        }
      },
      "500": {
        "description": "Internal Server Error",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/NgscHttpError"
            }
          }
        }
      }
    }
  }
}
```