Globus SDK for JavaScript
    Preparing search index...

    Function start

    • Start a tunnel that's in the AWAITING_LISTENER state.

      Parameters

      • tunnel_uuid: string
      • options: {
            payload: Pick<
                {
                    label?: string
                    | null;
                    listener_ip_address?: string | null;
                    listener_port?: number | null;
                    state?: "STOPPING" | null;
                },
                "listener_ip_address"
                | "listener_port",
            > & Pick<
                {
                    label?: string
                    | null;
                    listener_ip_address?: string | null;
                    listener_port?: number | null;
                    state?: "STOPPING" | null;
                },
                "label",
            >;
            query?: undefined;
        } & {
            headers?: Headers;
            query?: {
                [key: string]: | string
                | number
                | boolean
                | (string | number | null | undefined)[]
                | null
                | undefined;
            };
        }
      • OptionalsdkOptions: SDKOptions

      Returns Promise<
          JSONFetchResponse<
              {
                  data: {
                      attributes: {
                          created_time?: string
                          | null;
                          initiator_ip_address?: string | null;
                          initiator_port?: number | null;
                          label?: string | null;
                          lifetime_mins: number;
                          listener_ip_address?: string | null;
                          listener_port?: number | null;
                          restartable: boolean;
                          state: string;
                          status: string;
                          submission_id: string;
                      };
                      id?: string;
                      relationships?: {
                          initiator: {
                              data?: { id?: string; type: "StreamAccessPoint" }
                              | null;
                          };
                          listener: { data?: { id?: string; type: "StreamAccessPoint" }
                          | null };
                          owner?:
                              | { data?: { id?: (...) | (...) | (...); type: string }
                              | null }
                              | null;
                      };
                      type: "Tunnel";
                  };
                  meta: { request_id: string };
              },
          >,
      >

    Settings

    Member Visibility