cloudflare/src/resources/zero-trust/gateway/audit-ssh-settings.ts

The official TypeScript library for the Cloudflare API

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

import { APIResource } from '../../../core/resource';
import { APIPromise } from '../../../core/api-promise';
import { RequestOptions } from '../../../internal/request-options';
import { path } from '../../../internal/utils/path';

export class BaseAuditSSHSettings extends APIResource {
  static override readonly _key: readonly ['zeroTrust', 'gateway', 'auditSSHSettings'] = Object.freeze([
    'zeroTrust',
    'gateway',
    'auditSSHSettings',
  ] as const);

  /**
   * Update Zero Trust Audit SSH and SSH with Access for Infrastructure settings for
   * an account.
   *
   * @example
   * ```ts
   * const gatewaySettings =
   *   await client.zeroTrust.gateway.auditSSHSettings.update({
   *     account_id: '699d98642c564d2e855e9661899b7252',
   *     public_key:
   *       '1pyl6I1tL7xfJuFYVzXlUW8uXXlpxegHXBzGCBKaSFA=',
   *   });
   * ```
   */
  update(params: AuditSSHSettingUpdateParams, options?: RequestOptions): APIPromise<GatewaySettings> {
    const { account_id, ...body } = params;
    return (
      this._client.put(path`/accounts/${account_id}/gateway/audit_ssh_settings`, {
        body,
        ...options,
      }) as APIPromise<{ result: GatewaySettings }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Retrieve all Zero Trust Audit SSH and SSH with Access for Infrastructure
   * settings for an account.
   *
   * @example
   * ```ts
   * const gatewaySettings =
   *   await client.zeroTrust.gateway.auditSSHSettings.get({
   *     account_id: '699d98642c564d2e855e9661899b7252',
   *   });
   * ```
   */
  get(params: AuditSSHSettingGetParams, options?: RequestOptions): APIPromise<GatewaySettings> {
    const { account_id } = params;
    return (
      this._client.get(path`/accounts/${account_id}/gateway/audit_ssh_settings`, options) as APIPromise<{
        result: GatewaySettings;
      }>
    )._thenUnwrap((obj) => obj.result);
  }

  /**
   * Rotate the SSH account seed that generates the host key identity when connecting
   * through the Cloudflare SSH Proxy.
   *
   * @example
   * ```ts
   * const gatewaySettings =
   *   await client.zeroTrust.gateway.auditSSHSettings.rotateSeed(
   *     { account_id: '699d98642c564d2e855e9661899b7252' },
   *   );
   * ```
   */
  rotateSeed(params: AuditSSHSettingRotateSeedParams, options?: RequestOptions): APIPromise<GatewaySettings> {
    const { account_id } = params;
    return (
      this._client.post(
        path`/accounts/${account_id}/gateway/audit_ssh_settings/rotate_seed`,
        options,
      ) as APIPromise<{ result: GatewaySettings }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class AuditSSHSettings extends BaseAuditSSHSettings {}

export interface GatewaySettings {
  created_at?: 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.
   */
  public_key?: string;

  /**
   * Identify the seed ID.
   */
  seed_id?: string;

  updated_at?: string;
}

export interface AuditSSHSettingUpdateParams {
  /**
   * Path param: Specify the Cloudflare account identifier.
   */
  account_id: 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.
   */
  public_key: string;
}

export interface AuditSSHSettingGetParams {
  /**
   * Specify the Cloudflare account identifier.
   */
  account_id: string;
}

export interface AuditSSHSettingRotateSeedParams {
  /**
   * Specify the Cloudflare account identifier.
   */
  account_id: string;
}

export declare namespace AuditSSHSettings {
  export {
    type GatewaySettings as GatewaySettings,
    type AuditSSHSettingUpdateParams as AuditSSHSettingUpdateParams,
    type AuditSSHSettingGetParams as AuditSSHSettingGetParams,
    type AuditSSHSettingRotateSeedParams as AuditSSHSettingRotateSeedParams,
  };
}