> 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/software-states.md).

# Software states

The system's software states, including the status and severity of HTTPS and SMTP connectivity. Severity is `ok`, `medium`, or `high`, and status is `ok`, `warning`, or `error`.

Use this endpoint to check the health of the system's outbound connections.

## GET /system/software\_states

> List software states

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Software states","description":"The system's software states, including the status and severity of HTTPS and SMTP connectivity. Severity is `ok`, `medium`, or `high`, and status is `ok`, `warning`, or `error`.\n\nUse this endpoint to check the health of the system's outbound connections."}],"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."}}},"SystemSoftwareStates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"is_valid":{"type":"boolean"},"name":{"type":"string","description":"Subsystem or indicator name, e.g. `SMTP connectivity`."},"severity":{"type":"string","description":"Severity, e.g. `ok`, `warning`, `error`."},"status":{"type":"string","description":"Current status, e.g. `ok`."},"status_msg":{"type":"string","description":"Free-form status message; empty when nothing to report."}}},"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/software_states":{"get":{"tags":["Software states"],"summary":"List software states","operationId":"listSystemSoftwareStates","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/SystemSoftwareStates"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## GET /system/software\_states/{id}

> Get a software state

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Software states","description":"The system's software states, including the status and severity of HTTPS and SMTP connectivity. Severity is `ok`, `medium`, or `high`, and status is `ok`, `warning`, or `error`.\n\nUse this endpoint to check the health of the system's outbound connections."}],"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":{"SystemSoftwareStates":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier."},"is_valid":{"type":"boolean"},"name":{"type":"string","description":"Subsystem or indicator name, e.g. `SMTP connectivity`."},"severity":{"type":"string","description":"Severity, e.g. `ok`, `warning`, `error`."},"status":{"type":"string","description":"Current status, e.g. `ok`."},"status_msg":{"type":"string","description":"Free-form status message; empty when nothing to report."}}},"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/software_states/{id}":{"get":{"tags":["Software states"],"summary":"Get a software state","operationId":"getSystemSoftwareStates","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemSoftwareStates"}}}},"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/software-states.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.
