﻿# Ssh Known Hosts

## Get a list of SSH Known Hosts

:endpoint{method="GET" path="/api/sshknownhosts"}

**Query Parameters**

- **`partialHost`** :span[string]{.type-label}  
  Filters known hosts matching any part of the `host` fragment.
- **`skip`** :span[integer]{.type-label}  
  Number of items to skip. Defaults to zero. Minimum `0`.
- **`take`** :span[integer]{.type-label}  
  Number of items to take. Defaults to 30. Minimum `0`.

**Response**

`200` — Contains a list of SSH Known Hosts

- **`FilteredCount`** :span[integer]{.type-label}
- **`Resources`** :span[array of object]{.type-label}
  - **`Host`** :span[string]{.type-label}
  - **`Id`** :span[string]{.type-label}
  - **`KeyType`** :span[string]{.type-label}
  - **`PublicKey`** :span[string]{.type-label}
- **`TotalCount`** :span[integer]{.type-label}

:::api-example{label="Response"}
```json
{
  "FilteredCount": 0,
  "Resources": [
    {
      "Host": "string",
      "Id": "SshKnownHosts-1",
      "KeyType": "string",
      "PublicKey": "string"
    }
  ],
  "TotalCount": 0
}
```
:::

## Add new SSH Known Hosts from a list of entries

:endpoint{method="POST" path="/api/sshknownhosts"}

**Request Body**

- **`KnownHostEntries`** :span[array of string]{.type-label} *(required)*

:::api-example{label="Request"}
```json
{
  "KnownHostEntries": [
    "string"
  ]
}
```
:::

**Response**

`200` — Contains a list of added SSH Known Hosts

- **`AddedResources`** :span[array of object]{.type-label}
  - **`Host`** :span[string]{.type-label}
  - **`Id`** :span[string]{.type-label}
  - **`KeyType`** :span[string]{.type-label}
  - **`PublicKey`** :span[string]{.type-label}

:::api-example{label="Response"}
```json
{
  "AddedResources": [
    {
      "Host": "string",
      "Id": "SshKnownHosts-1",
      "KeyType": "string",
      "PublicKey": "string"
    }
  ]
}
```
:::

## Delete the specific SSH Known Host

:endpoint{method="DELETE" path="/api/sshknownhosts/\{id\}"}

**Path Parameters**

- **`id`** :span[string]{.type-label} *(required)*

**Response**

`200` — An empty response

:::api-example{label="Response"}
```json
{}
```
:::
