cloudflare/src/resources/zero-trust/networks/routes/ips.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 * as RoutesAPI from './routes';
import { APIPromise } from '../../../../core/api-promise';
import { RequestOptions } from '../../../../internal/request-options';
import { path } from '../../../../internal/utils/path';

export class BaseIPs extends APIResource {
  static override readonly _key: readonly ['zeroTrust', 'networks', 'routes', 'ips'] = Object.freeze([
    'zeroTrust',
    'networks',
    'routes',
    'ips',
  ] as const);

  /**
   * Fetches routes that contain the given IP address.
   *
   * @example
   * ```ts
   * const teamnet =
   *   await client.zeroTrust.networks.routes.ips.get(
   *     '10.1.0.137',
   *     { account_id: '699d98642c564d2e855e9661899b7252' },
   *   );
   * ```
   */
  get(ip: string, params: IPGetParams, options?: RequestOptions): APIPromise<RoutesAPI.Teamnet> {
    const { account_id, ...query } = params;
    return (
      this._client.get(path`/accounts/${account_id}/teamnet/routes/ip/${ip}`, {
        query,
        ...options,
      }) as APIPromise<{ result: RoutesAPI.Teamnet }>
    )._thenUnwrap((obj) => obj.result);
  }
}
export class IPs extends BaseIPs {}

export interface IPGetParams {
  /**
   * Path param: Cloudflare account ID
   */
  account_id: string;

  /**
   * Query param: When the virtual_network_id parameter is not provided the request
   * filter will default search routes that are in the default virtual network for
   * the account. If this parameter is set to false, the search will include routes
   * that do not have a virtual network.
   */
  default_virtual_network_fallback?: boolean;

  /**
   * Query param: UUID of the virtual network.
   */
  virtual_network_id?: string;
}

export declare namespace IPs {
  export { type IPGetParams as IPGetParams };
}