> 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/secure-remote-support.md).

# Secure remote support

Settings for the secure remote support connection that lets Silk Support access the system for troubleshooting and upgrades. You control when the connection is enabled and how long it remains available.

Use this endpoint to check the connection's status and time remaining, enable or disable it, route it through a proxy, set its timeout, or regenerate its keys.

## GET /proxy\_secure\_ssh

> Get secure remote support settings

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Secure remote support","description":"Settings for the secure remote support connection that lets Silk Support access the system for troubleshooting and upgrades. You control when the connection is enabled and how long it remains available.\n\nUse this endpoint to check the connection's status and time remaining, enable or disable it, route it through a proxy, set its timeout, or regenerate its keys."}],"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."}}},"ProxySecureSsh":{"type":"object","properties":{"auto_enable":{"type":"boolean","description":"Whether the proxy auto-enables."},"https_port":{"type":"integer","nullable":true,"description":"HTTPS port exposed by the proxy."},"id":{"type":"integer","description":"Unique identifier."},"ip_address":{"type":"string","description":"Proxy IP address."},"pmc_comments":{"type":"string","nullable":true,"description":"Free-form notes for the PMC tunnel."},"pmc_ssh_port":{"type":"integer","nullable":true,"description":"SSH port mapped to the PMC."},"smc_comments":{"type":"string","nullable":true,"description":"Free-form notes for the SMC tunnel."},"smc_ssh_port":{"type":"integer","nullable":true,"description":"SSH port mapped to the SMC."},"status":{"type":"string","description":"Tunnel status, e.g. `Disabled`."},"time_remaining":{"type":"integer","nullable":true,"description":"Seconds remaining until the tunnel auto-disables."}}},"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":{"/proxy_secure_ssh":{"get":{"tags":["Secure remote support"],"summary":"Get secure remote support settings","operationId":"listProxySecureSsh","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/ProxySecureSsh"}}}}]}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## GET /proxy\_secure\_ssh/{id}

> Get secure remote support settings by ID

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Secure remote support","description":"Settings for the secure remote support connection that lets Silk Support access the system for troubleshooting and upgrades. You control when the connection is enabled and how long it remains available.\n\nUse this endpoint to check the connection's status and time remaining, enable or disable it, route it through a proxy, set its timeout, or regenerate its keys."}],"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":{"ProxySecureSsh":{"type":"object","properties":{"auto_enable":{"type":"boolean","description":"Whether the proxy auto-enables."},"https_port":{"type":"integer","nullable":true,"description":"HTTPS port exposed by the proxy."},"id":{"type":"integer","description":"Unique identifier."},"ip_address":{"type":"string","description":"Proxy IP address."},"pmc_comments":{"type":"string","nullable":true,"description":"Free-form notes for the PMC tunnel."},"pmc_ssh_port":{"type":"integer","nullable":true,"description":"SSH port mapped to the PMC."},"smc_comments":{"type":"string","nullable":true,"description":"Free-form notes for the SMC tunnel."},"smc_ssh_port":{"type":"integer","nullable":true,"description":"SSH port mapped to the SMC."},"status":{"type":"string","description":"Tunnel status, e.g. `Disabled`."},"time_remaining":{"type":"integer","nullable":true,"description":"Seconds remaining until the tunnel auto-disables."}}},"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":{"/proxy_secure_ssh/{id}":{"get":{"tags":["Secure remote support"],"summary":"Get secure remote support settings by ID","operationId":"getProxySecureSsh","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxySecureSsh"}}}},"default":{"$ref":"#/components/responses/Error"}}}}}}
```

## Update secure remote support

> Send either \`proxy\_ip\_address\` or \`proxy\_status\`, optionally with \`connection\_timeout\` or \`recreate\_keys\`.

```json
{"openapi":"3.0.3","info":{"title":"Silk RESTful API","version":"9.5.20"},"tags":[{"name":"Secure remote support","description":"Settings for the secure remote support connection that lets Silk Support access the system for troubleshooting and upgrades. You control when the connection is enabled and how long it remains available.\n\nUse this endpoint to check the connection's status and time remaining, enable or disable it, route it through a proxy, set its timeout, or regenerate its keys."}],"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":{"ProxySecureSsh":{"type":"object","properties":{"auto_enable":{"type":"boolean","description":"Whether the proxy auto-enables."},"https_port":{"type":"integer","nullable":true,"description":"HTTPS port exposed by the proxy."},"id":{"type":"integer","description":"Unique identifier."},"ip_address":{"type":"string","description":"Proxy IP address."},"pmc_comments":{"type":"string","nullable":true,"description":"Free-form notes for the PMC tunnel."},"pmc_ssh_port":{"type":"integer","nullable":true,"description":"SSH port mapped to the PMC."},"smc_comments":{"type":"string","nullable":true,"description":"Free-form notes for the SMC tunnel."},"smc_ssh_port":{"type":"integer","nullable":true,"description":"SSH port mapped to the SMC."},"status":{"type":"string","description":"Tunnel status, e.g. `Disabled`."},"time_remaining":{"type":"integer","nullable":true,"description":"Seconds remaining until the tunnel auto-disables."}}},"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":{"/proxy_secure_ssh/{id}":{"patch":{"tags":["Secure remote support"],"summary":"Update secure remote support","operationId":"updateProxySecureSsh","description":"Send either `proxy_ip_address` or `proxy_status`, optionally with `connection_timeout` or `recreate_keys`.","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"Update secure remote support","properties":{"proxy_ip_address":{"type":"string","description":"IP address of the proxy."},"proxy_status":{"type":"string","description":"Desired tunnel status."},"connection_timeout":{"type":"integer","description":"Connection timeout."},"recreate_keys":{"type":"boolean","description":"When `true`, regenerate proxy keys."}}}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProxySecureSsh"}}}},"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/secure-remote-support.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.
