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 * as Core from "../../../../core";
import { APIResource } from "../../../../resource";
import * as IPsAPI from "./ips";
import * as RoutesAPI from "./routes";

export class IPs extends APIResource {
  /**
   * Fetches routes that contain the given IP address.
   */
  get(
    ip: string,
    params: IPGetParams,
    options?: Core.RequestOptions,
  ): Core.APIPromise<RoutesAPI.TunnelTeamnet> {
    const { account_id, ...query } = params;
    return (
      this._client.get(`/accounts/${account_id}/teamnet/routes/ip/${ip}`, {
        query,
        ...options,
      }) as Core.APIPromise<{ result: RoutesAPI.TunnelTeamnet }>
    )._thenUnwrap((obj) => obj.result);
  }
}

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

  /**
   * Query param: UUID of the Tunnel Virtual Network this route belongs to. If no
   * virtual networks are configured, the route is assigned to the default virtual
   * network of the account.
   */
  virtual_network_id?: unknown;
}

export namespace IPs {
  export import IPGetParams = IPsAPI.IPGetParams;
}