Interface components

interface components {
    headers: never;
    parameters: never;
    pathItems: never;
    requestBodies: never;
    responses: never;
    schemas: {
        AbstractResourceIdentifier_Literal__Collection___: {
            id: string;
            type: "Collection";
        };
        AbstractResourceIdentifier_Literal__Endpoint___: {
            id: string;
            type: "Endpoint";
        };
        AbstractResourceIdentifier_Literal__Identity___: {
            id: string;
            type: "Identity";
        };
        AbstractResourceIdentifier_Literal__StreamAccessPoint___: {
            id: string;
            type: "StreamAccessPoint";
        };
        BookmarkAttributes_str_: { name: string; path: string };
        BookmarkCreateRequest: {
            data: {
                attributes: { name: string; path: string };
                relationships?:
                    | {
                        collection: {
                            data: | { id: string; type: "Collection" }
                            | { id: string; type: "Collection" }[];
                        };
                    }
                    | null;
                type: "Bookmark";
            };
        };
        BookmarkCreateResource: {
            attributes: { name: string; path: string };
            relationships?:
                | {
                    collection: {
                        data: | { id: string; type: "Collection" }
                        | { id: string; type: "Collection" }[];
                    };
                }
                | null;
            type: "Bookmark";
        };
        BookmarkListAttributes: { name: string; path?: string
        | null };
        BookmarkListResponse: {
            data: {
                attributes: { name: string; path?: string | null };
                id: string;
                relationships?:
                    | {
                        collection: {
                            data: | { id: string; type: "Collection" }
                            | { id: string; type: "Collection" }[];
                        };
                    }
                    | null;
                type: "Bookmark";
            }[];
            included?: | {
                attributes: { display_name: string; high_assurance: boolean };
                id: string;
                relationships?: null;
                type: "Collection";
            }[]
            | null;
            links?: { next?: string | { href: string } | null }
            | null;
            meta: { request_id: string };
        };
        BookmarkListResponseResource: {
            attributes: { name: string; path?: string
            | null };
            id: string;
            relationships?:
                | {
                    collection: {
                        data: | { id: string; type: "Collection" }
                        | { id: string; type: "Collection" }[];
                    };
                }
                | null;
            type: "Bookmark";
        };
        BookmarkRelationships: {
            collection: {
                data: | { id: string; type: "Collection" }
                | { id: string; type: "Collection" }[];
            };
        };
        BookmarkResponse: {
            data: {
                attributes: { name: string; path: string };
                id: string;
                relationships?:
                    | {
                        collection: {
                            data: | { id: string; type: "Collection" }
                            | { id: string; type: "Collection" }[];
                        };
                    }
                    | null;
                type: "Bookmark";
            };
            included?: | {
                attributes: { display_name: string; high_assurance: boolean };
                id: string;
                relationships?: null;
                type: "Collection";
            }[]
            | null;
            meta: { request_id: string };
        };
        BookmarkResponseResource: {
            attributes: { name: string; path: string };
            id: string;
            relationships?:
                | {
                    collection: {
                        data: | { id: string; type: "Collection" }
                        | { id: string; type: "Collection" }[];
                    };
                }
                | null;
            type: "Bookmark";
        };
        BookmarkUpdateAttributes: { name?: string
        | null; path?: string | null };
        BookmarkUpdateRequest: {
            data: {
                attributes: { name?: string | null; path?: string | null };
                id?: string | null;
                type: "Bookmark";
            };
        };
        BookmarkUpdateResource: {
            attributes: { name?: string
            | null; path?: string | null };
            id?: string | null;
            type: "Bookmark";
        };
        CollectionAttributes: { display_name: string; high_assurance: boolean };
        CollectionDataRelationship: {
            data:
                | { id: string; type: "Collection" }
                | { id: string; type: "Collection" }[];
        };
        CollectionResponseResource: {
            attributes: { display_name: string; high_assurance: boolean };
            id: string;
            relationships?: null;
            type: "Collection";
        };
        EndpointDataRelationship: {
            data: | { id: string; type: "Endpoint" }
            | { id: string; type: "Endpoint" }[];
        };
        HTTPValidationError: {
            detail?: {
                ctx?: Record<string, unknown>;
                input?: unknown;
                loc: (string | number)[];
                msg: string;
                type: string;
            }[];
        };
        IdentityDataRelationship: {
            data: | { id: string; type: "Identity" }
            | { id: string; type: "Identity" }[];
        };
        Link: { href: string };
        MetaDocument: { meta: { request_id: string } };
        PaginationLinks: { next?: string | { href: string } | null };
        StreamAccessPointAttributes: {
            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;
        };
        StreamAccessPointDataRelationship: {
            data: | { id: string; type: "StreamAccessPoint" }
            | { id: string; type: "StreamAccessPoint" }[];
        };
        StreamAccessPointListResponse: {
            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: string; type: "Endpoint" }
                        | { id: string; type: "Endpoint" }[];
                    };
                }
                | null;
                type: "StreamAccessPoint";
            }[];
            links?: { next?: string | { href: string } | null }
            | null;
            meta: { request_id: string };
        };
        StreamAccessPointResponse: {
            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: string; type: "Endpoint" }
                        | { id: string; type: "Endpoint" }[];
                    };
                }
                | null;
                type: "StreamAccessPoint";
            };
            meta: { request_id: string };
        };
        StreamAccessPointResponseRelationships: {
            host_endpoint: {
                data: | { id: string; type: "Endpoint" }
                | { id: string; type: "Endpoint" }[];
            };
        };
        StreamAccessPointResponseResource: {
            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: string; type: "Endpoint" }
                    | { id: string; type: "Endpoint" }[];
                };
            }
            | null;
            type: "StreamAccessPoint";
        };
        TopLevelMeta: { request_id: string };
        TunnelCreateRequest: {
            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" }
                        | { id: string; type: "StreamAccessPoint" }[];
                    };
                    listener: {
                        data: | { id: string; type: "StreamAccessPoint" }
                        | { id: string; type: "StreamAccessPoint" }[];
                    };
                }
                | null;
                type: "Tunnel";
            };
        };
        TunnelCreateResource: {
            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" }
                    | { id: string; type: "StreamAccessPoint" }[];
                };
                listener: {
                    data: | { id: string; type: "StreamAccessPoint" }
                    | { id: string; type: "StreamAccessPoint" }[];
                };
            }
            | null;
            type: "Tunnel";
        };
        TunnelEventAttributes: {
            code: string;
            description: string;
            details: string;
            is_error: boolean;
            time: string;
        };
        TunnelEventListResponse: {
            data: {
                attributes: {
                    code: string;
                    description: string;
                    details: string;
                    is_error: boolean;
                    time: string;
                };
                id: number;
                relationships?: null;
                type: "TunnelEvent";
            }[];
            links?: { next?: string | { href: string } | null }
            | null;
            meta: { request_id: string };
        };
        TunnelEventResponseResource: {
            attributes: {
                code: string;
                description: string;
                details: string;
                is_error: boolean;
                time: string;
            };
            id: number;
            relationships?: null;
            type: "TunnelEvent";
        };
        TunnelListResponse: {
            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: string; type: "StreamAccessPoint" }
                        | { id: string; type: "StreamAccessPoint" }[];
                    };
                    listener: {
                        data: | { id: string; type: "StreamAccessPoint" }
                        | { id: string; type: "StreamAccessPoint" }[];
                    };
                    owner: {
                        data: | { id: string; type: "Identity" }
                        | { id: string; type: "Identity" }[];
                    };
                }
                | null;
                type: "Tunnel";
            }[];
            links?: { next?: string | { href: string } | null }
            | null;
            meta: { request_id: string };
        };
        TunnelPatchAttributes: {
            label?: string
            | null;
            listener_ip_address?: string | null;
            listener_port?: number | null;
            state?: "STOPPING" | null;
        };
        TunnelPatchResource: {
            attributes: {
                label?: string
                | null;
                listener_ip_address?: string | null;
                listener_port?: number | null;
                state?: "STOPPING" | null;
            };
            id?: string
            | null;
            type?: "Tunnel" | null;
        };
        TunnelRequestAttributes: {
            label?: string
            | null;
            lifetime_mins: number;
            listener_ip_address?: string | null;
            listener_port?: number | null;
            restartable: boolean;
            submission_id: string;
        };
        TunnelRequestRelationships: {
            initiator: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            listener: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
        };
        TunnelResponse: {
            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: string; type: "StreamAccessPoint" }
                        | { id: string; type: "StreamAccessPoint" }[];
                    };
                    listener: {
                        data: | { id: string; type: "StreamAccessPoint" }
                        | { id: string; type: "StreamAccessPoint" }[];
                    };
                    owner: {
                        data: | { id: string; type: "Identity" }
                        | { id: string; type: "Identity" }[];
                    };
                }
                | null;
                type: "Tunnel";
            };
            meta: { request_id: string };
        };
        TunnelResponseAttributes: {
            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;
        };
        TunnelResponseRelationships: {
            initiator: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            listener: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            owner: {
                data: | { id: string; type: "Identity" }
                | { id: string; type: "Identity" }[];
            };
        };
        TunnelResponseResource: {
            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: string; type: "StreamAccessPoint" }
                    | { id: string; type: "StreamAccessPoint" }[];
                };
                listener: {
                    data: | { id: string; type: "StreamAccessPoint" }
                    | { id: string; type: "StreamAccessPoint" }[];
                };
                owner: {
                    data: | { id: string; type: "Identity" }
                    | { id: string; type: "Identity" }[];
                };
            }
            | null;
            type: "Tunnel";
        };
        TunnelUpdateRequest: {
            data: {
                attributes: {
                    label?: string
                    | null;
                    listener_ip_address?: string | null;
                    listener_port?: number | null;
                    state?: "STOPPING" | null;
                };
                id?: string
                | null;
                type?: "Tunnel" | null;
            };
        };
        ValidationError: {
            ctx?: Record<string, unknown>;
            input?: unknown;
            loc: (string | number)[];
            msg: string;
            type: string;
        };
    };
}

Index

Properties

headers parameters pathItems requestBodies responses schemas

Properties

headers

headers: never

parameters

parameters: never

pathItems

pathItems: never

requestBodies

requestBodies: never

responses

responses: never

schemas

schemas: {
    AbstractResourceIdentifier_Literal__Collection___: {
        id: string;
        type: "Collection";
    };
    AbstractResourceIdentifier_Literal__Endpoint___: {
        id: string;
        type: "Endpoint";
    };
    AbstractResourceIdentifier_Literal__Identity___: {
        id: string;
        type: "Identity";
    };
    AbstractResourceIdentifier_Literal__StreamAccessPoint___: {
        id: string;
        type: "StreamAccessPoint";
    };
    BookmarkAttributes_str_: { name: string; path: string };
    BookmarkCreateRequest: {
        data: {
            attributes: { name: string; path: string };
            relationships?:
                | {
                    collection: {
                        data: | { id: string; type: "Collection" }
                        | { id: string; type: "Collection" }[];
                    };
                }
                | null;
            type: "Bookmark";
        };
    };
    BookmarkCreateResource: {
        attributes: { name: string; path: string };
        relationships?:
            | {
                collection: {
                    data: | { id: string; type: "Collection" }
                    | { id: string; type: "Collection" }[];
                };
            }
            | null;
        type: "Bookmark";
    };
    BookmarkListAttributes: { name: string; path?: string
    | null };
    BookmarkListResponse: {
        data: {
            attributes: { name: string; path?: string | null };
            id: string;
            relationships?:
                | {
                    collection: {
                        data: | { id: string; type: "Collection" }
                        | { id: string; type: "Collection" }[];
                    };
                }
                | null;
            type: "Bookmark";
        }[];
        included?: | {
            attributes: { display_name: string; high_assurance: boolean };
            id: string;
            relationships?: null;
            type: "Collection";
        }[]
        | null;
        links?: { next?: string | { href: string } | null }
        | null;
        meta: { request_id: string };
    };
    BookmarkListResponseResource: {
        attributes: { name: string; path?: string
        | null };
        id: string;
        relationships?:
            | {
                collection: {
                    data: | { id: string; type: "Collection" }
                    | { id: string; type: "Collection" }[];
                };
            }
            | null;
        type: "Bookmark";
    };
    BookmarkRelationships: {
        collection: {
            data: | { id: string; type: "Collection" }
            | { id: string; type: "Collection" }[];
        };
    };
    BookmarkResponse: {
        data: {
            attributes: { name: string; path: string };
            id: string;
            relationships?:
                | {
                    collection: {
                        data: | { id: string; type: "Collection" }
                        | { id: string; type: "Collection" }[];
                    };
                }
                | null;
            type: "Bookmark";
        };
        included?: | {
            attributes: { display_name: string; high_assurance: boolean };
            id: string;
            relationships?: null;
            type: "Collection";
        }[]
        | null;
        meta: { request_id: string };
    };
    BookmarkResponseResource: {
        attributes: { name: string; path: string };
        id: string;
        relationships?:
            | {
                collection: {
                    data: | { id: string; type: "Collection" }
                    | { id: string; type: "Collection" }[];
                };
            }
            | null;
        type: "Bookmark";
    };
    BookmarkUpdateAttributes: { name?: string
    | null; path?: string | null };
    BookmarkUpdateRequest: {
        data: {
            attributes: { name?: string | null; path?: string | null };
            id?: string | null;
            type: "Bookmark";
        };
    };
    BookmarkUpdateResource: {
        attributes: { name?: string
        | null; path?: string | null };
        id?: string | null;
        type: "Bookmark";
    };
    CollectionAttributes: { display_name: string; high_assurance: boolean };
    CollectionDataRelationship: {
        data:
            | { id: string; type: "Collection" }
            | { id: string; type: "Collection" }[];
    };
    CollectionResponseResource: {
        attributes: { display_name: string; high_assurance: boolean };
        id: string;
        relationships?: null;
        type: "Collection";
    };
    EndpointDataRelationship: {
        data: | { id: string; type: "Endpoint" }
        | { id: string; type: "Endpoint" }[];
    };
    HTTPValidationError: {
        detail?: {
            ctx?: Record<string, unknown>;
            input?: unknown;
            loc: (string | number)[];
            msg: string;
            type: string;
        }[];
    };
    IdentityDataRelationship: {
        data: | { id: string; type: "Identity" }
        | { id: string; type: "Identity" }[];
    };
    Link: { href: string };
    MetaDocument: { meta: { request_id: string } };
    PaginationLinks: { next?: string | { href: string } | null };
    StreamAccessPointAttributes: {
        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;
    };
    StreamAccessPointDataRelationship: {
        data: | { id: string; type: "StreamAccessPoint" }
        | { id: string; type: "StreamAccessPoint" }[];
    };
    StreamAccessPointListResponse: {
        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: string; type: "Endpoint" }
                    | { id: string; type: "Endpoint" }[];
                };
            }
            | null;
            type: "StreamAccessPoint";
        }[];
        links?: { next?: string | { href: string } | null }
        | null;
        meta: { request_id: string };
    };
    StreamAccessPointResponse: {
        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: string; type: "Endpoint" }
                    | { id: string; type: "Endpoint" }[];
                };
            }
            | null;
            type: "StreamAccessPoint";
        };
        meta: { request_id: string };
    };
    StreamAccessPointResponseRelationships: {
        host_endpoint: {
            data: | { id: string; type: "Endpoint" }
            | { id: string; type: "Endpoint" }[];
        };
    };
    StreamAccessPointResponseResource: {
        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: string; type: "Endpoint" }
                | { id: string; type: "Endpoint" }[];
            };
        }
        | null;
        type: "StreamAccessPoint";
    };
    TopLevelMeta: { request_id: string };
    TunnelCreateRequest: {
        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" }
                    | { id: string; type: "StreamAccessPoint" }[];
                };
                listener: {
                    data: | { id: string; type: "StreamAccessPoint" }
                    | { id: string; type: "StreamAccessPoint" }[];
                };
            }
            | null;
            type: "Tunnel";
        };
    };
    TunnelCreateResource: {
        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" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            listener: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
        }
        | null;
        type: "Tunnel";
    };
    TunnelEventAttributes: {
        code: string;
        description: string;
        details: string;
        is_error: boolean;
        time: string;
    };
    TunnelEventListResponse: {
        data: {
            attributes: {
                code: string;
                description: string;
                details: string;
                is_error: boolean;
                time: string;
            };
            id: number;
            relationships?: null;
            type: "TunnelEvent";
        }[];
        links?: { next?: string | { href: string } | null }
        | null;
        meta: { request_id: string };
    };
    TunnelEventResponseResource: {
        attributes: {
            code: string;
            description: string;
            details: string;
            is_error: boolean;
            time: string;
        };
        id: number;
        relationships?: null;
        type: "TunnelEvent";
    };
    TunnelListResponse: {
        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: string; type: "StreamAccessPoint" }
                    | { id: string; type: "StreamAccessPoint" }[];
                };
                listener: {
                    data: | { id: string; type: "StreamAccessPoint" }
                    | { id: string; type: "StreamAccessPoint" }[];
                };
                owner: {
                    data: | { id: string; type: "Identity" }
                    | { id: string; type: "Identity" }[];
                };
            }
            | null;
            type: "Tunnel";
        }[];
        links?: { next?: string | { href: string } | null }
        | null;
        meta: { request_id: string };
    };
    TunnelPatchAttributes: {
        label?: string
        | null;
        listener_ip_address?: string | null;
        listener_port?: number | null;
        state?: "STOPPING" | null;
    };
    TunnelPatchResource: {
        attributes: {
            label?: string
            | null;
            listener_ip_address?: string | null;
            listener_port?: number | null;
            state?: "STOPPING" | null;
        };
        id?: string
        | null;
        type?: "Tunnel" | null;
    };
    TunnelRequestAttributes: {
        label?: string
        | null;
        lifetime_mins: number;
        listener_ip_address?: string | null;
        listener_port?: number | null;
        restartable: boolean;
        submission_id: string;
    };
    TunnelRequestRelationships: {
        initiator: {
            data: | { id: string; type: "StreamAccessPoint" }
            | { id: string; type: "StreamAccessPoint" }[];
        };
        listener: {
            data: | { id: string; type: "StreamAccessPoint" }
            | { id: string; type: "StreamAccessPoint" }[];
        };
    };
    TunnelResponse: {
        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: string; type: "StreamAccessPoint" }
                    | { id: string; type: "StreamAccessPoint" }[];
                };
                listener: {
                    data: | { id: string; type: "StreamAccessPoint" }
                    | { id: string; type: "StreamAccessPoint" }[];
                };
                owner: {
                    data: | { id: string; type: "Identity" }
                    | { id: string; type: "Identity" }[];
                };
            }
            | null;
            type: "Tunnel";
        };
        meta: { request_id: string };
    };
    TunnelResponseAttributes: {
        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;
    };
    TunnelResponseRelationships: {
        initiator: {
            data: | { id: string; type: "StreamAccessPoint" }
            | { id: string; type: "StreamAccessPoint" }[];
        };
        listener: {
            data: | { id: string; type: "StreamAccessPoint" }
            | { id: string; type: "StreamAccessPoint" }[];
        };
        owner: {
            data: | { id: string; type: "Identity" }
            | { id: string; type: "Identity" }[];
        };
    };
    TunnelResponseResource: {
        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: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            listener: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            owner: {
                data: | { id: string; type: "Identity" }
                | { id: string; type: "Identity" }[];
            };
        }
        | null;
        type: "Tunnel";
    };
    TunnelUpdateRequest: {
        data: {
            attributes: {
                label?: string
                | null;
                listener_ip_address?: string | null;
                listener_port?: number | null;
                state?: "STOPPING" | null;
            };
            id?: string
            | null;
            type?: "Tunnel" | null;
        };
    };
    ValidationError: {
        ctx?: Record<string, unknown>;
        input?: unknown;
        loc: (string | number)[];
        msg: string;
        type: string;
    };
}

Type Declaration

AbstractResourceIdentifier_Literal__Collection___: { id: string; type: "Collection" }

AbstractResourceIdentifier[Literal['Collection']]
- id: string
  
  Id Format: uuid
- type: "Collection"
  
  Type
  
  Constant
AbstractResourceIdentifier_Literal__Endpoint___: { id: string; type: "Endpoint" }

AbstractResourceIdentifier[Literal['Endpoint']]
- id: string
  
  Id Format: uuid
- type: "Endpoint"
  
  Type
  
  Constant
AbstractResourceIdentifier_Literal__Identity___: { id: string; type: "Identity" }

AbstractResourceIdentifier[Literal['Identity']]
- id: string
  
  Id Format: uuid
- type: "Identity"
  
  Type
  
  Constant
AbstractResourceIdentifier_Literal__StreamAccessPoint___: { id: string; type: "StreamAccessPoint" }

AbstractResourceIdentifier[Literal['StreamAccessPoint']]
- id: string
  
  Id Format: uuid
- type: "StreamAccessPoint"
  
  Type
  
  Constant
BookmarkAttributes_str_: { name: string; path: string }

BookmarkAttributes[str]
- name: string
  
  Name
  
  Description
  Name of the bookmark. Unique per user.
- path: string
  
  Path
  
  Description
  Path to a directory on the collection.
BookmarkCreateRequest: {
    data: {
        attributes: { name: string; path: string };
        relationships?:
            | {
                collection: {
                    data: | { id: string; type: "Collection" }
                    | { id: string; type: "Collection" }[];
                };
            }
            | null;
        type: "Bookmark";
    };
}

BookmarkCreateRequest

Description
Top-level POST request body for bookmark creation.
- data: {
      attributes: { name: string; path: string };
      relationships?:
          | {
              collection: {
                  data: | { id: string; type: "Collection" }
                  | { id: string; type: "Collection" }[];
              };
          }
          | null;
      type: "Bookmark";
  }
  - attributes: { name: string; path: string }
    - name: string
      
      Name
      
      Description
      Name of the bookmark. Unique per user.
    - path: string
      
      Path
      
      Description
      Path to a directory on the collection.
  - Optionalrelationships?:
        | {
            collection: {
                data: | { id: string; type: "Collection" }
                | { id: string; type: "Collection" }[];
            };
        }
        | null
  - type: "Bookmark"
    
    Type
    Default
    Bookmark
    Constant
BookmarkCreateResource: {
    attributes: { name: string; path: string };
    relationships?:
        | {
            collection: {
                data: | { id: string; type: "Collection" }
                | { id: string; type: "Collection" }[];
            };
        }
        | null;
    type: "Bookmark";
}

BookmarkCreateResource

Description
Bookmark resource for POST request bodies.
- attributes: { name: string; path: string }
  - name: string
    
    Name
    
    Description
    Name of the bookmark. Unique per user.
  - path: string
    
    Path
    
    Description
    Path to a directory on the collection.
- Optionalrelationships?:
      | {
          collection: {
              data: | { id: string; type: "Collection" }
              | { id: string; type: "Collection" }[];
          };
      }
      | null
- type: "Bookmark"
  
  Type
  Default
```
Bookmark
```
  Constant
BookmarkListAttributes: { name: string; path?: string | null }

BookmarkListAttributes
- name: string
  
  Name
  
  Description
  Name of the bookmark. Unique per user.
- Optionalpath?: string | null
  
  Path
  
  Description
  Path to a directory on the collection.
BookmarkListResponse: {
    data: {
        attributes: { name: string; path?: string | null };
        id: string;
        relationships?:
            | {
                collection: {
                    data: | { id: string; type: "Collection" }
                    | { id: string; type: "Collection" }[];
                };
            }
            | null;
        type: "Bookmark";
    }[];
    included?: | {
        attributes: { display_name: string; high_assurance: boolean };
        id: string;
        relationships?: null;
        type: "Collection";
    }[]
    | null;
    links?: { next?: string | { href: string } | null }
    | null;
    meta: { request_id: string };
}

BookmarkListResponse

Description
Top-level response for a list of bookmarks.
- data: {
      attributes: { name: string; path?: string | null };
      id: string;
      relationships?:
          | {
              collection: {
                  data: | { id: string; type: "Collection" }
                  | { id: string; type: "Collection" }[];
              };
          }
          | null;
      type: "Bookmark";
  }[]
  
  Data
- Optionalincluded?:
      | {
          attributes: { display_name: string; high_assurance: boolean };
          id: string;
          relationships?: null;
          type: "Collection";
      }[]
      | null
  
  Included
- Optionallinks?: { next?: string | { href: string } | null } | null
- meta: { request_id: string }
  - request_id: string
    
    Request Id
BookmarkListResponseResource: {
    attributes: { name: string; path?: string | null };
    id: string;
    relationships?:
        | {
            collection: {
                data: | { id: string; type: "Collection" }
                | { id: string; type: "Collection" }[];
            };
        }
        | null;
    type: "Bookmark";
}

BookmarkListResponseResource

Description
Bookmark resource returned in list responses. path may be None for HA collections.
- attributes: { name: string; path?: string | null }
  - name: string
    
    Name
    
    Description
    Name of the bookmark. Unique per user.
  - Optionalpath?: string | null
    
    Path
    
    Description
    Path to a directory on the collection.
- id: string
  
  Id Format: uuid
- Optionalrelationships?:
      | {
          collection: {
              data: | { id: string; type: "Collection" }
              | { id: string; type: "Collection" }[];
          };
      }
      | null
- type: "Bookmark"
  
  Type
  Default
```
Bookmark
```
  Constant
BookmarkRelationships: {
    collection: {
        data:
            | { id: string; type: "Collection" }
            | { id: string; type: "Collection" }[];
    };
}

BookmarkRelationships

Description
Relationships for a bookmark resource.
- collection: {
      data:
          | { id: string; type: "Collection" }
          | { id: string; type: "Collection" }[];
  }
  
  Description
  Collection the bookmark is on
  - data: { id: string; type: "Collection" } | { id: string; type: "Collection" }[]
    
    Data
BookmarkResponse: {
    data: {
        attributes: { name: string; path: string };
        id: string;
        relationships?:
            | {
                collection: {
                    data: | { id: string; type: "Collection" }
                    | { id: string; type: "Collection" }[];
                };
            }
            | null;
        type: "Bookmark";
    };
    included?: | {
        attributes: { display_name: string; high_assurance: boolean };
        id: string;
        relationships?: null;
        type: "Collection";
    }[]
    | null;
    meta: { request_id: string };
}

BookmarkResponse

Description
Top-level response for a single bookmark.
- data: {
      attributes: { name: string; path: string };
      id: string;
      relationships?:
          | {
              collection: {
                  data: | { id: string; type: "Collection" }
                  | { id: string; type: "Collection" }[];
              };
          }
          | null;
      type: "Bookmark";
  }
  - attributes: { name: string; path: string }
    - name: string
      
      Name
      
      Description
      Name of the bookmark. Unique per user.
    - path: string
      
      Path
      
      Description
      Path to a directory on the collection.
  - id: string
    
    Id Format: uuid
  - Optionalrelationships?:
        | {
            collection: {
                data: | { id: string; type: "Collection" }
                | { id: string; type: "Collection" }[];
            };
        }
        | null
  - type: "Bookmark"
    
    Type
    Default
    Bookmark
    Constant
- Optionalincluded?:
      | {
          attributes: { display_name: string; high_assurance: boolean };
          id: string;
          relationships?: null;
          type: "Collection";
      }[]
      | null
  
  Included
- meta: { request_id: string }
  - request_id: string
    
    Request Id
BookmarkResponseResource: {
    attributes: { name: string; path: string };
    id: string;
    relationships?:
        | {
            collection: {
                data: | { id: string; type: "Collection" }
                | { id: string; type: "Collection" }[];
            };
        }
        | null;
    type: "Bookmark";
}

BookmarkResponseResource

Description
Bookmark resource returned in single-resource responses.
- attributes: { name: string; path: string }
  - name: string
    
    Name
    
    Description
    Name of the bookmark. Unique per user.
  - path: string
    
    Path
    
    Description
    Path to a directory on the collection.
- id: string
  
  Id Format: uuid
- Optionalrelationships?:
      | {
          collection: {
              data: | { id: string; type: "Collection" }
              | { id: string; type: "Collection" }[];
          };
      }
      | null
- type: "Bookmark"
  
  Type
  Default
```
Bookmark
```
  Constant
BookmarkUpdateAttributes: { name?: string | null; path?: string | null }

BookmarkUpdateAttributes
- Optionalname?: string | null
  
  Name
  
  Description
  Name of the bookmark. Unique per user.
- Optionalpath?: string | null
  
  Path
  
  Description
  Path to a directory on the collection.
BookmarkUpdateRequest: {
    data: {
        attributes: { name?: string | null; path?: string | null };
        id?: string | null;
        type: "Bookmark";
    };
}

BookmarkUpdateRequest

Description
Top-level PATCH request body for bookmark update.
- data: {
      attributes: { name?: string | null; path?: string | null };
      id?: string | null;
      type: "Bookmark";
  }
  - attributes: { name?: string | null; path?: string | null }
    - Optionalname?: string | null
      
      Name
      
      Description
      Name of the bookmark. Unique per user.
    - Optionalpath?: string | null
      
      Path
      
      Description
      Path to a directory on the collection.
  - Optionalid?: string | null
    
    Id
  - type: "Bookmark"
    
    Type
    Default
    Bookmark
    Constant
BookmarkUpdateResource: {
    attributes: { name?: string | null; path?: string | null };
    id?: string | null;
    type: "Bookmark";
}

BookmarkUpdateResource

Description
Bookmark resource for PATCH request bodies.
- attributes: { name?: string | null; path?: string | null }
  - Optionalname?: string | null
    
    Name
    
    Description
    Name of the bookmark. Unique per user.
  - Optionalpath?: string | null
    
    Path
    
    Description
    Path to a directory on the collection.
- Optionalid?: string | null
  
  Id
- type: "Bookmark"
  
  Type
  Default
```
Bookmark
```
  Constant
CollectionAttributes: { display_name: string; high_assurance: boolean }

CollectionAttributes

Description
Collection attributes. Note: only exposes fields relevant to including features.
- display_name: string
  
  Display Name
- high_assurance: boolean
  
  High Assurance
CollectionDataRelationship: {
    data:
        | { id: string; type: "Collection" }
        | { id: string; type: "Collection" }[];
}

CollectionDataRelationship

Description
Relationship to a Globus collection.
- data: { id: string; type: "Collection" } | { id: string; type: "Collection" }[]
  
  Data
CollectionResponseResource: {
    attributes: { display_name: string; high_assurance: boolean };
    id: string;
    relationships?: null;
    type: "Collection";
}

CollectionResponseResource

Description
Collection resource, used as an included resource in other feature responses.
- attributes: { display_name: string; high_assurance: boolean }
  - display_name: string
    
    Display Name
  - high_assurance: boolean
    
    High Assurance
- id: string
  
  Id Format: uuid
- Optionalrelationships?: null
  
  Relationships
- type: "Collection"
  
  Type
  
  Constant
EndpointDataRelationship: { data: { id: string; type: "Endpoint" } | { id: string; type: "Endpoint" }[] }

EndpointDataRelationship

Description
Relationship to a Globus Connect Server endpoint.
- data: { id: string; type: "Endpoint" } | { id: string; type: "Endpoint" }[]
  
  Data
HTTPValidationError: {
    detail?: {
        ctx?: Record<string, unknown>;
        input?: unknown;
        loc: (string | number)[];
        msg: string;
        type: string;
    }[];
}

HTTPValidationError
- Optionaldetail?: {
      ctx?: Record<string, unknown>;
      input?: unknown;
      loc: (string | number)[];
      msg: string;
      type: string;
  }[]
  
  Detail
IdentityDataRelationship: { data: { id: string; type: "Identity" } | { id: string; type: "Identity" }[] }

IdentityDataRelationship

Description
Relationship to a Globus Auth identity.
- data: { id: string; type: "Identity" } | { id: string; type: "Identity" }[]
  
  Data
Link: { href: string }

Link
- href: string
  
  Href
  
  Description
  URI-reference pointing to link target
MetaDocument: { meta: { request_id: string } }

MetaDocument

Description
Top-level JSONAPI response with no data, only meta.
- meta: { request_id: string }
  - request_id: string
    
    Request Id
PaginationLinks: { next?: string | { href: string } | null }

PaginationLinks
- Optionalnext?: string | { href: string } | null
  
  Next
StreamAccessPointAttributes: {
    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;
}

StreamAccessPointAttributes

Description
Attributes for SAP create and response.
- Optionaladvertised_owner?: string | null
  
  Advertised Owner
  
  Description
  Globus Auth username for the advertised owner identity
- Optionalcontact_email?: string | null
  
  Contact Email
  
  Description
  Stream access point support contact email address
- Optionalcontact_info?: string | null
  
  Contact Info
  
  Description
  Other non-email contact information for the stream access point, e.g. phone and mailing address
- Optionaldepartment?: string | null
  
  Department
  
  Description
  Department which operates the stream access point
- Optionaldescription?: string | null
  
  Description
  
  Description
  Description of the stream access point
- display_name: string
  
  Display Name
  
  Description
  Friendly name to show in stream access point listings
- Optionalinfo_link?: string | null
  
  Info Link
  
  Description
  Link to a web page about the stream access point
- Optionalkeywords?: string | null
  
  Keywords
  
  Description
  Comma-separated list of keywords for searching
- Optionalorganization?: string | null
  
  Organization
  
  Description
  Organization which operates the stream access point
- tlsftp_server: string
  
  Tlsftp Server
  
  Description
  URL for the tlsftp server used for tunnel access; must begin with tlsftp and end with a port number
StreamAccessPointDataRelationship: {
    data:
        | { id: string; type: "StreamAccessPoint" }
        | { id: string; type: "StreamAccessPoint" }[];
}

StreamAccessPointDataRelationship

Description
Relationship to a stream access point.
- data:
  | { id: string; type: "StreamAccessPoint" }
  | { id: string; type: "StreamAccessPoint" }[]
  
  Data
StreamAccessPointListResponse: {
    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: string; type: "Endpoint" }
                | { id: string; type: "Endpoint" }[];
            };
        }
        | null;
        type: "StreamAccessPoint";
    }[];
    links?: { next?: string | { href: string } | null }
    | null;
    meta: { request_id: string };
}

StreamAccessPointListResponse

Description
Top-level response for a list of stream access points.
- 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: string; type: "Endpoint" }
              | { id: string; type: "Endpoint" }[];
          };
      }
      | null;
      type: "StreamAccessPoint";
  }[]
  
  Data
- Optionallinks?: { next?: string | { href: string } | null } | null
- meta: { request_id: string }
  - request_id: string
    
    Request Id
StreamAccessPointResponse: {
    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: string; type: "Endpoint" }
                | { id: string; type: "Endpoint" }[];
            };
        }
        | null;
        type: "StreamAccessPoint";
    };
    meta: { request_id: string };
}

StreamAccessPointResponse

Description
Top-level response for a single stream access point.
- 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: string; type: "Endpoint" }
              | { id: string; type: "Endpoint" }[];
          };
      }
      | null;
      type: "StreamAccessPoint";
  }
  - 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;
    }
    - Optionaladvertised_owner?: string | null
      
      Advertised Owner
      
      Description
      Globus Auth username for the advertised owner identity
    - Optionalcontact_email?: string | null
      
      Contact Email
      
      Description
      Stream access point support contact email address
    - Optionalcontact_info?: string | null
      
      Contact Info
      
      Description
      Other non-email contact information for the stream access point, e.g. phone and mailing address
    - Optionaldepartment?: string | null
      
      Department
      
      Description
      Department which operates the stream access point
    - Optionaldescription?: string | null
      
      Description
      
      Description
      Description of the stream access point
    - display_name: string
      
      Display Name
      
      Description
      Friendly name to show in stream access point listings
    - Optionalinfo_link?: string | null
      
      Info Link
      
      Description
      Link to a web page about the stream access point
    - Optionalkeywords?: string | null
      
      Keywords
      
      Description
      Comma-separated list of keywords for searching
    - Optionalorganization?: string | null
      
      Organization
      
      Description
      Organization which operates the stream access point
    - tlsftp_server: string
      
      Tlsftp Server
      
      Description
      URL for the tlsftp server used for tunnel access; must begin with tlsftp and end with a port number
  - id: string
    
    Id Format: uuid
  - Optionalrelationships?:
        | {
            host_endpoint: {
                data: | { id: string; type: "Endpoint" }
                | { id: string; type: "Endpoint" }[];
            };
        }
        | null
  - type: "StreamAccessPoint"
    
    Type
    Default
    StreamAccessPoint
    Constant
- meta: { request_id: string }
  - request_id: string
    
    Request Id
StreamAccessPointResponseRelationships: {
    host_endpoint: {
        data:
            | { id: string; type: "Endpoint" }
            | { id: string; type: "Endpoint" }[];
    };
}

StreamAccessPointResponseRelationships

Description
Relationships returned on a stream access point response.
- host_endpoint: { data: { id: string; type: "Endpoint" } | { id: string; type: "Endpoint" }[] }
  
  Description
  Globus Connect Server endpoint that hosts the stream access point
  - data: { id: string; type: "Endpoint" } | { id: string; type: "Endpoint" }[]
    
    Data
StreamAccessPointResponseResource: {
    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: string; type: "Endpoint" }
            | { id: string; type: "Endpoint" }[];
        };
    }
    | null;
    type: "StreamAccessPoint";
}

StreamAccessPointResponseResource

Description
SAP resource returned in responses.
- 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;
  }
  - Optionaladvertised_owner?: string | null
    
    Advertised Owner
    
    Description
    Globus Auth username for the advertised owner identity
  - Optionalcontact_email?: string | null
    
    Contact Email
    
    Description
    Stream access point support contact email address
  - Optionalcontact_info?: string | null
    
    Contact Info
    
    Description
    Other non-email contact information for the stream access point, e.g. phone and mailing address
  - Optionaldepartment?: string | null
    
    Department
    
    Description
    Department which operates the stream access point
  - Optionaldescription?: string | null
    
    Description
    
    Description
    Description of the stream access point
  - display_name: string
    
    Display Name
    
    Description
    Friendly name to show in stream access point listings
  - Optionalinfo_link?: string | null
    
    Info Link
    
    Description
    Link to a web page about the stream access point
  - Optionalkeywords?: string | null
    
    Keywords
    
    Description
    Comma-separated list of keywords for searching
  - Optionalorganization?: string | null
    
    Organization
    
    Description
    Organization which operates the stream access point
  - tlsftp_server: string
    
    Tlsftp Server
    
    Description
    URL for the tlsftp server used for tunnel access; must begin with tlsftp and end with a port number
- id: string
  
  Id Format: uuid
- Optionalrelationships?:
      | {
          host_endpoint: {
              data: | { id: string; type: "Endpoint" }
              | { id: string; type: "Endpoint" }[];
          };
      }
      | null
- type: "StreamAccessPoint"
  
  Type
  Default
```
StreamAccessPoint
```
  Constant
TopLevelMeta: { request_id: string }

TopLevelMeta
- request_id: string
  
  Request Id
TunnelCreateRequest: {
    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" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            listener: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
        }
        | null;
        type: "Tunnel";
    };
}

TunnelCreateRequest

Description
Top-level POST request body for tunnel creation.
- 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" }
              | { id: string; type: "StreamAccessPoint" }[];
          };
          listener: {
              data: | { id: string; type: "StreamAccessPoint" }
              | { id: string; type: "StreamAccessPoint" }[];
          };
      }
      | null;
      type: "Tunnel";
  }
  - attributes: {
        label?: string | null;
        lifetime_mins: number;
        listener_ip_address?: string | null;
        listener_port?: number | null;
        restartable: boolean;
        submission_id: string;
    }
    - Optionallabel?: string | null
      
      Label
      
      Description
      Updatable friendly identifier for the tunnel
    - lifetime_mins: number
      
      Lifetime Mins
      Description
      Number of minutes the tunnel will exist once created
      
      Default
      360
    - Optionallistener_ip_address?: string | null
      
      Listener Ip Address
      
      Description
      IP address of listening LAN contact
    - Optionallistener_port?: number | null
      
      Listener Port
      
      Description
      Port number of listening LAN contact
    - restartable: boolean
      
      Restartable
      Description
      Restart tunnel on failure
      
      Default
      false
    - submission_id: string
      
      Submission Id Format: uuid
      
      Description
      Client-generated UUID for tunnel creation request; use same value on retry to prevent duplicate requests
  - Optionalrelationships?:
        | {
            initiator: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            listener: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
        }
        | null
  - type: "Tunnel"
    
    Type
    
    Constant
TunnelCreateResource: {
    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" }
            | { id: string; type: "StreamAccessPoint" }[];
        };
        listener: {
            data: | { id: string; type: "StreamAccessPoint" }
            | { id: string; type: "StreamAccessPoint" }[];
        };
    }
    | null;
    type: "Tunnel";
}

TunnelCreateResource

Description
Tunnel resource for POST request bodies.
- attributes: {
      label?: string | null;
      lifetime_mins: number;
      listener_ip_address?: string | null;
      listener_port?: number | null;
      restartable: boolean;
      submission_id: string;
  }
  - Optionallabel?: string | null
    
    Label
    
    Description
    Updatable friendly identifier for the tunnel
  - lifetime_mins: number
    
    Lifetime Mins
    Description
    Number of minutes the tunnel will exist once created
    Default
    360
  - Optionallistener_ip_address?: string | null
    
    Listener Ip Address
    
    Description
    IP address of listening LAN contact
  - Optionallistener_port?: number | null
    
    Listener Port
    
    Description
    Port number of listening LAN contact
  - restartable: boolean
    
    Restartable
    Description
    Restart tunnel on failure
    Default
    false
  - submission_id: string
    
    Submission Id Format: uuid
    
    Description
    Client-generated UUID for tunnel creation request; use same value on retry to prevent duplicate requests
- Optionalrelationships?:
      | {
          initiator: {
              data: | { id: string; type: "StreamAccessPoint" }
              | { id: string; type: "StreamAccessPoint" }[];
          };
          listener: {
              data: | { id: string; type: "StreamAccessPoint" }
              | { id: string; type: "StreamAccessPoint" }[];
          };
      }
      | null
- type: "Tunnel"
  
  Type
  
  Constant
TunnelEventAttributes: {
    code: string;
    description: string;
    details: string;
    is_error: boolean;
    time: string;
}

TunnelEventAttributes
- code: string
  
  Code
  
  Description
  Code categorizing the type of event
- description: string
  
  Description
  
  Description
  Friendly description of event
- details: string
  
  Details
  
  Description
  More extensive information about the event
- is_error: boolean
  
  Is Error
  
  Description
  Whether the event is an occurrence of an error
- time: string
  
  Time Format: date-time
  
  Description
  When the event occurred
TunnelEventListResponse: {
    data: {
        attributes: {
            code: string;
            description: string;
            details: string;
            is_error: boolean;
            time: string;
        };
        id: number;
        relationships?: null;
        type: "TunnelEvent";
    }[];
    links?: { next?: string | { href: string } | null }
    | null;
    meta: { request_id: string };
}

TunnelEventListResponse

Description
Top-level response for a list of tunnel events.
- data: {
      attributes: {
          code: string;
          description: string;
          details: string;
          is_error: boolean;
          time: string;
      };
      id: number;
      relationships?: null;
      type: "TunnelEvent";
  }[]
  
  Data
- Optionallinks?: { next?: string | { href: string } | null } | null
- meta: { request_id: string }
  - request_id: string
    
    Request Id
TunnelEventResponseResource: {
    attributes: {
        code: string;
        description: string;
        details: string;
        is_error: boolean;
        time: string;
    };
    id: number;
    relationships?: null;
    type: "TunnelEvent";
}

TunnelEventResponseResource

Description
Tunnel event resource returned in responses.
- attributes: {
      code: string;
      description: string;
      details: string;
      is_error: boolean;
      time: string;
  }
  - code: string
    
    Code
    
    Description
    Code categorizing the type of event
  - description: string
    
    Description
    
    Description
    Friendly description of event
  - details: string
    
    Details
    
    Description
    More extensive information about the event
  - is_error: boolean
    
    Is Error
    
    Description
    Whether the event is an occurrence of an error
  - time: string
    
    Time Format: date-time
    
    Description
    When the event occurred
- id: number
  
  Id
  
  Description
  Unique identifier of the event
- Optionalrelationships?: null
  
  Relationships
- type: "TunnelEvent"
  
  Type
  
  Constant
TunnelListResponse: {
    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: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            listener: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            owner: {
                data: | { id: string; type: "Identity" }
                | { id: string; type: "Identity" }[];
            };
        }
        | null;
        type: "Tunnel";
    }[];
    links?: { next?: string | { href: string } | null }
    | null;
    meta: { request_id: string };
}

TunnelListResponse

Description
Top-level response for a list of tunnels.
- 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: string; type: "StreamAccessPoint" }
              | { id: string; type: "StreamAccessPoint" }[];
          };
          listener: {
              data: | { id: string; type: "StreamAccessPoint" }
              | { id: string; type: "StreamAccessPoint" }[];
          };
          owner: {
              data: | { id: string; type: "Identity" }
              | { id: string; type: "Identity" }[];
          };
      }
      | null;
      type: "Tunnel";
  }[]
  
  Data
- Optionallinks?: { next?: string | { href: string } | null } | null
- meta: { request_id: string }
  - request_id: string
    
    Request Id
TunnelPatchAttributes: {
    label?: string | null;
    listener_ip_address?: string | null;
    listener_port?: number | null;
    state?: "STOPPING" | null;
}

TunnelPatchAttributes

Description
Attributes settable on a tunnel patch.
- Optionallabel?: string | null
  
  Label
  
  Description
  Updatable friendly identifier for the tunnel
- Optionallistener_ip_address?: string | null
  
  Listener Ip Address
  
  Description
  IP address of listening LAN contact
- Optionallistener_port?: number | null
  
  Listener Port
  
  Description
  Port number of listening LAN contact
- Optionalstate?: "STOPPING" | null
  
  State
  
  Description
  Short description of tunnel state
TunnelPatchResource: {
    attributes: {
        label?: string | null;
        listener_ip_address?: string | null;
        listener_port?: number | null;
        state?: "STOPPING" | null;
    };
    id?: string
    | null;
    type?: "Tunnel" | null;
}

TunnelPatchResource

Description
Tunnel resource for PATCH request bodies.
- attributes: {
      label?: string | null;
      listener_ip_address?: string | null;
      listener_port?: number | null;
      state?: "STOPPING" | null;
  }
  - Optionallabel?: string | null
    
    Label
    
    Description
    Updatable friendly identifier for the tunnel
  - Optionallistener_ip_address?: string | null
    
    Listener Ip Address
    
    Description
    IP address of listening LAN contact
  - Optionallistener_port?: number | null
    
    Listener Port
    
    Description
    Port number of listening LAN contact
  - Optionalstate?: "STOPPING" | null
    
    State
    
    Description
    Short description of tunnel state
- Optionalid?: string | null
  
  Id
- Optionaltype?: "Tunnel" | null
  
  Type
TunnelRequestAttributes: {
    label?: string | null;
    lifetime_mins: number;
    listener_ip_address?: string | null;
    listener_port?: number | null;
    restartable: boolean;
    submission_id: string;
}

TunnelRequestAttributes

Description
Attributes for tunnel creation.
- Optionallabel?: string | null
  
  Label
  
  Description
  Updatable friendly identifier for the tunnel
- lifetime_mins: number
  
  Lifetime Mins
  Description
  Number of minutes the tunnel will exist once created
  Default
```
360
```
- Optionallistener_ip_address?: string | null
  
  Listener Ip Address
  
  Description
  IP address of listening LAN contact
- Optionallistener_port?: number | null
  
  Listener Port
  
  Description
  Port number of listening LAN contact
- restartable: boolean
  
  Restartable
  Description
  Restart tunnel on failure
  Default
```
false
```
- submission_id: string
  
  Submission Id Format: uuid
  
  Description
  Client-generated UUID for tunnel creation request; use same value on retry to prevent duplicate requests
TunnelRequestRelationships: {
    initiator: {
        data:
            | { id: string; type: "StreamAccessPoint" }
            | { id: string; type: "StreamAccessPoint" }[];
    };
    listener: {
        data: | { id: string; type: "StreamAccessPoint" }
        | { id: string; type: "StreamAccessPoint" }[];
    };
}

TunnelRequestRelationships

Description
Relationships settable on tunnel creation.
- initiator: {
      data:
          | { id: string; type: "StreamAccessPoint" }
          | { id: string; type: "StreamAccessPoint" }[];
  }
  
  Description
  Stream access point for initiator application
  - data:
    | { id: string; type: "StreamAccessPoint" }
    | { id: string; type: "StreamAccessPoint" }[]
    
    Data
- listener: {
      data:
          | { id: string; type: "StreamAccessPoint" }
          | { id: string; type: "StreamAccessPoint" }[];
  }
  
  Description
  Stream access point for listener application
  - data:
    | { id: string; type: "StreamAccessPoint" }
    | { id: string; type: "StreamAccessPoint" }[]
    
    Data
TunnelResponse: {
    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: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            listener: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            owner: {
                data: | { id: string; type: "Identity" }
                | { id: string; type: "Identity" }[];
            };
        }
        | null;
        type: "Tunnel";
    };
    meta: { request_id: string };
}

TunnelResponse

Description
Top-level response for a single tunnel.
- 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: string; type: "StreamAccessPoint" }
              | { id: string; type: "StreamAccessPoint" }[];
          };
          listener: {
              data: | { id: string; type: "StreamAccessPoint" }
              | { id: string; type: "StreamAccessPoint" }[];
          };
          owner: {
              data: | { id: string; type: "Identity" }
              | { id: string; type: "Identity" }[];
          };
      }
      | null;
      type: "Tunnel";
  }
  - 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;
    }
    - created_time: string
      
      Created Time Format: date-time
      
      Description
      Date and time when the tunnel was created
    - Optionalinitiator_ip_address?: string | null
      
      Initiator Ip Address
      
      Description
      IP address of initiating LAN contact
    - Optionalinitiator_port?: number | null
      
      Initiator Port
      
      Description
      Port number of initiating LAN contact
    - Optionallabel?: string | null
      
      Label
      
      Description
      Updatable friendly identifier for the tunnel
    - lifetime_mins: number
      
      Lifetime Mins
      Description
      Number of minutes the tunnel will exist once created
      
      Default
      360
    - Optionallistener_ip_address?: string | null
      
      Listener Ip Address
      
      Description
      IP address of listening LAN contact
    - Optionallistener_port?: number | null
      
      Listener Port
      
      Description
      Port number of listening LAN contact
    - restartable: boolean
      
      Restartable
      Description
      Restart tunnel on failure
      
      Default
      false
    - state: string
      
      State
      Description
      Short description of tunnel state
      
      Default
      UNINITIALIZED
    - Readonlystatus: string
      
      Status
    - submission_id: string
      
      Submission Id Format: uuid
      
      Description
      Client-generated UUID for tunnel creation request; use same value on retry to prevent duplicate requests
  - id: string
    
    Id Format: uuid
  - Optionalrelationships?:
        | {
            initiator: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            listener: {
                data: | { id: string; type: "StreamAccessPoint" }
                | { id: string; type: "StreamAccessPoint" }[];
            };
            owner: {
                data: | { id: string; type: "Identity" }
                | { id: string; type: "Identity" }[];
            };
        }
        | null
  - type: "Tunnel"
    
    Type
    Default
    Tunnel
    Constant
- meta: { request_id: string }
  - request_id: string
    
    Request Id
TunnelResponseAttributes: {
    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;
}

TunnelResponseAttributes

Description
Attributes returned in tunnel responses. Includes all request fields.
- created_time: string
  
  Created Time Format: date-time
  
  Description
  Date and time when the tunnel was created
- Optionalinitiator_ip_address?: string | null
  
  Initiator Ip Address
  
  Description
  IP address of initiating LAN contact
- Optionalinitiator_port?: number | null
  
  Initiator Port
  
  Description
  Port number of initiating LAN contact
- Optionallabel?: string | null
  
  Label
  
  Description
  Updatable friendly identifier for the tunnel
- lifetime_mins: number
  
  Lifetime Mins
  Description
  Number of minutes the tunnel will exist once created
  Default
```
360
```
- Optionallistener_ip_address?: string | null
  
  Listener Ip Address
  
  Description
  IP address of listening LAN contact
- Optionallistener_port?: number | null
  
  Listener Port
  
  Description
  Port number of listening LAN contact
- restartable: boolean
  
  Restartable
  Description
  Restart tunnel on failure
  Default
```
false
```
- state: string
  
  State
  Description
  Short description of tunnel state
  Default
```
UNINITIALIZED
```
- Readonlystatus: string
  
  Status
- submission_id: string
  
  Submission Id Format: uuid
  
  Description
  Client-generated UUID for tunnel creation request; use same value on retry to prevent duplicate requests
TunnelResponseRelationships: {
    initiator: {
        data:
            | { id: string; type: "StreamAccessPoint" }
            | { id: string; type: "StreamAccessPoint" }[];
    };
    listener: {
        data: | { id: string; type: "StreamAccessPoint" }
        | { id: string; type: "StreamAccessPoint" }[];
    };
    owner: {
        data: | { id: string; type: "Identity" }
        | { id: string; type: "Identity" }[];
    };
}

TunnelResponseRelationships

Description
Relationships returned on a tunnel response.
- initiator: {
      data:
          | { id: string; type: "StreamAccessPoint" }
          | { id: string; type: "StreamAccessPoint" }[];
  }
  
  Description
  Stream access point for initiator application
  - data:
    | { id: string; type: "StreamAccessPoint" }
    | { id: string; type: "StreamAccessPoint" }[]
    
    Data
- listener: {
      data:
          | { id: string; type: "StreamAccessPoint" }
          | { id: string; type: "StreamAccessPoint" }[];
  }
  
  Description
  Stream access point for listener application
  - data:
    | { id: string; type: "StreamAccessPoint" }
    | { id: string; type: "StreamAccessPoint" }[]
    
    Data
- owner: { data: { id: string; type: "Identity" } | { id: string; type: "Identity" }[] }
  
  Description
  Globus Auth identity that created the tunnel
  - data: { id: string; type: "Identity" } | { id: string; type: "Identity" }[]
    
    Data
TunnelResponseResource: {
    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: string; type: "StreamAccessPoint" }
            | { id: string; type: "StreamAccessPoint" }[];
        };
        listener: {
            data: | { id: string; type: "StreamAccessPoint" }
            | { id: string; type: "StreamAccessPoint" }[];
        };
        owner: {
            data: | { id: string; type: "Identity" }
            | { id: string; type: "Identity" }[];
        };
    }
    | null;
    type: "Tunnel";
}

TunnelResponseResource

Description
Tunnel resource returned in responses.
- 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;
  }
  - created_time: string
    
    Created Time Format: date-time
    
    Description
    Date and time when the tunnel was created
  - Optionalinitiator_ip_address?: string | null
    
    Initiator Ip Address
    
    Description
    IP address of initiating LAN contact
  - Optionalinitiator_port?: number | null
    
    Initiator Port
    
    Description
    Port number of initiating LAN contact
  - Optionallabel?: string | null
    
    Label
    
    Description
    Updatable friendly identifier for the tunnel
  - lifetime_mins: number
    
    Lifetime Mins
    Description
    Number of minutes the tunnel will exist once created
    Default
    360
  - Optionallistener_ip_address?: string | null
    
    Listener Ip Address
    
    Description
    IP address of listening LAN contact
  - Optionallistener_port?: number | null
    
    Listener Port
    
    Description
    Port number of listening LAN contact
  - restartable: boolean
    
    Restartable
    Description
    Restart tunnel on failure
    Default
    false
  - state: string
    
    State
    Description
    Short description of tunnel state
    Default
    UNINITIALIZED
  - Readonlystatus: string
    
    Status
  - submission_id: string
    
    Submission Id Format: uuid
    
    Description
    Client-generated UUID for tunnel creation request; use same value on retry to prevent duplicate requests
- id: string
  
  Id Format: uuid
- Optionalrelationships?:
      | {
          initiator: {
              data: | { id: string; type: "StreamAccessPoint" }
              | { id: string; type: "StreamAccessPoint" }[];
          };
          listener: {
              data: | { id: string; type: "StreamAccessPoint" }
              | { id: string; type: "StreamAccessPoint" }[];
          };
          owner: {
              data: | { id: string; type: "Identity" }
              | { id: string; type: "Identity" }[];
          };
      }
      | null
- type: "Tunnel"
  
  Type
  Default
```
Tunnel
```
  Constant
TunnelUpdateRequest: {
    data: {
        attributes: {
            label?: string | null;
            listener_ip_address?: string | null;
            listener_port?: number | null;
            state?: "STOPPING" | null;
        };
        id?: string
        | null;
        type?: "Tunnel" | null;
    };
}

TunnelUpdateRequest

Description
Top-level PATCH request body for tunnel update.
- data: {
      attributes: {
          label?: string | null;
          listener_ip_address?: string | null;
          listener_port?: number | null;
          state?: "STOPPING" | null;
      };
      id?: string
      | null;
      type?: "Tunnel" | null;
  }
  - attributes: {
        label?: string | null;
        listener_ip_address?: string | null;
        listener_port?: number | null;
        state?: "STOPPING" | null;
    }
    - Optionallabel?: string | null
      
      Label
      
      Description
      Updatable friendly identifier for the tunnel
    - Optionallistener_ip_address?: string | null
      
      Listener Ip Address
      
      Description
      IP address of listening LAN contact
    - Optionallistener_port?: number | null
      
      Listener Port
      
      Description
      Port number of listening LAN contact
    - Optionalstate?: "STOPPING" | null
      
      State
      
      Description
      Short description of tunnel state
  - Optionalid?: string | null
    
    Id
  - Optionaltype?: "Tunnel" | null
    
    Type
ValidationError: {
    ctx?: Record<string, unknown>;
    input?: unknown;
    loc: (string | number)[];
    msg: string;
    type: string;
}

ValidationError
- Optionalctx?: Record<string, unknown>
  
  Context
- Optionalinput?: unknown
  
  Input
- loc: (string | number)[]
  
  Location
- msg: string
  
  Message
- type: string
  
  Error Type

Interface components

Index

Properties

Properties

headers

parameters

pathItems

requestBodies

responses

schemas

Type Declaration

AbstractResourceIdentifier_Literal__Collection___: { id: string; type: "Collection" }

id: string

type: "Collection"

Constant

AbstractResourceIdentifier_Literal__Endpoint___: { id: string; type: "Endpoint" }

id: string

type: "Endpoint"

Constant

AbstractResourceIdentifier_Literal__Identity___: { id: string; type: "Identity" }

id: string

type: "Identity"

Constant

AbstractResourceIdentifier_Literal__StreamAccessPoint___: { id: string; type: "StreamAccessPoint" }

id: string

type: "StreamAccessPoint"

Constant

BookmarkAttributes_str_: { name: string; path: string }

name: string

Description

path: string

Description

BookmarkCreateRequest: { data: { attributes: { name: string; path: string }; relationships?: | { collection: { data: | { id: string; type: "Collection" } | { id: string; type: "Collection" }[]; }; } | null; type: "Bookmark"; };}

Description

data: { attributes: { name: string; path: string }; relationships?: | { collection: { data: | { id: string; type: "Collection" } | { id: string; type: "Collection" }[]; }; } | null; type: "Bookmark";}

attributes: { name: string; path: string }

name: string

Description

path: string

Description

Optionalrelationships?: | { collection: { data: | { id: string; type: "Collection" } | { id: string; type: "Collection" }[]; }; } | null

type: "Bookmark"

Default

Constant

BookmarkCreateResource: { attributes: { name: string; path: string }; relationships?: | { collection: { data: | { id: string; type: "Collection" } | { id: string; type: "Collection" }[]; }; } | null; type: "Bookmark";}

Description

attributes: { name: string; path: string }

name: string

Description

path: string

Description

Optionalrelationships?: | { collection: { data: | { id: string; type: "Collection" } | { id: string; type: "Collection" }[]; }; } | null

type: "Bookmark"

Default

Constant

BookmarkListAttributes: { name: string; path?: string | null }

name: string

Description

Optionalpath?: string | null

Description

Description

data: { attributes: { name: string; path?: string | null }; id: string; relationships?: | { collection: { data: | { id: string; type: "Collection" } | { id: string; type: "Collection" }[]; }; } | null; type: "Bookmark";}[]

Optionalincluded?: | { attributes: { display_name: string; high_assurance: boolean }; id: string; relationships?: null; type: "Collection"; }[] | null

Optionallinks?: { next?: string | { href: string } | null } | null

meta: { request_id: string }

request_id: string

BookmarkListResponseResource: { attributes: { name: string; path?: string | null }; id: string; relationships?: | { collection: { data: | { id: string; type: "Collection" } | { id: string; type: "Collection" }[]; }; } | null; type: "Bookmark";}

Description

attributes: { name: string; path?: string | null }

name: string

Description

Optionalpath?: string | null

Description

id: string

Optionalrelationships?: | { collection: { data: | { id: string; type: "Collection" } | { id: string; type: "Collection" }[]; }; } | null

type: "Bookmark"

Default

Constant

BookmarkRelationships: { collection: { data: | { id: string; type: "Collection" } | { id: string; type: "Collection" }[]; };}

Description

AbstractResourceIdentifier_LiteralCollection_: { id: string; type: "Collection" }

AbstractResourceIdentifier_LiteralEndpoint_: { id: string; type: "Endpoint" }

AbstractResourceIdentifier_LiteralIdentity_: { id: string; type: "Identity" }

AbstractResourceIdentifier_LiteralStreamAccessPoint_: { id: string; type: "StreamAccessPoint" }

BookmarkCreateRequest: {
data: {
attributes: { name: string; path: string };
relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null;
type: "Bookmark";
};
}

data: {
attributes: { name: string; path: string };
relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null;
type: "Bookmark";
}

`Optional`relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null

BookmarkCreateResource: {
attributes: { name: string; path: string };
relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null;
type: "Bookmark";
}

`Optional`relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null

`Optional`path?: string | null

data: {
attributes: { name: string; path?: string | null };
id: string;
relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null;
type: "Bookmark";
}[]

`Optional`included?:
| {
attributes: { display_name: string; high_assurance: boolean };
id: string;
relationships?: null;
type: "Collection";
}[]
| null

`Optional`links?: { next?: string | { href: string } | null } | null

BookmarkListResponseResource: {
attributes: { name: string; path?: string | null };
id: string;
relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null;
type: "Bookmark";
}

`Optional`path?: string | null

`Optional`relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null

BookmarkRelationships: {
collection: {
data:
| { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}

collection: {
data:
| { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
}

data: {
attributes: { name: string; path: string };
id: string;
relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null;
type: "Bookmark";
}

`Optional`relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null

`Optional`included?:
| {
attributes: { display_name: string; high_assurance: boolean };
id: string;
relationships?: null;
type: "Collection";
}[]
| null

BookmarkResponseResource: {
attributes: { name: string; path: string };
id: string;
relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null;
type: "Bookmark";
}

`Optional`relationships?:
| {
collection: {
data: | { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
};
}
| null

`Optional`name?: string | null

`Optional`path?: string | null

BookmarkUpdateRequest: {
data: {
attributes: { name?: string | null; path?: string | null };
id?: string | null;
type: "Bookmark";
};
}

data: {
attributes: { name?: string | null; path?: string | null };
id?: string | null;
type: "Bookmark";
}

`Optional`name?: string | null

`Optional`path?: string | null

`Optional`id?: string | null

BookmarkUpdateResource: {
attributes: { name?: string | null; path?: string | null };
id?: string | null;
type: "Bookmark";
}

`Optional`name?: string | null

`Optional`path?: string | null

`Optional`id?: string | null

CollectionDataRelationship: {
data:
| { id: string; type: "Collection" }
| { id: string; type: "Collection" }[];
}

CollectionResponseResource: {
attributes: { display_name: string; high_assurance: boolean };
id: string;
relationships?: null;
type: "Collection";
}