Termius

https://docs.termius.com/
Admin
Termius is a modern SSH client designed for productivity and team collaboration with encrypted cloud...
Tokens:32,846
Snippets:521
Trust Score:9.9
Update:2 months ago
Show doc for...
Tokens:
Raw
### GET /getting-started/glossary.md

Source: https://docs.termius.com/getting-started/glossary.md

Queries the documentation for information by providing a specific question and an optional goal.

```APIDOC
## GET /getting-started/glossary.md

### Description
Queries the documentation dynamically by asking a question. The response provides a direct answer along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://docs.termius.com/getting-started/glossary.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.termius.com/getting-started/download-termius.md

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve dynamic answers.

```http
GET https://docs.termius.com/getting-started/download-termius.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /getting-started.md

Source: https://docs.termius.com/getting-started

Performs a natural language query against the documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET /getting-started.md

### Description
Performs an HTTP GET request on the documentation page to query information using natural language. This allows agents to retrieve specific answers and relevant documentation excerpts.

### Method
GET

### Endpoint
https://docs.termius.com/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.termius.com/help-center/faq/how-can-i-keep-termius-sessions-alive-in-the-background-on-ios-ipados.md

Use an HTTP GET request to query the documentation dynamically when information is not explicitly available on the page.

```http
GET https://docs.termius.com/help-center/faq/how-can-i-keep-termius-sessions-alive-in-the-background-on-ios-ipados.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /organize-and-connect-to-hosts/managing-files-with-sftp.md

Source: https://docs.termius.com/organize-and-connect-to-hosts/managing-files-with-sftp.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /organize-and-connect-to-hosts/managing-files-with-sftp.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://docs.termius.com/organize-and-connect-to-hosts/managing-files-with-sftp.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Query documentation via HTTP GET

Source: https://docs.termius.com/getting-started/sync-to-mobile.md

Perform an HTTP GET request to the documentation URL to retrieve answers to specific questions using the ask and goal parameters.

```http
GET https://docs.termius.com/getting-started/sync-to-mobile.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.termius.com/keychain/sync-of-keys-and-passwords.md

Perform an HTTP GET request to the documentation URL to retrieve answers to specific questions.

```http
GET https://docs.termius.com/keychain/sync-of-keys-and-passwords.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /organize-and-connect-to-hosts.md

Source: https://docs.termius.com/organize-and-connect-to-hosts

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /organize-and-connect-to-hosts.md

### Description
Queries the documentation dynamically to retrieve answers and relevant excerpts based on a provided question.

### Method
GET

### Endpoint
https://docs.termius.com/organize-and-connect-to-hosts.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /organize-and-connect-to-hosts/connecting-to-a-server.md

Source: https://docs.termius.com/organize-and-connect-to-hosts/connecting-to-a-server.md

Performs a query against the documentation page to retrieve answers to specific questions.

```APIDOC
## GET /organize-and-connect-to-hosts/connecting-to-a-server.md

### Description
Queries the documentation page to retrieve information or clarification regarding the content.

### Method
GET

### Endpoint
https://docs.termius.com/organize-and-connect-to-hosts/connecting-to-a-server.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /getting-started/what-is-termius.md

Source: https://docs.termius.com/help-center

Perform a query against the documentation index to receive a direct answer and relevant excerpts.

```APIDOC
## GET /getting-started/what-is-termius.md

### Description
Perform an HTTP GET request on the documentation index to ask a specific question and optionally provide a broader end goal for tailored results.

### Method
GET

### Endpoint
https://docs.termius.com/getting-started/what-is-termius.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Request Example
GET https://docs.termius.com/getting-started/what-is-termius.md?ask=How+do+I+connect+via+SSH&goal=Manage+servers
```

--------------------------------

### Host Configuration Example

Source: https://docs.termius.com/getting-started/what-is-termius.md

Demonstrates how a single Host entity encapsulates multiple connection protocols and authentication settings.

```abap
Host: db-prod-01 (10.0.1.15) 
|── SSH port 22 key: prod-db-key user: ubuntu 
|── SFTP port 22 key: prod-db-key user: ubuntu 
└── Telnet port 23 user: admin
```

--------------------------------

### GET /help-center/faq/how-can-i-request-a-refund.md

Source: https://docs.termius.com/help-center/faq/how-can-i-request-a-refund.md

Perform a query against the documentation to retrieve information not explicitly covered in the current page.

```APIDOC
## GET /help-center/faq/how-can-i-request-a-refund.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for additional information.

### Method
GET

### Endpoint
https://docs.termius.com/help-center/faq/how-can-i-request-a-refund.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### GET /administration/saml-sso.md

Source: https://docs.termius.com/administration/saml-sso.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /administration/saml-sso.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.termius.com/administration/saml-sso.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /help-center/faq/what-will-happen-when-my-pro-subscription-expires.md

Source: https://docs.termius.com/help-center/faq/what-will-happen-when-my-pro-subscription-expires.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /help-center/faq/what-will-happen-when-my-pro-subscription-expires.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a user question.

### Method
GET

### Endpoint
https://docs.termius.com/help-center/faq/what-will-happen-when-my-pro-subscription-expires.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /organize-and-connect-to-hosts/port-forwarding-and-tunneling.md

Source: https://docs.termius.com/organize-and-connect-to-hosts/port-forwarding-and-tunneling.md

Performs a dynamic query against the documentation page to retrieve answers and relevant excerpts.

```APIDOC
## GET /organize-and-connect-to-hosts/port-forwarding-and-tunneling.md

### Description
Queries the documentation page dynamically to receive an answer to a specific question, optionally providing a broader goal for context.

### Method
GET

### Endpoint
https://docs.termius.com/organize-and-connect-to-hosts/port-forwarding-and-tunneling.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /help-center/troubleshooting/serial-connections-dont-work-on-microsoft-windows-store-builds.md

Source: https://docs.termius.com/help-center/troubleshooting/serial-connections-dont-work-on-microsoft-windows-store-builds.md

Performs a natural language query against the documentation page to retrieve answers and relevant context.

```APIDOC
## GET /help-center/troubleshooting/serial-connections-dont-work-on-microsoft-windows-store-builds.md

### Description
Queries the documentation page dynamically to retrieve an answer to a specific question, optionally tailored to a broader goal.

### Method
GET

### Endpoint
https://docs.termius.com/help-center/troubleshooting/serial-connections-dont-work-on-microsoft-windows-store-builds.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /help-center/faq.md

Source: https://docs.termius.com/help-center/faq

Queries the FAQ documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /help-center/faq.md

### Description
Queries the documentation dynamically by asking a question. This is useful for retrieving information not explicitly present on the page or for clarifying existing content.

### Method
GET

### Endpoint
https://docs.termius.com/help-center/faq.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /organize-and-connect-to-hosts/session-logs.md

Source: https://docs.termius.com/organize-and-connect-to-hosts/session-logs.md

Queries the documentation page for specific information using natural language questions.

```APIDOC
## GET /organize-and-connect-to-hosts/session-logs.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.termius.com/organize-and-connect-to-hosts/session-logs.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /security/encryption-overview.md

Source: https://docs.termius.com/security/encryption-overview.md

Queries the documentation page for specific information using natural language.

```APIDOC
## GET /security/encryption-overview.md

### Description
Queries the documentation dynamically to retrieve answers and relevant excerpts based on a specific question.

### Method
GET

### Endpoint
https://docs.termius.com/security/encryption-overview.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /changelog/desktop.md

Source: https://docs.termius.com/changelog/desktop.md

Queries the documentation for specific information by providing a natural language question and an optional end goal.

```APIDOC
## GET /changelog/desktop.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.termius.com/changelog/desktop.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /terminal/workspaces.md

Source: https://docs.termius.com/terminal/workspaces.md

Queries the documentation dynamically by providing a question and an optional goal to receive a tailored response.

```APIDOC
## GET /terminal/workspaces.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question and an optional end goal.

### Method
GET

### Endpoint
https://docs.termius.com/terminal/workspaces.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /organize-and-connect-to-hosts/groups-and-tags.md

Source: https://docs.termius.com/organize-and-connect-to-hosts/groups-and-tags.md

Queries the documentation page for specific information using a natural language question and an optional goal.

```APIDOC
## GET /organize-and-connect-to-hosts/groups-and-tags.md

### Description
Queries the documentation dynamically by providing a question and an optional goal to receive a direct answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.termius.com/organize-and-connect-to-hosts/groups-and-tags.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /team-collaboration/team-vaults.md

Source: https://docs.termius.com/team-collaboration/team-vaults.md

Perform an HTTP GET request to query the documentation for specific information using natural language questions.

```APIDOC
## GET /team-collaboration/team-vaults.md

### Description
Query the documentation dynamically by providing a specific question and an optional goal to receive a direct answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.termius.com/team-collaboration/team-vaults.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /getting-started/quickstart.md

Source: https://docs.termius.com/getting-started/quickstart.md

Perform a query against the documentation to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /getting-started/quickstart.md

### Description
Queries the documentation dynamically to retrieve an answer and relevant excerpts based on a provided question.

### Method
GET

### Endpoint
https://docs.termius.com/getting-started/quickstart.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /getting-started/import-existing-hosts.md

Source: https://docs.termius.com/getting-started/import-existing-hosts.md

Perform a query against the documentation to retrieve answers and relevant excerpts based on a specific question and optional goal.

```APIDOC
## GET /getting-started/import-existing-hosts.md

### Description
Queries the documentation dynamically to retrieve an answer and relevant sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.termius.com/getting-started/import-existing-hosts.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /keychain.md

Source: https://docs.termius.com/keychain

Queries the documentation for specific information using natural language questions.

```APIDOC
## GET /keychain.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.termius.com/keychain.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /getting-started/what-is-termius.md

Source: https://docs.termius.com/getting-started/what-is-termius.md

Perform a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /getting-started/what-is-termius.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the current page.

### Method
GET

### Endpoint
https://docs.termius.com/getting-started/what-is-termius.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Query documentation dynamically via HTTP

Source: https://docs.termius.com/getting-started/invite-your-team.md

Perform an HTTP GET request to retrieve information from the documentation using the ask and goal parameters.

```http
GET https://docs.termius.com/getting-started/invite-your-team.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /ssh-id-passkeys-for-ssh/setup-and-usage.md

Source: https://docs.termius.com/ssh-id-passkeys-for-ssh/setup-and-usage.md

Queries the documentation page for specific information using natural language questions and optional goal context.

```APIDOC
## GET /ssh-id-passkeys-for-ssh/setup-and-usage.md

### Description
Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.termius.com/ssh-id-passkeys-for-ssh/setup-and-usage.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /terminal.md

Source: https://docs.termius.com/terminal

Performs a natural language query against the documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET /terminal.md

### Description
Queries the documentation dynamically by providing a natural language question and an optional end goal to receive a tailored answer with relevant sources.

### Method
GET

### Endpoint
https://docs.termius.com/terminal.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Mosh Server Configuration Commands

Source: https://docs.termius.com/organize-and-connect-to-hosts/connecting-to-a-server.md

Commands used to start the mosh-server on the host system. Use the custom port range variant if your server requires specific port configurations.

```bash
mosh-server new -s -l LANG=en_US.UTF-8
```

```bash
mosh-server new -s -l LANG=en_US.UTF-8 -p [port from]:[port to]
```

--------------------------------

### GET /terminal/autocomplete-and-shell-integration.md

Source: https://docs.termius.com/terminal/autocomplete-and-shell-integration.md

Perform a query against the documentation to retrieve information not explicitly covered in the current page.

```APIDOC
## GET /terminal/autocomplete-and-shell-integration.md

### Description
Perform an HTTP GET request on the current page URL to ask a question and retrieve relevant documentation excerpts.

### Method
GET

### Endpoint
https://docs.termius.com/terminal/autocomplete-and-shell-integration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### Group Nesting Structure

Source: https://docs.termius.com/getting-started/what-is-termius.md

Example of how Groups can be nested to reflect infrastructure environments like production regions.

```abap
Group: Production
├── Group: AWS EU
│   ├── Host: web-01
│   └── Host: db-01
└── Group: AWS US
    ├── Host: web-02
    └── Host: db-02
```

--------------------------------

### GET /administration/billing-and-plans.md

Source: https://docs.termius.com/administration/billing-and-plans.md

Performs a dynamic query against the documentation page to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /administration/billing-and-plans.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the page.

### Method
GET

### Endpoint
https://docs.termius.com/administration/billing-and-plans.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /help-center/help-center.md

Source: https://docs.termius.com/help-center/help-center.md

Performs a natural language query against the Termius documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET /help-center/help-center.md

### Description
Queries the documentation dynamically by asking a question to retrieve answers and relevant sources.

### Method
GET

### Endpoint
https://docs.termius.com/help-center/help-center.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```
Tokens:
Raw