# Audit SSH Settings

## Get Zero Trust SSH settings

`client.zeroTrust.gateway.auditSSHSettings.get(AuditSSHSettingGetParamsparams, RequestOptionsoptions?): GatewaySettings`

**get** `/accounts/{account_id}/gateway/audit_ssh_settings`

Retrieve all Zero Trust Audit SSH and SSH with Access for Infrastructure settings for an account.

### Parameters

- `params: AuditSSHSettingGetParams`

  - `account_id: string`

### Returns

- `GatewaySettings`

  - `created_at?: string`

  - `public_key?: string`

    Provide the Base64-encoded HPKE public key that encrypts SSH session logs. See https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access/#enable-ssh-command-logging.

  - `seed_id?: string`

    Identify the seed ID.

  - `updated_at?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const gatewaySettings = await client.zeroTrust.gateway.auditSSHSettings.get({
  account_id: '699d98642c564d2e855e9661899b7252',
});

console.log(gatewaySettings.seed_id);
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "public_key": "1pyl6I1tL7xfJuFYVzXlUW8uXXlpxegHXBzGCBKaSFA=",
    "seed_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  }
}
```

## Update Zero Trust SSH settings

`client.zeroTrust.gateway.auditSSHSettings.update(AuditSSHSettingUpdateParamsparams, RequestOptionsoptions?): GatewaySettings`

**put** `/accounts/{account_id}/gateway/audit_ssh_settings`

Update Zero Trust Audit SSH and SSH with Access for Infrastructure settings for an account.

### Parameters

- `params: AuditSSHSettingUpdateParams`

  - `account_id: string`

    Path param

  - `public_key: string`

    Body param: Provide the Base64-encoded HPKE public key that encrypts SSH session logs. See https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access/#enable-ssh-command-logging.

### Returns

- `GatewaySettings`

  - `created_at?: string`

  - `public_key?: string`

    Provide the Base64-encoded HPKE public key that encrypts SSH session logs. See https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access/#enable-ssh-command-logging.

  - `seed_id?: string`

    Identify the seed ID.

  - `updated_at?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const gatewaySettings = await client.zeroTrust.gateway.auditSSHSettings.update({
  account_id: '699d98642c564d2e855e9661899b7252',
  public_key: '1pyl6I1tL7xfJuFYVzXlUW8uXXlpxegHXBzGCBKaSFA=',
});

console.log(gatewaySettings.seed_id);
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "public_key": "1pyl6I1tL7xfJuFYVzXlUW8uXXlpxegHXBzGCBKaSFA=",
    "seed_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  }
}
```

## Rotate Zero Trust SSH account seed

`client.zeroTrust.gateway.auditSSHSettings.rotateSeed(AuditSSHSettingRotateSeedParamsparams, RequestOptionsoptions?): GatewaySettings`

**post** `/accounts/{account_id}/gateway/audit_ssh_settings/rotate_seed`

Rotate the SSH account seed that generates the host key identity when connecting through the Cloudflare SSH Proxy.

### Parameters

- `params: AuditSSHSettingRotateSeedParams`

  - `account_id: string`

### Returns

- `GatewaySettings`

  - `created_at?: string`

  - `public_key?: string`

    Provide the Base64-encoded HPKE public key that encrypts SSH session logs. See https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access/#enable-ssh-command-logging.

  - `seed_id?: string`

    Identify the seed ID.

  - `updated_at?: string`

### Example

```node
import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

const gatewaySettings = await client.zeroTrust.gateway.auditSSHSettings.rotateSeed({
  account_id: '699d98642c564d2e855e9661899b7252',
});

console.log(gatewaySettings.seed_id);
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "created_at": "2014-01-01T05:20:00.12345Z",
    "public_key": "1pyl6I1tL7xfJuFYVzXlUW8uXXlpxegHXBzGCBKaSFA=",
    "seed_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415",
    "updated_at": "2014-01-01T05:20:00.12345Z"
  }
}
```

## Domain Types

### Gateway Settings

- `GatewaySettings`

  - `created_at?: string`

  - `public_key?: string`

    Provide the Base64-encoded HPKE public key that encrypts SSH session logs. See https://developers.cloudflare.com/cloudflare-one/connections/connect-networks/use-cases/ssh/ssh-infrastructure-access/#enable-ssh-command-logging.

  - `seed_id?: string`

    Identify the seed ID.

  - `updated_at?: string`