> For the complete documentation index, see [llms.txt](https://docs.silk.us/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.silk.us/api-reference/endpoints/system-configuration/syslog-servers.md).

# Syslog servers

External syslog servers that receive the system's log messages and, optionally, its audit records.

Use these endpoints to forward logs to your logging or security monitoring tools.

## GET /system/syslog\_servers

> List syslog servers

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Syslog servers","description":"External syslog servers that receive the system's log messages and, optionally, its audit records.\n\nUse these endpoints to forward logs to your logging or security monitoring tools."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"parameters":{"limit":{"name":"__limit","in":"query","schema":{"type":"integer"},"description":"Caps the number of returned entities. Requires a sort parameter when paging."},"offset":{"name":"__offset","in":"query","schema":{"type":"integer"},"description":"Returns results starting from this offset. Requires a sort parameter when paging."},"sort":{"name":"__sort","in":"query","schema":{"type":"string"},"description":"Comma-separated object properties to sort by."},"sort_order":{"name":"__sort_order","in":"query","schema":{"type":"string","enum":["asc","desc"]},"description":"Sort direction."}},"schemas":{"Collection":{"type":"object","properties":{"hits":{"type":"array","items":{},"description":"The matching objects."},"limit":{"type":"integer","description":"Page size."},"offset":{"type":"integer","description":"Offset of the first returned object."},"total":{"type":"integer","description":"Total number of matching objects."}}},"SystemSyslogServers":{"type":"object","properties":{"address":{"type":"string","description":"Syslog server address (IP or hostname)."},"id":{"type":"integer","description":"Unique identifier."},"is_connected":{"type":"boolean","description":"`true` when the SDP currently has connectivity to the syslog server."},"port":{"type":"integer","description":"Destination port (commonly `514`)."},"report_audit":{"type":"boolean","description":"`true` to forward audit events."},"type":{"type":"string","description":"Syslog format/type, e.g. `standard`."},"use_tcp":{"type":"boolean","description":"`true` to use TCP transport; `false` for UDP."}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/syslog_servers":{"get":{"tags":["Syslog servers"],"summary":"List syslog servers","operationId":"listSystemSyslogServers","parameters":[{"$ref":"#/components/parameters/limit"},{"$ref":"#/components/parameters/offset"},{"$ref":"#/components/parameters/sort"},{"$ref":"#/components/parameters/sort_order"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/Collection"},{"type":"object","properties":{"hits":{"type":"array","items":{"$ref":"#/components/schemas/SystemSyslogServers"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## POST /system/syslog\_servers

> Add syslog server

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Syslog servers","description":"External syslog servers that receive the system's log messages and, optionally, its audit records.\n\nUse these endpoints to forward logs to your logging or security monitoring tools."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"SystemSyslogServers":{"type":"object","properties":{"address":{"type":"string","description":"Syslog server address (IP or hostname)."},"id":{"type":"integer","description":"Unique identifier."},"is_connected":{"type":"boolean","description":"`true` when the SDP currently has connectivity to the syslog server."},"port":{"type":"integer","description":"Destination port (commonly `514`)."},"report_audit":{"type":"boolean","description":"`true` to forward audit events."},"type":{"type":"string","description":"Syslog format/type, e.g. `standard`."},"use_tcp":{"type":"boolean","description":"`true` to use TCP transport; `false` for UDP."}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/syslog_servers":{"post":{"tags":["Syslog servers"],"summary":"Add syslog server","operationId":"createSystemSyslogServers","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemSyslogServers"}}}},"default":{"$ref":"#/components/responses/Error"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Add syslog server","properties":{"address":{"$ref":"#/components/schemas/SystemSyslogServers/properties/address"},"type":{"$ref":"#/components/schemas/SystemSyslogServers/properties/type"},"port":{"$ref":"#/components/schemas/SystemSyslogServers/properties/port"},"use_tcp":{"$ref":"#/components/schemas/SystemSyslogServers/properties/use_tcp"},"report_audit":{"$ref":"#/components/schemas/SystemSyslogServers/properties/report_audit"}},"required":["address"]}}}}}}}}
```

## GET /system/syslog\_servers/{id}

> Get a syslog server

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Syslog servers","description":"External syslog servers that receive the system's log messages and, optionally, its audit records.\n\nUse these endpoints to forward logs to your logging or security monitoring tools."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"SystemSyslogServers":{"type":"object","properties":{"address":{"type":"string","description":"Syslog server address (IP or hostname)."},"id":{"type":"integer","description":"Unique identifier."},"is_connected":{"type":"boolean","description":"`true` when the SDP currently has connectivity to the syslog server."},"port":{"type":"integer","description":"Destination port (commonly `514`)."},"report_audit":{"type":"boolean","description":"`true` to forward audit events."},"type":{"type":"string","description":"Syslog format/type, e.g. `standard`."},"use_tcp":{"type":"boolean","description":"`true` to use TCP transport; `false` for UDP."}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/syslog_servers/{id}":{"get":{"tags":["Syslog servers"],"summary":"Get a syslog server","operationId":"getSystemSyslogServers","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemSyslogServers"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## DELETE /system/syslog\_servers/{id}

> Delete a syslog server

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Syslog servers","description":"External syslog servers that receive the system's log messages and, optionally, its audit records.\n\nUse these endpoints to forward logs to your logging or security monitoring tools."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"schemas":{"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}}},"paths":{"/system/syslog_servers/{id}":{"delete":{"tags":["Syslog servers"],"summary":"Delete a syslog server","operationId":"deleteSystemSyslogServers","responses":{"204":{"description":"No content"},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## PATCH /system/syslog\_servers/{id}

> Update syslog server

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Syslog servers","description":"External syslog servers that receive the system's log messages and, optionally, its audit records.\n\nUse these endpoints to forward logs to your logging or security monitoring tools."}],"servers":[{"url":"https://{host-address}/api/v2","description":"Your Silk Data Pod (SDP)","variables":{"host-address":{"default":"sdp.example.com","description":"Management address of your SDP."}}}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"HTTP Basic authentication. The server responds only to HTTPS requests. Access to object URLs, operations, and fields depends on the user's role (for example `admin` or `viewer`)."}},"schemas":{"SystemSyslogServers":{"type":"object","properties":{"address":{"type":"string","description":"Syslog server address (IP or hostname)."},"id":{"type":"integer","description":"Unique identifier."},"is_connected":{"type":"boolean","description":"`true` when the SDP currently has connectivity to the syslog server."},"port":{"type":"integer","description":"Destination port (commonly `514`)."},"report_audit":{"type":"boolean","description":"`true` to forward audit events."},"type":{"type":"string","description":"Syslog format/type, e.g. `standard`."},"use_tcp":{"type":"boolean","description":"`true` to use TCP transport; `false` for UDP."}}},"Error":{"type":"object","properties":{"message":{"type":"string","description":"Readable description of the error."}}}},"responses":{"Error":{"description":"Error. See the **Errors** page for status codes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}},"paths":{"/system/syslog_servers/{id}":{"patch":{"tags":["Syslog servers"],"summary":"Update syslog server","operationId":"updateSystemSyslogServers","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Update syslog server","properties":{"address":{"$ref":"#/components/schemas/SystemSyslogServers/properties/address"},"type":{"$ref":"#/components/schemas/SystemSyslogServers/properties/type"},"port":{"$ref":"#/components/schemas/SystemSyslogServers/properties/port"},"use_tcp":{"$ref":"#/components/schemas/SystemSyslogServers/properties/use_tcp"},"report_audit":{"$ref":"#/components/schemas/SystemSyslogServers/properties/report_audit"}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemSyslogServers"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

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

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.silk.us/api-reference/endpoints/system-configuration/syslog-servers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
