Function getEventList

getEventList(
    tunnel_uuid: string,
    options?: {
        payload?: undefined;
        query?: {
            code_name?: string | null;
            is_error?: boolean | null;
            "page[limit]"?: number;
            "page[marker]"?: string | null;
        };
    } & BaseServiceMethodOptions,
    sdkOptions?: SDKOptions,
): Promise<
    JSONFetchResponse<
        {
            data: {
                attributes: {
                    code: string;
                    description: string;
                    details: string;
                    is_error: boolean;
                    time: string;
                };
                id: number;
                relationships?: null;
                type: "TunnelEvent";
            }[];
            links?: { next?: string | { href: string } | null }
            | null;
            meta: { request_id: string };
        },
    >,
>
Get all events for a given tunnel.
Parameters
- tunnel_uuid: string
- Optionaloptions: {
      payload?: undefined;
      query?: {
          code_name?: string | null;
          is_error?: boolean | null;
          "page[limit]"?: number;
          "page[marker]"?: string | null;
      };
  } & BaseServiceMethodOptions
- OptionalsdkOptions: SDKOptions
Returns Promise<
    JSONFetchResponse<
        {
            data: {
                attributes: {
                    code: string;
                    description: string;
                    details: string;
                    is_error: boolean;
                    time: string;
                };
                id: number;
                relationships?: null;
                type: "TunnelEvent";
            }[];
            links?: { next?: string | { href: string } | null }
            | null;
            meta: { request_id: string };
        },
    >,
>
- Defined in src/services/transfer/service/tunnel.ts:185

Function getEventList

Parameters

Settings