Globus SDK for JavaScript
    Preparing search index...

    Interface paths

    interface paths {
        "/bookmarks": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: {
                        include?: "collection" | null;
                        "page[limit]"?: number;
                        "page[marker]"?: string | null;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data: {
                                    attributes: { name: string; path: string
                                    | null };
                                    id: string;
                                    relationships: { collection: { data: { id: ...; type: ... } } };
                                    type: "Bookmark";
                                }[];
                                included?: {
                                    attributes: { display_name: string; high_assurance: boolean };
                                    id: string;
                                    type: "Collection";
                                }[];
                                links?: { next: string };
                                meta: { request_id: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            data: {
                                attributes: { name: string; path: string };
                                relationships: {
                                    collection: { data: { id: string; type: "Collection" } };
                                };
                                type: "Bookmark";
                            };
                        };
                    };
                };
                responses: {
                    "201": {
                        content: {
                            "application/json": {
                                data: {
                                    attributes: { name: string; path: string };
                                    id: string;
                                    relationships: {
                                        collection: { data: { id: string; type: "Collection" } };
                                    };
                                    type: "Bookmark";
                                };
                                included?: {
                                    attributes: { display_name: string; high_assurance: boolean };
                                    id: string;
                                    type: "Collection";
                                }[];
                                meta: { request_id: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/bookmarks/{bookmark_id}": {
            delete: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { bookmark_id: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: { "application/json": { meta: { request_id: string } } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { bookmark_id: string };
                    query?: { include?: "collection" | null };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data: {
                                    attributes: { name: string; path: string };
                                    id: string;
                                    relationships: {
                                        collection: { data: { id: string; type: "Collection" } };
                                    };
                                    type: "Bookmark";
                                };
                                included?: {
                                    attributes: { display_name: string; high_assurance: boolean };
                                    id: string;
                                    type: "Collection";
                                }[];
                                meta: { request_id: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { bookmark_id: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            data: {
                                attributes: { name: string
                                | null; path: string };
                                type: "Bookmark";
                            };
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data: {
                                    attributes: { name: string; path: string };
                                    id: string;
                                    relationships: {
                                        collection: { data: { id: string; type: "Collection" } };
                                    };
                                    type: "Bookmark";
                                };
                                included?: {
                                    attributes: { display_name: string; high_assurance: boolean };
                                    id: string;
                                    type: "Collection";
                                }[];
                                meta: { request_id: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/stream_access_points": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: {
                        "filter[endpoint_admin]"?: boolean;
                        "filter[fulltext]"?: string
                        | null;
                        "page[limit]"?: number;
                        "page[marker]"?: string | null;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data: {
                                    attributes: {
                                        advertised_owner?: string
                                        | null;
                                        contact_email?: string | null;
                                        contact_info?: string | null;
                                        department?: string | null;
                                        description?: string | null;
                                        display_name: string;
                                        info_link?: string | null;
                                        keywords?: string | null;
                                        organization?: string | null;
                                        tlsftp_server: string;
                                    };
                                    id: string;
                                    relationships: { host_endpoint: { data?: (...)
                                    | (...)
                                    | (...) } };
                                    type: "StreamAccessPoint";
                                }[];
                                links?: { next: string };
                                meta: { request_id: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/stream_access_points/{stream_access_point_uuid}": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { stream_access_point_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data: {
                                    attributes: {
                                        advertised_owner?: string
                                        | null;
                                        contact_email?: string | null;
                                        contact_info?: string | null;
                                        department?: string | null;
                                        description?: string | null;
                                        display_name: string;
                                        info_link?: string | null;
                                        keywords?: string | null;
                                        organization?: string | null;
                                        tlsftp_server: string;
                                    };
                                    id: string;
                                    relationships: {
                                        host_endpoint: { data?: { id: ...; type: ... }
                                        | null };
                                    };
                                    type: "StreamAccessPoint";
                                };
                                meta: { request_id: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/tunnels": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data: {
                                    attributes: {
                                        created_time: string;
                                        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?: (...)
                                        | (...)
                                        | (...) };
                                        listener: { data?: (...) | (...) | (...) };
                                        owner: { data?: (...) | (...) | (...) };
                                    };
                                    type: "Tunnel";
                                }[];
                                links?: { next: string };
                                meta: { request_id: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path?: undefined;
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            data: {
                                attributes: {
                                    label?: string
                                    | null;
                                    lifetime_mins: number;
                                    listener_ip_address?: string | null;
                                    listener_port?: number | null;
                                    restartable: boolean;
                                    submission_id: string;
                                };
                                relationships: {
                                    initiator: {
                                        data?: { id: string; type: "StreamAccessPoint" }
                                        | null;
                                    };
                                    listener: {
                                        data?: { id: string; type: "StreamAccessPoint" }
                                        | null;
                                    };
                                };
                                type: "Tunnel";
                            };
                        };
                    };
                };
                responses: {
                    "201": {
                        content: {
                            "application/json": {
                                data: {
                                    attributes: {
                                        created_time: string;
                                        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: ...; type: ... }
                                        | null };
                                        listener: { data?: { id: ...; type: ... } | null };
                                        owner: { data?: { id: ...; type: ... } | null };
                                    };
                                    type: "Tunnel";
                                };
                                meta: { request_id: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            put?: undefined;
            trace?: undefined;
        };
        "/tunnels/{tunnel_uuid}": {
            delete: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { tunnel_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: { "application/json": { meta: { request_id: string } } };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { tunnel_uuid: string };
                    query?: undefined;
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data: {
                                    attributes: {
                                        created_time: string;
                                        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: ...; type: ... }
                                        | null };
                                        listener: { data?: { id: ...; type: ... } | null };
                                        owner: { data?: { id: ...; type: ... } | null };
                                    };
                                    type: "Tunnel";
                                };
                                meta: { request_id: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { tunnel_uuid: string };
                    query?: undefined;
                };
                requestBody: {
                    content: {
                        "application/json": {
                            data: {
                                attributes: {
                                    label?: string
                                    | null;
                                    listener_ip_address?: string | null;
                                    listener_port?: number | null;
                                    state?: "STOPPING" | null;
                                };
                                type: "Tunnel";
                            };
                        };
                    };
                };
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data: {
                                    attributes: {
                                        created_time: string;
                                        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: ...; type: ... }
                                        | null };
                                        listener: { data?: { id: ...; type: ... } | null };
                                        owner: { data?: { id: ...; type: ... } | null };
                                    };
                                    type: "Tunnel";
                                };
                                meta: { request_id: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
        "/tunnels/{tunnel_uuid}/events": {
            delete?: undefined;
            get: {
                parameters: {
                    cookie?: undefined;
                    header?: undefined;
                    path: { tunnel_uuid: string };
                    query?: {
                        code_name?: string | null;
                        is_error?: boolean | null;
                        "page[limit]"?: number;
                        "page[marker]"?: string | null;
                    };
                };
                requestBody?: undefined;
                responses: {
                    "200": {
                        content: {
                            "application/json": {
                                data: {
                                    attributes: | {
                                        code: string;
                                        description: string;
                                        details: string;
                                        is_error: boolean;
                                        time: string;
                                    }
                                    | null;
                                    id: number;
                                    type: "TunnelEvent";
                                }[];
                                links?: { next: string };
                                meta: { request_id: string };
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                    "422": {
                        content: {
                            "application/json": {
                                detail?: {
                                    ctx?: Record<(...), (...)>;
                                    input?: unknown;
                                    loc: ((...) | (...))[];
                                    msg: string;
                                    type: string;
                                }[];
                            };
                        };
                        headers: { [name: string]: unknown };
                    };
                };
            };
            head?: undefined;
            options?: undefined;
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            patch?: undefined;
            post?: undefined;
            put?: undefined;
            trace?: undefined;
        };
    }
    Index
    /bookmarks /bookmarks/{bookmark_id} /stream_access_points /stream_access_points/{stream_access_point_uuid} /tunnels /tunnels/{tunnel_uuid} /tunnels/{tunnel_uuid}/events
    "/bookmarks": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    include?: "collection" | null;
                    "page[limit]"?: number;
                    "page[marker]"?: string | null;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                attributes: { name: string; path: string
                                | null };
                                id: string;
                                relationships: { collection: { data: { id: ...; type: ... } } };
                                type: "Bookmark";
                            }[];
                            included?: {
                                attributes: { display_name: string; high_assurance: boolean };
                                id: string;
                                type: "Collection";
                            }[];
                            links?: { next: string };
                            meta: { request_id: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        data: {
                            attributes: { name: string; path: string };
                            relationships: {
                                collection: { data: { id: string; type: "Collection" } };
                            };
                            type: "Bookmark";
                        };
                    };
                };
            };
            responses: {
                "201": {
                    content: {
                        "application/json": {
                            data: {
                                attributes: { name: string; path: string };
                                id: string;
                                relationships: {
                                    collection: { data: { id: string; type: "Collection" } };
                                };
                                type: "Bookmark";
                            };
                            included?: {
                                attributes: { display_name: string; high_assurance: boolean };
                                id: string;
                                type: "Collection";
                            }[];
                            meta: { request_id: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: {
                  include?: "collection" | null;
                  "page[limit]"?: number;
                  "page[marker]"?: string | null;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data: {
                              attributes: { name: string; path: string
                              | null };
                              id: string;
                              relationships: { collection: { data: { id: ...; type: ... } } };
                              type: "Bookmark";
                          }[];
                          included?: {
                              attributes: { display_name: string; high_assurance: boolean };
                              id: string;
                              type: "Collection";
                          }[];
                          links?: { next: string };
                          meta: { request_id: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Bookmarks List

      List the user's bookmarks. Bookmarks on High Assurance collections have their paths redacted to null.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                include?: "collection" | null;
                "page[limit]"?: number;
                "page[marker]"?: string | null;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • Optionalpath?: undefined
        • Optionalquery?: {
              include?: "collection" | null;
              "page[limit]"?: number;
              "page[marker]"?: string | null;
          }
          • Optionalinclude?: "collection" | null

            Set to 'collection' to include collection information in the response

          • Optionalpage[limit]?: number

            Limit to page size.

          • Optionalpage[marker]?: string | null

            Pagination marker.

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes: { name: string; path: string | null };
                            id: string;
                            relationships: { collection: { data: { id: ...; type: ... } } };
                            type: "Bookmark";
                        }[];
                        included?: {
                            attributes: { display_name: string; high_assurance: boolean };
                            id: string;
                            type: "Collection";
                        }[];
                        links?: { next: string };
                        meta: { request_id: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data: {
                          attributes: { name: string; path: string | null };
                          id: string;
                          relationships: { collection: { data: { id: ...; type: ... } } };
                          type: "Bookmark";
                      }[];
                      included?: {
                          attributes: { display_name: string; high_assurance: boolean };
                          id: string;
                          type: "Collection";
                      }[];
                      links?: { next: string };
                      meta: { request_id: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      data: {
                          attributes: { name: string; path: string };
                          relationships: {
                              collection: { data: { id: string; type: "Collection" } };
                          };
                          type: "Bookmark";
                      };
                  };
              };
          };
          responses: {
              "201": {
                  content: {
                      "application/json": {
                          data: {
                              attributes: { name: string; path: string };
                              id: string;
                              relationships: {
                                  collection: { data: { id: string; type: "Collection" } };
                              };
                              type: "Bookmark";
                          };
                          included?: {
                              attributes: { display_name: string; high_assurance: boolean };
                              id: string;
                              type: "Collection";
                          }[];
                          meta: { request_id: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Bookmarks Post

      Create a bookmark. Requires that the user has visibility on the collection and is in session if the collection is High Assurance.

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • requestBody: {
            content: {
                "application/json": {
                    data: {
                        attributes: { name: string; path: string };
                        relationships: {
                            collection: { data: { id: string; type: "Collection" } };
                        };
                        type: "Bookmark";
                    };
                };
            };
        }
      • responses: {
            "201": {
                content: {
                    "application/json": {
                        data: {
                            attributes: { name: string; path: string };
                            id: string;
                            relationships: {
                                collection: { data: { id: string; type: "Collection" } };
                            };
                            type: "Bookmark";
                        };
                        included?: {
                            attributes: { display_name: string; high_assurance: boolean };
                            id: string;
                            type: "Collection";
                        }[];
                        meta: { request_id: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 201: {
              content: {
                  "application/json": {
                      data: {
                          attributes: { name: string; path: string };
                          id: string;
                          relationships: {
                              collection: { data: { id: string; type: "Collection" } };
                          };
                          type: "Bookmark";
                      };
                      included?: {
                          attributes: { display_name: string; high_assurance: boolean };
                          id: string;
                          type: "Collection";
                      }[];
                      meta: { request_id: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/bookmarks/{bookmark_id}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { bookmark_id: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "application/json": { meta: { request_id: string } } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { bookmark_id: string };
                query?: { include?: "collection" | null };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                attributes: { name: string; path: string };
                                id: string;
                                relationships: {
                                    collection: { data: { id: string; type: "Collection" } };
                                };
                                type: "Bookmark";
                            };
                            included?: {
                                attributes: { display_name: string; high_assurance: boolean };
                                id: string;
                                type: "Collection";
                            }[];
                            meta: { request_id: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { bookmark_id: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        data: {
                            attributes: { name: string
                            | null; path: string };
                            type: "Bookmark";
                        };
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                attributes: { name: string; path: string };
                                id: string;
                                relationships: {
                                    collection: { data: { id: string; type: "Collection" } };
                                };
                                type: "Bookmark";
                            };
                            included?: {
                                attributes: { display_name: string; high_assurance: boolean };
                                id: string;
                                type: "Collection";
                            }[];
                            meta: { request_id: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • delete: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { bookmark_id: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: { "application/json": { meta: { request_id: string } } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Bookmarks Delete

      Delete a bookmark by UUID. Requires that the user owns the bookmark.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { bookmark_id: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: { "application/json": { meta: { request_id: string } } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": { meta: { request_id: string } } };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { bookmark_id: string };
              query?: { include?: "collection" | null };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data: {
                              attributes: { name: string; path: string };
                              id: string;
                              relationships: {
                                  collection: { data: { id: string; type: "Collection" } };
                              };
                              type: "Bookmark";
                          };
                          included?: {
                              attributes: { display_name: string; high_assurance: boolean };
                              id: string;
                              type: "Collection";
                          }[];
                          meta: { request_id: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Bookmarks Get

      Get a bookmark by UUID. Requires that the user owns the bookmark and is in session for the bookmark's collection if it is High Assurance.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { bookmark_id: string };
            query?: { include?: "collection" | null };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { bookmark_id: string }
        • Optionalquery?: { include?: "collection" | null }
          • Optionalinclude?: "collection" | null

            Set to 'collection' to include collection information in the response

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes: { name: string; path: string };
                            id: string;
                            relationships: {
                                collection: { data: { id: string; type: "Collection" } };
                            };
                            type: "Bookmark";
                        };
                        included?: {
                            attributes: { display_name: string; high_assurance: boolean };
                            id: string;
                            type: "Collection";
                        }[];
                        meta: { request_id: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data: {
                          attributes: { name: string; path: string };
                          id: string;
                          relationships: {
                              collection: { data: { id: string; type: "Collection" } };
                          };
                          type: "Bookmark";
                      };
                      included?: {
                          attributes: { display_name: string; high_assurance: boolean };
                          id: string;
                          type: "Collection";
                      }[];
                      meta: { request_id: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • patch: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { bookmark_id: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      data: {
                          attributes: { name: string
                          | null; path: string };
                          type: "Bookmark";
                      };
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data: {
                              attributes: { name: string; path: string };
                              id: string;
                              relationships: {
                                  collection: { data: { id: string; type: "Collection" } };
                              };
                              type: "Bookmark";
                          };
                          included?: {
                              attributes: { display_name: string; high_assurance: boolean };
                              id: string;
                              type: "Collection";
                          }[];
                          meta: { request_id: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Bookmarks Patch

      Update a bookmark by UUID. Requires that the user owns the bookmark and is in session for the bookmark's collection if it is High Assurance.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { bookmark_id: string };
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": {
                    data: {
                        attributes: { name: string | null; path: string };
                        type: "Bookmark";
                    };
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes: { name: string; path: string };
                            id: string;
                            relationships: {
                                collection: { data: { id: string; type: "Collection" } };
                            };
                            type: "Bookmark";
                        };
                        included?: {
                            attributes: { display_name: string; high_assurance: boolean };
                            id: string;
                            type: "Collection";
                        }[];
                        meta: { request_id: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data: {
                          attributes: { name: string; path: string };
                          id: string;
                          relationships: {
                              collection: { data: { id: string; type: "Collection" } };
                          };
                          type: "Bookmark";
                      };
                      included?: {
                          attributes: { display_name: string; high_assurance: boolean };
                          id: string;
                          type: "Collection";
                      }[];
                      meta: { request_id: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/stream_access_points": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: {
                    "filter[endpoint_admin]"?: boolean;
                    "filter[fulltext]"?: string | null;
                    "page[limit]"?: number;
                    "page[marker]"?: string | null;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                attributes: {
                                    advertised_owner?: string
                                    | null;
                                    contact_email?: string | null;
                                    contact_info?: string | null;
                                    department?: string | null;
                                    description?: string | null;
                                    display_name: string;
                                    info_link?: string | null;
                                    keywords?: string | null;
                                    organization?: string | null;
                                    tlsftp_server: string;
                                };
                                id: string;
                                relationships: { host_endpoint: { data?: (...)
                                | (...)
                                | (...) } };
                                type: "StreamAccessPoint";
                            }[];
                            links?: { next: string };
                            meta: { request_id: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: {
                  "filter[endpoint_admin]"?: boolean;
                  "filter[fulltext]"?: string | null;
                  "page[limit]"?: number;
                  "page[marker]"?: string | null;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data: {
                              attributes: {
                                  advertised_owner?: string
                                  | null;
                                  contact_email?: string | null;
                                  contact_info?: string | null;
                                  department?: string | null;
                                  description?: string | null;
                                  display_name: string;
                                  info_link?: string | null;
                                  keywords?: string | null;
                                  organization?: string | null;
                                  tlsftp_server: string;
                              };
                              id: string;
                              relationships: { host_endpoint: { data?: (...)
                              | (...)
                              | (...) } };
                              type: "StreamAccessPoint";
                          }[];
                          links?: { next: string };
                          meta: { request_id: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Stream Access Points List

      Get a list of all stream access points.

      If the user provides a UUID in filter_fulltext, test if it's a SAP UUID and return that SAP directly.
      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: {
                "filter[endpoint_admin]"?: boolean;
                "filter[fulltext]"?: string | null;
                "page[limit]"?: number;
                "page[marker]"?: string | null;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • Optionalpath?: undefined
        • Optionalquery?: {
              "filter[endpoint_admin]"?: boolean;
              "filter[fulltext]"?: string | null;
              "page[limit]"?: number;
              "page[marker]"?: string | null;
          }
          • Optionalfilter[endpoint_admin]?: boolean

            Limit results to stream access points on Globus Connect Server endpoints where the user has an administrator role

          • Optionalfilter[fulltext]?: string | null

            Limit results to stream access points that match on an attribute; each attribute is weighted equally

          • Optionalpage[limit]?: number

            Limit to page size.

          • Optionalpage[marker]?: string | null

            Pagination marker.

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes: {
                                advertised_owner?: string | null;
                                contact_email?: string | null;
                                contact_info?: string | null;
                                department?: string | null;
                                description?: string | null;
                                display_name: string;
                                info_link?: string | null;
                                keywords?: string | null;
                                organization?: string | null;
                                tlsftp_server: string;
                            };
                            id: string;
                            relationships: { host_endpoint: { data?: (...)
                            | (...)
                            | (...) } };
                            type: "StreamAccessPoint";
                        }[];
                        links?: { next: string };
                        meta: { request_id: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data: {
                          attributes: {
                              advertised_owner?: string | null;
                              contact_email?: string | null;
                              contact_info?: string | null;
                              department?: string | null;
                              description?: string | null;
                              display_name: string;
                              info_link?: string | null;
                              keywords?: string | null;
                              organization?: string | null;
                              tlsftp_server: string;
                          };
                          id: string;
                          relationships: { host_endpoint: { data?: (...)
                          | (...)
                          | (...) } };
                          type: "StreamAccessPoint";
                      }[];
                      links?: { next: string };
                      meta: { request_id: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/stream_access_points/{stream_access_point_uuid}": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { stream_access_point_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                attributes: {
                                    advertised_owner?: string
                                    | null;
                                    contact_email?: string | null;
                                    contact_info?: string | null;
                                    department?: string | null;
                                    description?: string | null;
                                    display_name: string;
                                    info_link?: string | null;
                                    keywords?: string | null;
                                    organization?: string | null;
                                    tlsftp_server: string;
                                };
                                id: string;
                                relationships: {
                                    host_endpoint: { data?: { id: ...; type: ... }
                                    | null };
                                };
                                type: "StreamAccessPoint";
                            };
                            meta: { request_id: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { stream_access_point_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data: {
                              attributes: {
                                  advertised_owner?: string
                                  | null;
                                  contact_email?: string | null;
                                  contact_info?: string | null;
                                  department?: string | null;
                                  description?: string | null;
                                  display_name: string;
                                  info_link?: string | null;
                                  keywords?: string | null;
                                  organization?: string | null;
                                  tlsftp_server: string;
                              };
                              id: string;
                              relationships: {
                                  host_endpoint: { data?: { id: ...; type: ... }
                                  | null };
                              };
                              type: "StreamAccessPoint";
                          };
                          meta: { request_id: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Stream Access Points Get

      Get a stream access point by UUID

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { stream_access_point_uuid: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes: {
                                advertised_owner?: string | null;
                                contact_email?: string | null;
                                contact_info?: string | null;
                                department?: string | null;
                                description?: string | null;
                                display_name: string;
                                info_link?: string | null;
                                keywords?: string | null;
                                organization?: string | null;
                                tlsftp_server: string;
                            };
                            id: string;
                            relationships: {
                                host_endpoint: { data?: { id: ...; type: ... }
                                | null };
                            };
                            type: "StreamAccessPoint";
                        };
                        meta: { request_id: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data: {
                          attributes: {
                              advertised_owner?: string | null;
                              contact_email?: string | null;
                              contact_info?: string | null;
                              department?: string | null;
                              description?: string | null;
                              display_name: string;
                              info_link?: string | null;
                              keywords?: string | null;
                              organization?: string | null;
                              tlsftp_server: string;
                          };
                          id: string;
                          relationships: {
                              host_endpoint: { data?: { id: ...; type: ... }
                              | null };
                          };
                          type: "StreamAccessPoint";
                      };
                      meta: { request_id: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/tunnels": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                attributes: {
                                    created_time: string;
                                    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?: (...)
                                    | (...)
                                    | (...) };
                                    listener: { data?: (...) | (...) | (...) };
                                    owner: { data?: (...) | (...) | (...) };
                                };
                                type: "Tunnel";
                            }[];
                            links?: { next: string };
                            meta: { request_id: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path?: undefined;
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        data: {
                            attributes: {
                                label?: string
                                | null;
                                lifetime_mins: number;
                                listener_ip_address?: string | null;
                                listener_port?: number | null;
                                restartable: boolean;
                                submission_id: string;
                            };
                            relationships: {
                                initiator: {
                                    data?: { id: string; type: "StreamAccessPoint" }
                                    | null;
                                };
                                listener: { data?: { id: string; type: "StreamAccessPoint" }
                                | null };
                            };
                            type: "Tunnel";
                        };
                    };
                };
            };
            responses: {
                "201": {
                    content: {
                        "application/json": {
                            data: {
                                attributes: {
                                    created_time: string;
                                    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: ...; type: ... }
                                    | null };
                                    listener: { data?: { id: ...; type: ... } | null };
                                    owner: { data?: { id: ...; type: ... } | null };
                                };
                                type: "Tunnel";
                            };
                            meta: { request_id: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data: {
                              attributes: {
                                  created_time: string;
                                  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?: (...)
                                  | (...)
                                  | (...) };
                                  listener: { data?: (...) | (...) | (...) };
                                  owner: { data?: (...) | (...) | (...) };
                              };
                              type: "Tunnel";
                          }[];
                          links?: { next: string };
                          meta: { request_id: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Tunnels List

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes: {
                                created_time: string;
                                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?: (...)
                                | (...)
                                | (...) };
                                listener: { data?: (...) | (...) | (...) };
                                owner: { data?: (...) | (...) | (...) };
                            };
                            type: "Tunnel";
                        }[];
                        links?: { next: string };
                        meta: { request_id: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data: {
                          attributes: {
                              created_time: string;
                              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?: (...)
                              | (...)
                              | (...) };
                              listener: { data?: (...) | (...) | (...) };
                              owner: { data?: (...) | (...) | (...) };
                          };
                          type: "Tunnel";
                      }[];
                      links?: { next: string };
                      meta: { request_id: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • post: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path?: undefined;
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      data: {
                          attributes: {
                              label?: string
                              | null;
                              lifetime_mins: number;
                              listener_ip_address?: string | null;
                              listener_port?: number | null;
                              restartable: boolean;
                              submission_id: string;
                          };
                          relationships: {
                              initiator: {
                                  data?: { id: string; type: "StreamAccessPoint" }
                                  | null;
                              };
                              listener: { data?: { id: string; type: "StreamAccessPoint" }
                              | null };
                          };
                          type: "Tunnel";
                      };
                  };
              };
          };
          responses: {
              "201": {
                  content: {
                      "application/json": {
                          data: {
                              attributes: {
                                  created_time: string;
                                  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: ...; type: ... }
                                  | null };
                                  listener: { data?: { id: ...; type: ... } | null };
                                  owner: { data?: { id: ...; type: ... } | null };
                              };
                              type: "Tunnel";
                          };
                          meta: { request_id: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Tunnels Post

      • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
      • requestBody: {
            content: {
                "application/json": {
                    data: {
                        attributes: {
                            label?: string | null;
                            lifetime_mins: number;
                            listener_ip_address?: string | null;
                            listener_port?: number | null;
                            restartable: boolean;
                            submission_id: string;
                        };
                        relationships: {
                            initiator: {
                                data?: { id: string; type: "StreamAccessPoint" }
                                | null;
                            };
                            listener: { data?: { id: string; type: "StreamAccessPoint" }
                            | null };
                        };
                        type: "Tunnel";
                    };
                };
            };
        }
      • responses: {
            "201": {
                content: {
                    "application/json": {
                        data: {
                            attributes: {
                                created_time: string;
                                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: ...; type: ... }
                                | null };
                                listener: { data?: { id: ...; type: ... } | null };
                                owner: { data?: { id: ...; type: ... } | null };
                            };
                            type: "Tunnel";
                        };
                        meta: { request_id: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 201: {
              content: {
                  "application/json": {
                      data: {
                          attributes: {
                              created_time: string;
                              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: ...; type: ... }
                              | null };
                              listener: { data?: { id: ...; type: ... } | null };
                              owner: { data?: { id: ...; type: ... } | null };
                          };
                          type: "Tunnel";
                      };
                      meta: { request_id: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/tunnels/{tunnel_uuid}": {
        delete: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { tunnel_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: { "application/json": { meta: { request_id: string } } };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { tunnel_uuid: string };
                query?: undefined;
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                attributes: {
                                    created_time: string;
                                    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: ...; type: ... }
                                    | null };
                                    listener: { data?: { id: ...; type: ... } | null };
                                    owner: { data?: { id: ...; type: ... } | null };
                                };
                                type: "Tunnel";
                            };
                            meta: { request_id: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { tunnel_uuid: string };
                query?: undefined;
            };
            requestBody: {
                content: {
                    "application/json": {
                        data: {
                            attributes: {
                                label?: string
                                | null;
                                listener_ip_address?: string | null;
                                listener_port?: number | null;
                                state?: "STOPPING" | null;
                            };
                            type: "Tunnel";
                        };
                    };
                };
            };
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                attributes: {
                                    created_time: string;
                                    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: ...; type: ... }
                                    | null };
                                    listener: { data?: { id: ...; type: ... } | null };
                                    owner: { data?: { id: ...; type: ... } | null };
                                };
                                type: "Tunnel";
                            };
                            meta: { request_id: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • delete: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { tunnel_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: { "application/json": { meta: { request_id: string } } };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Tunnels Delete

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { tunnel_uuid: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: { "application/json": { meta: { request_id: string } } };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: { "application/json": { meta: { request_id: string } } };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { tunnel_uuid: string };
              query?: undefined;
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data: {
                              attributes: {
                                  created_time: string;
                                  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: ...; type: ... }
                                  | null };
                                  listener: { data?: { id: ...; type: ... } | null };
                                  owner: { data?: { id: ...; type: ... } | null };
                              };
                              type: "Tunnel";
                          };
                          meta: { request_id: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Tunnels Get

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { tunnel_uuid: string };
            query?: undefined;
        }
      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes: {
                                created_time: string;
                                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: ...; type: ... }
                                | null };
                                listener: { data?: { id: ...; type: ... } | null };
                                owner: { data?: { id: ...; type: ... } | null };
                            };
                            type: "Tunnel";
                        };
                        meta: { request_id: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data: {
                          attributes: {
                              created_time: string;
                              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: ...; type: ... }
                              | null };
                              listener: { data?: { id: ...; type: ... } | null };
                              owner: { data?: { id: ...; type: ... } | null };
                          };
                          type: "Tunnel";
                      };
                      meta: { request_id: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • patch: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { tunnel_uuid: string };
              query?: undefined;
          };
          requestBody: {
              content: {
                  "application/json": {
                      data: {
                          attributes: {
                              label?: string
                              | null;
                              listener_ip_address?: string | null;
                              listener_port?: number | null;
                              state?: "STOPPING" | null;
                          };
                          type: "Tunnel";
                      };
                  };
              };
          };
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data: {
                              attributes: {
                                  created_time: string;
                                  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: ...; type: ... }
                                  | null };
                                  listener: { data?: { id: ...; type: ... } | null };
                                  owner: { data?: { id: ...; type: ... } | null };
                              };
                              type: "Tunnel";
                          };
                          meta: { request_id: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Tunnels Patch

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { tunnel_uuid: string };
            query?: undefined;
        }
      • requestBody: {
            content: {
                "application/json": {
                    data: {
                        attributes: {
                            label?: string | null;
                            listener_ip_address?: string | null;
                            listener_port?: number | null;
                            state?: "STOPPING" | null;
                        };
                        type: "Tunnel";
                    };
                };
            };
        }
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes: {
                                created_time: string;
                                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: ...; type: ... }
                                | null };
                                listener: { data?: { id: ...; type: ... } | null };
                                owner: { data?: { id: ...; type: ... } | null };
                            };
                            type: "Tunnel";
                        };
                        meta: { request_id: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data: {
                          attributes: {
                              created_time: string;
                              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: ...; type: ... }
                              | null };
                              listener: { data?: { id: ...; type: ... } | null };
                              owner: { data?: { id: ...; type: ... } | null };
                          };
                          type: "Tunnel";
                      };
                      meta: { request_id: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined
    "/tunnels/{tunnel_uuid}/events": {
        delete?: undefined;
        get: {
            parameters: {
                cookie?: undefined;
                header?: undefined;
                path: { tunnel_uuid: string };
                query?: {
                    code_name?: string | null;
                    is_error?: boolean | null;
                    "page[limit]"?: number;
                    "page[marker]"?: string | null;
                };
            };
            requestBody?: undefined;
            responses: {
                "200": {
                    content: {
                        "application/json": {
                            data: {
                                attributes: | {
                                    code: string;
                                    description: string;
                                    details: string;
                                    is_error: boolean;
                                    time: string;
                                }
                                | null;
                                id: number;
                                type: "TunnelEvent";
                            }[];
                            links?: { next: string };
                            meta: { request_id: string };
                        };
                    };
                    headers: { [name: string]: unknown };
                };
                "422": {
                    content: {
                        "application/json": {
                            detail?: {
                                ctx?: Record<(...), (...)>;
                                input?: unknown;
                                loc: ((...) | (...))[];
                                msg: string;
                                type: string;
                            }[];
                        };
                    };
                    headers: { [name: string]: unknown };
                };
            };
        };
        head?: undefined;
        options?: undefined;
        parameters: {
            cookie?: undefined;
            header?: undefined;
            path?: undefined;
            query?: undefined;
        };
        patch?: undefined;
        post?: undefined;
        put?: undefined;
        trace?: undefined;
    }

    Type Declaration

    • Optionaldelete?: undefined
    • get: {
          parameters: {
              cookie?: undefined;
              header?: undefined;
              path: { tunnel_uuid: string };
              query?: {
                  code_name?: string | null;
                  is_error?: boolean | null;
                  "page[limit]"?: number;
                  "page[marker]"?: string | null;
              };
          };
          requestBody?: undefined;
          responses: {
              "200": {
                  content: {
                      "application/json": {
                          data: {
                              attributes: | {
                                  code: string;
                                  description: string;
                                  details: string;
                                  is_error: boolean;
                                  time: string;
                              }
                              | null;
                              id: number;
                              type: "TunnelEvent";
                          }[];
                          links?: { next: string };
                          meta: { request_id: string };
                      };
                  };
                  headers: { [name: string]: unknown };
              };
              "422": {
                  content: {
                      "application/json": {
                          detail?: {
                              ctx?: Record<(...), (...)>;
                              input?: unknown;
                              loc: ((...) | (...))[];
                              msg: string;
                              type: string;
                          }[];
                      };
                  };
                  headers: { [name: string]: unknown };
              };
          };
      }

      Get Tunnel Events By Tunnel Uuid

      Return events associated with a particular tunnel. Filter events with code_name or is_error query params.

      • parameters: {
            cookie?: undefined;
            header?: undefined;
            path: { tunnel_uuid: string };
            query?: {
                code_name?: string | null;
                is_error?: boolean | null;
                "page[limit]"?: number;
                "page[marker]"?: string | null;
            };
        }
        • Optionalcookie?: undefined
        • Optionalheader?: undefined
        • path: { tunnel_uuid: string }
        • Optionalquery?: {
              code_name?: string | null;
              is_error?: boolean | null;
              "page[limit]"?: number;
              "page[marker]"?: string | null;
          }
          • Optionalcode_name?: string | null

            Filter events by a specific event code. Cannot be used with is_error

          • Optionalis_error?: boolean | null

            Filter events to errors only. Cannot be used with code_name

          • Optionalpage[limit]?: number

            Limit to page size.

          • Optionalpage[marker]?: string | null

            Pagination marker.

      • OptionalrequestBody?: undefined
      • responses: {
            "200": {
                content: {
                    "application/json": {
                        data: {
                            attributes:
                                | {
                                    code: string;
                                    description: string;
                                    details: string;
                                    is_error: boolean;
                                    time: string;
                                }
                                | null;
                            id: number;
                            type: "TunnelEvent";
                        }[];
                        links?: { next: string };
                        meta: { request_id: string };
                    };
                };
                headers: { [name: string]: unknown };
            };
            "422": {
                content: {
                    "application/json": {
                        detail?: {
                            ctx?: Record<(...), (...)>;
                            input?: unknown;
                            loc: ((...) | (...))[];
                            msg: string;
                            type: string;
                        }[];
                    };
                };
                headers: { [name: string]: unknown };
            };
        }
        • 200: {
              content: {
                  "application/json": {
                      data: {
                          attributes:
                              | {
                                  code: string;
                                  description: string;
                                  details: string;
                                  is_error: boolean;
                                  time: string;
                              }
                              | null;
                          id: number;
                          type: "TunnelEvent";
                      }[];
                      links?: { next: string };
                      meta: { request_id: string };
                  };
              };
              headers: { [name: string]: unknown };
          }

          Successful Response

        • 422: {
              content: {
                  "application/json": {
                      detail?: {
                          ctx?: Record<(...), (...)>;
                          input?: unknown;
                          loc: ((...) | (...))[];
                          msg: string;
                          type: string;
                      }[];
                  };
              };
              headers: { [name: string]: unknown };
          }

          Validation Error

    • Optionalhead?: undefined
    • Optionaloptions?: undefined
    • parameters: { cookie?: undefined; header?: undefined; path?: undefined; query?: undefined }
    • Optionalpatch?: undefined
    • Optionalpost?: undefined
    • Optionalput?: undefined
    • Optionaltrace?: undefined

    Settings
    Member Visibility

    On This Page
    Properties